Colecciones

Crear una colección

Crea un nodo del árbol por el que se organiza el catálogo.

POST
/api/v1/collections

Ejemplos de petición

curl https://app.filmo.io/api/v1/collections \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Cámaras",
  "description": "Cuerpos de cámara y accesorios de cuerpo.",
  "entityType": "item"
}'
{
  "data": {
    "id": "collection_created_9f3a2b",
    "name": "Example collection created",
    "entityType": "item"
  }
}

Generado a partir del esquema

entityType decide de qué es el árbol (artículos por defecto) y NO se puede cambiar después. Omite parentCollectionId para una colección de primer nivel.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. collections:write

Cabeceras

Idempotency-Keystring

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"

Cuerpo

application/json

Esquema del cuerpo: CollectionCreateBody

namestringObligatorio

Nombre de la colección.

Límites: longitud mín. 1

descriptionstring

Descripción de la colección.

parentCollectionIdstring

Colección padre. Omítela para una colección de nivel superior.

iconstring

Icono de la colección.

entityTypestring

Qué agrupa la colección. Por defecto es "item". No se puede cambiar después.

Opciones disponibles: item, space, vehicle, staff, service

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: CollectionCreatedDto

Sobre: CollectionCreatedResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Acuse de una colección creada.

Mostrar atributos hijos
data.idstring

Identificador único de la colección.

data.namestring

Nombre de la colección.

data.entityTypestring

Qué agrupa la colección: item, space, vehicle, staff o service.

Opciones disponibles: item, space, vehicle, staff, service

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl 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].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
422idempotency_key_reusedLa 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