Obtener borradores por servicio

Este endpoint devuelve los borradores de un servicio para el día indicado en la petición.

GET /api/v1/businesses/{businessId}/services/{serviceId}/drafts?day={yyyy-MM-dd}

Si los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá los borradores para la fecha con la siguiente información:

  • orquestId: identificador interno del borrador en Orquest.

  • name: nombre del borrador.

  • creator: usuario que ha creado el borrador.

  • updater: último usuario que ha actualizado el borrador.

  • created: fecha y hora de la creación em formato yyyy-MM-ddTHH:mm:ss.SSSZ.

  • updated: fecha y hora de la última actualización en formato yyyy-MM-ddTHH:mm:ss.SSSZ.

  • status: estado del borrador. Los valores posibles son los siguientes:

    • NONE - no planificado.

    • QUEUED - en cola.

    • PROCESSING - planificando.

    • GENERATED - se han generado turnos, pero sin alteraciones manuales.

    • FAILED - fallido.

    • CANCELED - cancelado.

    • PUBLISHED - publicado con o sin cambios tras generar turnos.

  • from: fecha de inicio del intervalo que cubre el borrador.

  • to: fecha de fin del intervalo que cubre el borrador.

  • product: identificador externo del producto al que hace referencia el borrador.

  • service: identificador externo del servicio al que hace referencia el borrador.

A continuación, se muestra un ejemplo de respuesta:

[
    {
        "orquestId": 2221111,
        "name": "JUNE-23",
        "creator": "username@gmail.com",
        "updater": "username@gmail.com",
        "created": "2025-05-25T15:53:27.031Z",
        "updated": "2025-05-25T15:53:27.031Z",
        "status": "PUBLISHED",
        "from": "2025-06-23",
        "to": "2025-06-29",
        "product": "0001-GENERAL",
        "service": "0001"
    },
    {
        "orquestId": 22221112,
        "name": "JUNE-23",
        "creator": "username@gmail.com",
        "updater": "username@gmail.com",
        "created": "2025-05-19T12:03:34.424Z",
        "updated": "2025-05-25T15:52:53.632Z",
        "status": "NONE",
        "from": "2025-06-23",
        "to": "2025-06-29",
        "product": "0001-GENERAL",
        "service": "0001"
    }
]

El estado por defecto al crear un nuevo borrador es NONE. Sin embargo, cuando un borrador que ha sido generado por el motor (GENERATED) se modifica manualmente, vuelve al estado NONE.

Cuando se publica, se crea una copia y se le asigna el estado PUBLISHED. Debido a esto, como se muestra en este ejemplo, el mismo borrador con nombre JUNE-23 aparece una vez con estado NONE y otra con estado PUBLISHED.

Aspectos que tener en cuenta

Si no hay ningún borrador para la fecha de la consulta, la petición devolverá un array vacío [].

Si el servicio indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje not exits.

Esta petición permite filtrar los resultados por el estado del borrador. Para ello, será necesario añadir el parámetro status a la URL:

GET /api/v1/businesses/{businessId}/services/{serviceId}/drafts?day={yyyy-MM-dd}&status={STATUS}
Ver ejemplo 
GET /api/v1/businesses/BUSINESSID/services/0001/drafts?day=2025-02-25&status=PUBLISHED

Respuesta:

[
    {
        "orquestId": 2221111,
        "name": "JUNE-23",
        "creator": "username@gmail.com",
        "updater": "username@gmail.com",
        "created": "2025-05-25T15:53:27.031Z",
        "updated": "2025-05-25T15:53:27.031Z",
        "status": "PUBLISHED",
        "from": "2025-06-23",
        "to": "2025-06-29",
        "product": "0001-GENERAL",
        "service": "0001"
    }
]