Cerrar OT

Las Órdenes de Trabajo pueden ser cerradas siempre que se encuentren en alguno de estos tres estados.

• INFORME

• CERRADA_OK

• CERRADA_CON_DESVIO

• CERRADA_NO_CUMPLIDA

De esta forma cualquier OT que no se encuentre en alguno de los estados mencionados no podrán marcarse como "cerradas". Se recibirá un 409 CONFLICT en tal caso.

POST https://api.persat.com.ar/v1/work-orders/wo_id/close

Path Parameters

Name	Type	Description
wo_id*	String	Identificador de la OT

Headers

Name	Type	Description
Authorization*	String	Bearer API_KEY
Content-Type*	String	application/json

Request Body

Name	Type	Description
state*	String	Estado de cierre: Puede ser: "CERRADA_OK" "CERRADA_CON_DESVIO" "CERRADA_NO_CUMPLIDA"
labels_ids	Number[]	Array de numeros. Cada item representa una etiqueta que deberia estar creada en el sistema. De todas maneras, si no existe la etiqueta la consulta continua sin problemas. Debido a que es una referencia débil.
cause*	String	Motivo de la cancelación. Max 500 caracteres

400: Bad Request Error en alguno de los campos enviados. userMessage contiene informacipon adicional.

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'cause' es un campo requerido de 500 caracteres máx."
    }
}

404: Not Found El cliente o el schema_id no existen

{
    "success": false,
    "error": {
        "status": 404,
        "type": "NOT_FOUND",
        "userMessage": "No hay una ot con este numero de wo_id: xxxx"
    }
}

Untitled

200: OK La consulta se ejecutó con éxito

{
    "success": true,
    "data": {
        "wo_id": "9"   /* id identificador de la OT cerrada */
    }
}

409: Conflict La OT ya no puede ser cancelada

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "No se puede cerrar la OT cuando se encuentra en estado 'CERRADA_NO_CUMPLIDA'"
    }
}

Ejemplo de request

El endpoint nos permite, además de cerrar la OT, modificar sus etiquetas. Podría ser útil para dejar la OT con una identificación indicando por ejemplo que fue "Pagada". (Previamente debería estar creada esta etiqueta)

body

{
    "state": "CERRADA_CON_DESVIO",
    "cause": "Se realizó el trabajo, pero queda un pendiente de pintura",
    "labels_ids": [1,6],        /* Opcional */
}

state: Requerido. Tipo de cierre. Puede ser "CERRADA_OK", "CERRADA_CON_DESVIO", "CERRADA_NO_CUMPLIDA"

cause: Requerido. Motivo del cierre.

labels_ids: Es opcional. En caso de no enviarse, la OT será cerrada y mantendrá las mismas etiquetas que tenia previamente. Si quisiera borrar sus etiquetas, entonces tendría que enviar un array vacio.

"labels_ids": [],

Recuerde que el valor de labels_ids termina pisando el valor original de la OT. Con lo cual si quisieramos agregar una etiqueta, deberíamos primero Obtener OT, para luego agregar al array de labels_ids la nueva etiqueta y asi poder finalmente ejecutar este endpoint para cancelar la OT y agregarle dicha nueva etiqueta.

Análisis de la respuesta

{
    "success": true,
    "data": {
        "wo_id": "9"   /* id identificador de la OT cerrada */
    }
}

La respuesta solo indica que la OT fue cerrada.