Planificador

Quitar un recurso de un servicio

Deshace una asignación.

POST
/api/v1/planner/assignments/remove

Ejemplos de petición

curl https://app.filmo.io/api/v1/planner/assignments/remove \
  --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 '{
  "orderId": "ord_0000421",
  "orderServiceId": "osv_0000912",
  "staffId": "stf_luis_perez"
}'
{
  "data": {
    "status": "Example status"
  }
}

Generado a partir del esquema

Es un POST a un subrecurso y no un DELETE porque el destino se identifica con hasta cuatro campos y el recurso con tres (assignmentId, staffId o vehicleId): eso no cabe en una ruta, y un DELETE con cuerpo obligatorio es un contrato peor. En una tarea el recurso es siempre staffId: una tarea no tiene ni vehículos ni identificadores de asignación, y enviar uno de esos responde 400 validation_error en ese campo. Un destino que no existe o que pertenece a otra cuenta también responde 400 validation_error, con errors[].path en su campo; un recurso que no está asignado a ese destino responde 404 not_found: no hay nada que quitar.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. planner: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: PlannerAssignmentRemoveBody

orderIdstring

Pedido al que está asociado el servicio.

orderServiceIdstring

Línea de servicio dentro de ese pedido.

taskIdstring

Tarea del planificador de la que quitar el recurso.

internalServiceIdstring

Asignación interna de la que se va a quitar.

assignmentIdstring

Identificador de la asignación concreta, si lo tienes.

staffIdstring

Miembro del personal que se quita.

vehicleIdstring

Vehículo que se quita.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: PlannerUnassignResultDto

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

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

dataobject

Resultado de quitar un recurso.

Mostrar atributos hijos
data.statusstring

Resultado de la operación.

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