Proyectos
Vincular un pedido a un proyecto
Cuelga el pedido del proyecto.
Ejemplos de petición
curl https://app.filmo.io/api/v1/projects/proj_8f2a1c/orders/orde_8f2a1c \
--request POST \
--header "Authorization: Bearer $FILMO_API_KEY" \
--header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)"Generado a partir del esquema
No lleva cuerpo. Es idempotente: si ya estaba vinculado, no pasa nada y la respuesta es la misma. Un proyecto archivado no admite nuevos vínculos y rechaza la petición. El pedido no cambia de cliente ni de fechas por esto. Devuelve el proyecto completo, la misma proyección que su GET.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. projects:write
Cabeceras
Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.
Límites: longitud mín. 1, longitud máx. 255
Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"
Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador del proyecto.
Límites: longitud mín. 1
Identificador del pedido.
Límites: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: ProjectDetailDto
Sobre: ProjectDetailResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay
El proyecto completo, tal como lo devuelve la API.
Mostrar atributos hijosOcultar atributos hijos
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.
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language · Idempotent-Replay
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language · Idempotent-Replay
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Conflicto (conflict): el estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, o otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Precondición fallida (precondition_failed): la etiqueta de entidad If-Match no coincide con la representación actual. Lee el recurso de nuevo y reintenta.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Idempotency-Key reutilizada (idempotency_key_reused): la misma clave se usó antes con un cuerpo distinto. Cambia la clave.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After · Idempotent-Replay
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
| 409 | conflict | El estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación. |
| 412 | precondition_failed | La etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta. |
| 422 | idempotency_key_reused | La misma clave se usó antes con un cuerpo distinto. Cambia la clave. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Relacionado
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasAlquileres
Proyecto
El proyecto, tal como lo devuelve la API.
¿Te ha resultado útil esta página?