Disponibilidad

Corregir o cerrar una indisponibilidad

Con action: "edit" corrige las fechas o el tipo; con action: "finish_now" la cierra en este instante, que es el caso de "volvió antes".

PATCH
/api/v1/availability/unavailabilities/{unavailabilityId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/availability/unavailabilities/unav_8f2a1c \
  --request PATCH \
  --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 '{
  "action": "finish_now",
  "expectedUpdatedAt": "2026-07-20T10:12:31+02:00"
}'
{
  "data": {
    "availability": {
      "id": "availability_9f3a2b",
      "resourceType": "Example resource type",
      "resourceId": "resource_9f3a2b",
      "resourceName": "Example resource name",
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "state": "Madrid",
      "absenceType": "Example absence type",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    },
    "warningCount": 1
  }
}

Generado a partir del esquema

expectedUpdatedAt es el bloqueo optimista: cópialo de la lectura y, si alguien la tocó entretanto, la petición se rechaza con 409 conflict y no se escribe nada; léela de nuevo y reintenta. edit solo se aplica a una indisponibilidad manual que aún no ha empezado: la creada por una tarea o por un horario se cambia desde su origen, y una que ya empezó solo se puede cerrar; ambas responden 409. Su nuevo inicio tiene que ser posterior a ahora y su fin posterior a su inicio (400 validation_error con errors[0].path en el campo, igual que con un absenceType de otro tipo de recurso), y en un espacio la nueva ventana no puede caer sobre sus reservas (409). finish_now solo cierra una indisponibilidad en curso —unavailable, ya empezada y aún no terminada—, también una que viene de un horario; cualquier otra responde 409, y también la creada por una tarea. warningCount es siempre 0 aquí: los compromisos que se solapan se cuentan cuando se declara la indisponibilidad. En un espacio responde 503 service_unavailable mientras las indisponibilidades de espacios estén desactivadas para la cuenta.

Autorizaciones

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

Parámetros de ruta

unavailabilityIdstringObligatorio

Identificador de la indisponibilidad.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: UnavailabilityUpdateBody

actionstringObligatorio

"edit" corrige la indisponibilidad; "finish_now" la cierra ahora mismo.

Opciones disponibles: edit, finish_now

expectedUpdatedAtstring<date-time>Obligatorio

Fecha de la última modificación que leíste. Si no coincide, se rechaza la petición.

startDatestring<date-time>

Nuevo inicio.

endDatestring<date-time>

Nuevo fin.

absenceTypestring | null

Nuevo tipo de ausencia; null lo borra.

Opciones disponibles: vacation, sick, personal, training, maintenance, inspection, repair, reserved, academic, event, closure, other

reasonstring | null

Nuevo motivo; null lo borra. La API no lo devuelve.

Límites: longitud máx. 500

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: UnavailabilityResultDto

Sobre: UnavailabilityResultResponse. 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 declarar o actualizar una indisponibilidad.

Mostrar atributos hijos
data.availabilityobject

La indisponibilidad tal como queda ahora.

Mostrar atributos hijos
data.availability.idstring

Identificador único de la indisponibilidad.

data.availability.resourceTypestring

Qué recurso: staff, vehicle o space.

data.availability.resourceIdstring

Identificador de ese recurso.

data.availability.resourceNamestring | null

Nombre del recurso; null si no consta.

data.availability.startDatestring<date-time>

Inicio de la indisponibilidad en ISO 8601 UTC.

data.availability.endDatestring<date-time>

Fin de la indisponibilidad en ISO 8601 UTC.

data.availability.statestring

Estado declarado. Este listado solo devuelve ventanas unavailable que aún no han terminado, así que aquí siempre es unavailable; available y unknown existen como declaraciones pero no se listan.

data.availability.absenceTypestring | null

Tipo de ausencia. Solo se emite para vehículos y espacios, donde es operativo; para el personal es un dato de salud y se devuelve como null.

data.availability.updatedAtstring<date-time> | null

Última modificación en ISO 8601 UTC; null si no está registrada.

data.warningCountinteger

Compromisos del recurso que se solapan con esta indisponibilidad.

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.
503service_unavailableLa función en la que escribe esta operación está desactivada para la cuenta. La petición es correcta; vuelve a funcionar en cuanto se activa la función.

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