Configuración
BETA: Esta funcionalidad está en desarrollo y puede que haya cambios no reflejados en esta ayuda.
Esta sección aborda la configuración de los campos (fields).
GET/fields/{id}/config
Este método devuelve la lista de campos.
Attributos requeridos:
- id [obligatorio]: el Id. del campo.
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.
- module [obligatorio]: indica el módulo al que pertenece el campo que buscas. 0: resultados, 1: autocontrol.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de propiedades del campo.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Content-Type: application/json Request: /fields/config?company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB&mod=0&idfield=S0000 Reponse (success): { "status": "0", "data": [ { "id": "20210520092950AAC", "id2": "S0000", "var": "1a2s1", "desc": "testApi2", "values": "1a2s", "ftype": "0", "mandat": "0", "id_comb": "", "io": "0", "id_calc": "", "fclass": "0", "maxlength": "255", "calculated": "0", "locked": "0", "inherits": "0", "stock": "0" }, ], "message": "Success" } |
POST/fields/config
Este método crea un nuevo campo. El usuario debe tener permiso de administrador.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o id. de la empresa.
- session [obligatorio]: id de la sesión activa.
- parent [obligatorio]: resultados o autocontrol al que se aplicará el campo.
- variable [obligatorio]: nombre interno del campo. Permite realizar estudios estadísticos, enlaces con algoritmos (tipos de cálculo), etc. Puede cambiar el campo de descripción (campo), pero no el nombre de la variable.
- description [obligatorio]: descripción que le aparece al usuario que trabaja.
- values [obligatorio]: valor predeterminado o las posibles respuestas que el usuario podría dar (separadas por comas).
- module [obligatorio]: indica el módulo al que pertenece el campo que buscas. 0: resultados, 1: autocontrol.
- type:
0: Real, número con decimales.
1: Entero, número sin decimales.
2: Fecha, fecha en el formato dd/mm/aaaa.
3: Hora, tiempo en el formato hh:mm.
4: Texto, texto libre.
5: Dirección IP, dirección de red IP.
6: Hora Segs., hora en formato hh:mm:ss
7: Selección, permite hacer un menú desplegable. Usa la ventana de configuración de combos para configurar opciones.
8: URL, enlace a una URL en la sintaxis del sistema. Por favor, vea cómo configurar las URL.
9: Alfabético, sólo letras.
10: Fecha y hora, fecha y hora en formato dd/mm/aaaa hh:mm.
11: Fecha y hora (segs.), fecha y hora en formato dd/mm/aaaa hh:mm:ss.
12: Selección múlt., selección múltiple.
13: MAC, dirección MAC.
14: Porcentaje, número para representar porcentajes.
15: Autoincremental, valor numérico único para el campo independiente del resultado o tarea a la que esté asociado.
16: Botón, llama a una función declarada en una UDL de gestión de campos.
17: Puerto TCP, puerto TCP entre 1 y 65535
18: Ahora fecha, fecha actual en formato dd/mm/aaaa.
19: Ahora hora, hora actual en formato hh:mm.
20: Ahora hora (segs.), hora actual en formato hh:mm:ss.
21: Ahora fecha y hora, fecha y hora actuales en formato dd/mm/aaaa hh:mm.
22: Ahora fecha y hora (segs.), fecha y hora actuales en formato dd/mm/aaaa hh:mm:ss.
23: E-mail, dirección de correo electrónico.
- domain: en caso de type 7 o 12, se tendrá que asignar el id de un combo.
- apply: indica a qué hay que aplicar este campo (Producción, Entradas, Salidas, E/S [Entradas y Salidas], etc.).
- mandatory: cuando el campo es obligatorio. Las opciones son las siguientes:
- Al configurar campos para resultados:
- 0: sólo si está vacío.
- 1: el campo siempre es obligatorio.
- 2: el campo nunca es obligatorio.
- 3: cuando los resultados se están insertando manualmente.
- 4: al finalizar o pausar una orden. Esta opción sólo aplicará a campos en entradas.
- 5: al iniciar una orden.
- Al configurar campos para autocontrol:
- 0: nunca es obligatorio.
- 1: cuando el estado de la tarea cambia.
- 2: si el estado de la tarea se cambia a Ok.
- 3: si el estado de la tarea se cambia a advertencia.
- 4: si el estado de la tarea se cambia a error.
- 5: si el estado de la tarea se cambia a error o advertencia.
- 6: cuando se inicia la tarea.
- calculation: tipo de cálculo que se aplicará al campo. Esto es útil para convertir los valores de los campos.
- fcalss: esto es para indicar a otros sistemas informáticos el tipo de campo. Por favor vea integración con otros sistemas.
- 0: clase de campo de propósito general.
- 1: Unidad de medida. Si se informa, prevalece sobre la unidad de medida del proceso.
- 2: tiempo de ciclo. Está informado, prevalece sobre el del proceso y la relación PSR.
- 3: Cantidad de ciclos o unidades de ciclo. Está informado, prevalece sobre el del proceso y la relación PSR.
- 4: informar sobre el lote de material.
- 5: almacena la etiqueta B2MML correspondiente.
- 6: almacena la etiqueta B2MML correspondiente.
- 7: almacena la etiqueta B2MML correspondiente.
- 8: almacena la etiqueta B2MML correspondiente.
- 9: almacena la etiqueta B2MML correspondiente.
- 10: almacena la etiqueta B2MML correspondiente.
- 11: almacena la etiqueta B2MML correspondiente.
- 12: almacena la etiqueta B2MML correspondiente.
- 13: almacena la etiqueta B2MML correspondiente.
- 14: almacena la etiqueta B2MML correspondiente.
- 15: almacena la etiqueta B2MML correspondiente.
- 16: almacena la etiqueta B2MML correspondiente.
- 17: almacena la etiqueta B2MML correspondiente.
- 18: almacena la etiqueta B2MML correspondiente.
- 19: cada producción contando equivale a cuántas piezas. Por ejemplo: 1 unidad (una caja) equivale a 6 piezas.
- 20: conversión visual de unidades de producción a unidades visuales.
- maxlength: longitud máxima del campo.
- calculadted: indica si el campo se calculará mediante una UDL de campo.
- locked: indica si el usuario no puede cambiar el campo.
- inherits: indica si el campo hereda su valor del campo con el mismo nombre de variable del registro de producción anterior.
- stock: indica si el campo se usa para diferenciar el stock.
Content-Type: application/json Request: /fields/config?company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB&idfield=S0000&mod=0 Reponse (success): { "status": "0", "data":true, "message": "Success" } |
PUT /fields/{id}/config
Este método modifica un campo. El usuario debe tener permiso de administrador.
Attributos requeridos:
- id [obligatorio]: el Id. del campo.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o id. de la empresa.
- session [obligatorio]: id de la sesión activa.
- variable [obligatorio]: nombre interno del campo. Permite realizar estudios estadísticos, enlaces con algoritmos (tipos de cálculo), etc. Puede cambiar el campo de descripción (campo), pero no el nombre de la variable.
- description [obligatorio]: descripción que le aparece al usuario que trabaja.
- value [obligatorio]: valor predeterminado o las posibles respuestas que el usuario podría dar (separadas por comas).
- module [obligatorio]: indica el módulo al que pertenece el campo que buscas. 0: resultados, 1: autocontrol.
- type: tipo de campo
- idcomb: en caso de type 7 o 12, se tendrá que asignar el id de un combo.
- apply: indica a qué hay que aplicar este campo (Producción, Entradas, Salidas, E/S [Entradas y Salidas], etc.).
- mandatory: cuando el campo es obligatorio. Las opciones son las siguientes:
- calculation: tipo de cálculo que se aplicará al campo. Esto es útil para convertir los valores de los campos.
- fcalss: esto es para indicar a otros sistemas informáticos el tipo de campo. Por favor vea integración con otros sistemas.
- maxlength: longitud máxima del campo.
- calculadted: indica si el campo se calculará mediante una UDL de campo.
- locked: indica si el usuario no puede cambiar el campo.
- inherits: indica si el campo hereda su valor del campo con el mismo nombre de variable del registro de producción anterior.
- stock: indica si el campo se usa para diferenciar el stock.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve verdadero en caso de éxito.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Content-Type: application/json Request:/fields/config?company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB&results=S0000&variable=1a2s&description=testApi&values=modifiedField&mod=0&id=20210520092549AAB Reponse (success): { "status": "0", "data":true, "message": "Success" } |
DELETE /fields/{id}/config
Este método elimina un campo configurado. El usuario debe tener permiso de administrador.
Attributos requeridos:
- id [obligatorio]: el Id. del campo.
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.
- module [obligatorio]: indica el módulo al que pertenece el campo que buscas. 0: resultados, 1: autocontrol.
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.
Content-Type: application/json Request:/fields/config?company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB&id=20210520092549AAB&mod=0 Reponse (success): { "status": "0", "data":true, "message": "Success" } |