Proyectos
Obtener un proyecto
Devuelve el detalle de un proyecto por su identificador.
projects:readprojects:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Argumentos
Identificador del proyecto.
Límites: longitud mín. 1
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único del proyecto.
Número de proyecto legible; null si no está numerado.
Nombre del proyecto.
Color asociado al proyecto (para la interfaz); null si no tiene.
Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.
Identificador del tipo de proyecto; null si el proyecto no tiene tipo.
Referencia compacta al tipo de proyecto; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del tipo de proyecto.
Nombre del tipo de proyecto.
Color asociado al tipo de proyecto (para la interfaz); null si no tiene.
Referencia compacta al contacto del proyecto; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contacto.
Nombre del contacto.
Ubicación del proyecto; sus campos internos son null cuando no se han registrado.
Mostrar atributos hijosOcultar atributos hijos
Nombre del lugar o ubicación; null si no está registrado.
Dirección de la ubicación; null si no consta.
Ciudad de la ubicación; null si no consta.
Código postal de la ubicación; null si no se ha registrado.
Provincia o región de la ubicación; null si no se ha registrado.
País de la ubicación; null si no consta.
Latitud de la ubicación; null si no está registrada.
Longitud de la ubicación; null si no está registrada.
Fecha de inicio del proyecto en ISO 8601 con desplazamiento.
Fecha de fin del proyecto en ISO 8601 con desplazamiento.
Estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived. archived es un estado HEREDADO que aparece en datos antiguos; el estado archivado actual se expresa mediante el booleano archived de este mismo DTO.
Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived
Si el proyecto está archivado.
Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api?projectId=.
Número total de pedidos del proyecto (igual a orderIds.length).
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Origen desde el que se creó el proyecto; null si no consta.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/projects/{projectId}.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasProyectos
Obtener un proyecto
Devuelve el detalle de un proyecto por su identificador.
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?