Operación
Esta sección aborda la operación de los estados (statuses).
GET /statuses
Proporciona una lista de estados. Deberá proporcionar un proceso específico y el tiempo de inicio y fin para filtrar los estados. El usuario debe tener el rol de estados.
Solicitud (Request):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: Id. del proceso del que desea obtener los estados.
- datefrom [obligatorio]: la fecha de inicio de la selección.
- dateto [obligatorio]: la fecha de fin de la selección.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- id: identificador del registro en la base de datos.
- machdate: indica el proceso donde se registro el estado y la fecha y hora de inicio del periodo en formato yyyymmddhhmmss.
- id_tu: código del estado.
- endtime: fecha y hora del final del periodo en formato yyyymmddhhmmss. Se deja en blanco para el estado actual.
- secs: cantidad en segundos que dura el periodo. Se queda en 0 para el estado actual.
- id_author: identificador del recurso que creó e periodo. El valor CENTRAL indica que se creó automáticamente por edinn.
- created: indica la fecha y hora de creación del registro en la base de datos en formato yyyymmddhhmmss.
- id_mod: si el registro fue modificado, indica el identificador del recurso que lo modificó por última vez.
- modified: indica la fecha y hora de la última modificación del registro en la base de datos en formato yyyymmddhhmmss.
- link: identficador del registro de la tabla de comentarios asociado a este registro de estados.
- notified: fecha y hora en la que se avisó por correo sobre este estado en formato yyyymmddhhmmss.
- tu_desc: descripción del estado en el idioma del recurso que hizo la petición.
- tu_type: tipo de estado. Los tipos de estado se describen aqui.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"get", "url":"statuses", "data":"company=testco&session=LzRlv4vjbyHWPhO2B2ulNjmSZFNmvpW4aqbLaoz1n6KJF91RJPCsZcmVLzpy&process=7101&datefrom=20211008060000&dateto=20211008090000"} Response (success): {"status":"0", "data":[{"id":"20211008093900AARCENTRAL","machdate":"710120211008060000","id_tu":"SNP","endtime":"20211008085530","secs":"10530","id_author":"CENTRAL","created":"20211008093900","id_mod":"ADMIN","modified":"20211008101419","link":"","notified":"","tu_desc":"SIN PRODUCCION","tu_type":"4"},{"id":"20211008101419AAGINIT","machdate":"710120211008085530","id_tu":"6105","endtime":"20211008095512","secs":"3582","id_author":"ADMIN","created":"20211008101419","id_mod":"ADMIN","modified":"20211008101432","link":"","notified":"","tu_desc":"Cambio de pedido o modelo","tu_type":"1"}], "message":"Success"} |
POST /statuses
Crear un nuevo estado. Tienes que especificar el proceso, el dispositivo, y el estado para crearlo. El usuario debe tener el rol de estados.
Soicitud (Request):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: Id. del proceso del que desea obtener los estados.
- device [obligatorio]: Id del dispositivo al que pertenece.
- status [obligatorio]: El nombre del nuevo estado
- datefrom [obligatorio]: la fecha de inicio del nuevo estado.
- dateto: En caso de se un estado planificado. Indica la fecha de fin de este.
- calendar: Indica si el estado es planificado o no.
Respuesta:
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: identificador del estado en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"post", "url":"statuses", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&process=7102&datefrom20211011160000&dateto=20211011163000&status=6105&calendar=1&device=init"} Response (success): {"status":"0","data":"20211011153821AABINIT","message":"Success"} |
DELETE /statuses/{id}
Este método elimina un estado. Para conocer las restricciones que existen consulte este documento.
Atributo de solicitud (Request attribute):
- id [obligatorio]: el Id. del estado.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"delete", "url":"statuses/20211011153821AABINIT", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&calendar=1"} Response (success): {"status":"0","data":true,"message":"Success"} |
DELETE /statuses
Este método elimina un estado. Para conocer las restricciones que existen consulte este documento.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- datefrom [obligatorio]: inicio del intervalo de tiempo.
- dateto [obligatorio]: final del intervalo de tiempo.
- calendar [obligatorio]: Indica si el estado es planificado o no.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"delete", "url":"statuses", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&process=7102&datefrom=20211011160000&dateto=20211011163000&calendar=1"} Response (success): {"status":"0","data":true,"message":"Success"} |
PATCH /statuses/{id}
Este método justifica un estado.
Atributo de solicitud (Request attribute):
- id [obligatorio]: el Id. del estado.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- date [obligatorio]: la fecha de inicio de la selección.
- status [obligatorio]: el id. del estado para justificar.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"patch", "url":"statuses/20211011141555ACSCENTRAL", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&date=20211011141500&status=6104"} Response (success): {"status":"0","data":true,"message":"Success"} |
PUT /statuses/{id}
Este método justifica un estado. dependiendo del tipo del parametro pasado. (0 para Justify, 1 para Divide)
Atributo de solicitud (Request attribute):
- id [obligatorio]: el Id. del estado.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- type [obligatorio]: El tipo de operacion PUT (0 para Justify, 1 para Divide.)
- status: el id. del estado para justificar. (obligatorio para Justify un estado).
- date: la fecha de inicio de la selección.(obligatorio para Divide un estado).
- device: el Id del dispositivo (obligatorio para Divide un estado).
Respuesta (Response):
- status: returns "0" on success, and an error code in any other case.
- data: "true" on success, and empty in case of error.
- message: "success" or a descriptive information of the error in any other case.
Ejemplo (Divide):
Request: {"type":"put", "url":"statuses/20090301070004TBBCENTRAL", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&date20211011134506=FAI&type=1&device=init"} Response (success): {"status":"0","data":true,"message":"Success"} |
Ejemplo (Justify):
Request: {"type":"put", "url":"statuses/20090301070004TBBCENTRAL", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&status=FAI&type=0"} Response (success): {"status":"0","data":true,"message":"Success"} |
GET /statuses/fai
Este método devuelve la información relacionada con los fallos de un proceso.
Parámetros requeridos (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: la id del proceso
Respuesta:
- status: devuelve "0" en caso de éxito, "01" en caso de que no existe fallos para el proceso, y un código de error en cualquier otro caso.
- data: Devuelve la información de los fallos que tiene el proceso seleccionado, o si no hay fallos, un enlace a mas información.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"get", "url":"statuses/fai", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&process=7102"} Response (success): {"status":"0","data":[{"id":"20211011134701AAKCENTRAL","machdate":"710220211011060000","id_tu":"FAI","end":"","secs":"0","Author":"CENTRAL","Created":"20211011134701","Modifier":"","Modified":"","Link":"3","Notified":"","type":"PENDING"},{"id":"20211011134659AAICENTRAL","machdate":"710220211011134500","id_tu":"6531","end":"","secs":"0","Author":"CENTRAL","Created":"20211011134659","Modifier":"","Modified":"","Link":"4","Notified":"","type":"Final turno ma\u00f1ana"}],"message":"Success"} |
GET /statuses/summary
Le proporciona una lista de estados. Debe proporcionar un proceso específico y la hora de inicio y fin para filtrar los estados.
Solicitud:
- session [obligatorio]: su ID de sesión.
- company [obligatorio]: la identificación de la empresa.
- process [obligatorio]: el identificador del proceso del cual desea los estados.
- datefrom [obligatorio]: la fecha de inicio de la selección.
- dateto [obligatorio]: La fecha de finalización de la selección.
- top: el número máximo de estados mostrados. Por defecto es 10.
- type: el tipo de estado por el que se quiere filtrar.
Respuesta:
- status: devuelve "0" en caso de éxito, y un código de error en cualquier otro caso.
- data: "Éxito" en caso de éxito, y vacío en caso de error.
- message: "Éxito" o información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"get", "url":"statuses/summary", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&process=7101&datefrom=20211008060000&dateto=20211009060000&top=3"} Response (success): {"status":"0","data":[{"id":"6102","start":"","time":"51375","quantity":"1","desc_de":"Cambio de bobina","desc_en":"Cambio de bobina","desc_es":"Cambio de bobina","desc_it":"Cambio de bobina","desc_pt":"Cambio de bobina","desc_sk":"","desc_zh":""},{"id":"0","start":"","time":"12759","quantity":"4","desc_de":"PRODUCCION","desc_en":"PRODUCCION","desc_es":"PRODUCCION","desc_it":"PRODUCCION","desc_pt":"PRODUCCION","desc_sk":"","desc_zh":""},{"id":"SNP","start":"","time":"11094","quantity":"2","desc_de":"SIN PRODUCCION","desc_en":"SIN PRODUCCION","desc_es":"SIN PRODUCCION","desc_it":"SIN PRODUCCION","desc_pt":"SIN PRODUCCION","desc_sk":"","desc_zh":""}],"message":"Success"} |
GET /statuses/top
Este método devuelve el Id y descripción del status top del proceso seleccionado.
Parámetros requeridos (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: la id del proceso
Respuesta:
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: Devuelve el Id y descripción del status
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Request: {"type":"get", "url":"statuses/top", "data":"company=testco&session=0bvqC8zNdyTkm5BrqX7M0C80IC3O2MraAz0RxKyhnenmNfNVTL0aH5dpMJO6&process=7101"} Response (success): {"status":"0", "data":[{"Id":"6105","Desc":"Cambio de pedido o modelo"},{"Id":"6102","Desc":"Cambio de bobina"},{"Id":"6301","Desc":"Limpieza"}], "message":"Success"} |