Proyectos
Actualizar un proyecto
Cambia la ficha de un proyecto: nombre, fechas, cliente, tipo, referencia externa, ubicación y color (envía solo los campos que cambian).
projects:writeprojects:write- 120/min
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
NO cambia el estado, el archivado ni los pedidos vinculados: los vínculos tienen su propio subrecurso. Un proyecto archivado es de solo lectura: la petición se rechaza con 409 conflict y no se escribe nada; desarchívalo antes con PUT /api y archived: false. El cliente y el tipo de proyecto se comprueban contra la cuenta de la clave de API antes de escribir nada. Devuelve el proyecto completo, con la misma proyección que su GET.
Argumentos
Identificador del proyecto.
Límites: longitud mín. 1
Nombre del proyecto. Al menos tres caracteres, como exige el dominio.
Límites: longitud mín. 3, longitud máx. 200
Inicio del proyecto (ISO 8601 con desplazamiento).
Fin del proyecto (ISO 8601 con desplazamiento). No puede ser anterior a startDate; el mismo instante es un proyecto de un día.
Cliente del proyecto. Debe pertenecer a la cuenta de la clave de API.
Límites: longitud mín. 1, longitud máx. 100
Tipo de proyecto; resuélvelo contra /api. null lo borra.
Límites: longitud mín. 1, longitud máx. 100
Referencia de formato libre para cruzar el proyecto con un sistema externo; null la borra.
Límites: longitud máx. 200
Ubicación física del proyecto (un plató, la sede de un cliente). Solo se registran los campos enviados.
Mostrar atributos hijosOcultar atributos hijos
Nombre del lugar, por ejemplo "Main stage".
Límites: longitud máx. 200
Dirección postal.
Límites: longitud máx. 500
Ciudad.
Límites: longitud máx. 200
Código postal.
Límites: longitud máx. 20
Provincia o región.
Límites: longitud máx. 200
País.
Límites: longitud máx. 200
Latitud en grados decimales.
Límites: mín. -90, máx. 90
Longitud en grados decimales.
Límites: mín. -180, máx. 180
Color de la tarjeta del proyecto (por ejemplo "#3b82f6"); null lo borra.
Límites: longitud máx. 40
Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.
Límites: longitud mín. 1, longitud máx. 255
Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.
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 PATCH /api/v1/projects/{projectId}.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasProyectos
Actualizar un proyecto
Cambia la ficha de un proyecto: nombre, fechas, cliente, tipo, referencia externa, ubicación y color (envía solo los campos que cambian).
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?