Configuración
Esta sección aborda la configuración de los resultados.
GET /results/config
GET /results/config/{result}
Este método devuelve la lista de resultados.
Atributo de solicitud (Request attribute):
- result: Id del resultado del que queremos obtener la información. Si no se indica se muestran todos.
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: tipo de resultado para filtrar (0 bueno, 1 retrabajo, 2 deshecho, 255 todos). El valor por defecto es 255.
- showfields: indica si se muestran los campos asociados y su valor por defecto (0 no se muestran, 1 si se muestran). El valor por defecto es 0.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de resultados y sus propiedades.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
Content-Type: application/json Request: /results/config?company=demo01&session=LebEWTNf8GEhxfQeeGbBmVUlxmUIDLVdEoeVYrnWNzkdRXKxmgCNc92wnSjA&type=0&showfields=0 Reponse (success): { "status": "0", "data": [ { "id": "8561", "desc_de": "8561 1.4L", "desc_en": "8561 1.4L", "desc_es": "8561 1.4L", "desc_it": "8561 1.4L", "desc_pt": "8561 1.4L", "desc_sk": "8561 1.4L", "desc_zh": "8561 1.4L", "type": "0", "equiv": "1", "weight": "1", "url": "\\Servervlc01\SCalidad\Instruc\Instr. Inspeccion\8561\8561ii040-r07.doc = Inst. Inspección", "group": "0", "y0": "0", "g0": "0", "y1": "0", "g1": "0", "y2": "0", "g2": "0", "y3": "0", "g3": "0", "y4": "0", "g4": "0", "y5": "0", "g5": "0", "y6": "0", "g6": "0", "y7": "0", "g7": "0", "in_percentage": "0", "ignore_integration": "0", "replacement": "30", "expiration": "90", "minimum_stock": "300", "recurring": "0" }, ... ], "message": "Success" } |
POST/results/config
Este método crea un nuevo resultado. El usuario debe ser administrador.
Parámetros de solicitud (Request parameters, para obtener información adicional, revise la configuración de resultados):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- id [obligatorio]: el Id. del resultado.
- desc_de: descripción del resultado (en alemán).
- desc_en: descripción del resultado (en inglés).
- desc_es: descripción del resultado (en español).
- desc_it: descripción del resultado (en italiano).
- desc_pt: descripción del resultado (en portugués).
- desc_sk: descripción del resultado (en eslovaco).
- desc_zh: descripción del resultado (en chino).
- type: producción, retrabajo o chatarra.
- equiv: cada recuento de producción es equivalente a la cantidad de piezas.
- weight: peso de cada pieza (equiv.).
- url: documento o aplicación que se abrirá cuando el usuario haga clic en el icono de la carpeta que aparece después de haber hecho clic en el resultado, en la ventana de resultados. Por favor vea cómo configurar URLs.
- group: si este resultado se usará para agrupar resultados.
- y0: objetivo amarillo para disponibilidad.
- g0: objetivo verde para disponibilidad.
- y1: objetivo amarillo para la velocidad.
- g1: objetivo verde para la velocidad.
- y2: objetivo amarillo para la calidad.
- g2: objetivo verde para la calidad
- y3: objetivo amarillo para disponibilidad productiva.
- g3: objetivo verde para la disponibilidad productiva.
- y4: objetivo amarillo para la cantidad de MTBF.
- g4: objetivo verde para la cantidad de MTBF.
- y5: objetivo amarillo para el MTBF.
- g5: objetivo verde para el MTBF.
- y6: objetivo amarillo para el MTTR.
- g6: objetivo verde para el MTTR.
- y7: objetivo amarillo para el OCE.
- g7: objetivo verde para la OCE.
- inpct: si la producción se mide en%. Útil para resultados con un gran tiempo de ciclo (días o meses) y para permitir al usuario que trabaja proporcionar un avance periódico de su trabajo.
- interign: marca el resultado como para ser ignorado cuando se transfiere desde y hacia la información a otro sistema, como los ERP. Ver integración con otros sistemas.
- replacement: tiempo que tarda el material en llegar desde que se realiza el pedido (en días).
- expiration: tiempo en el que un material caduca desde su fabricación (en días).
- minstock: stock mínimo por debajo del cual se debe realizar un nuevo pedido.
- recurring: indica si este resultado será recurrente. Tareas u órdenes que están marcadas como recurrentes solo pueden generar resultados recurrentes.
- replace: indica si el resultado con el mismo id se va a reemplazar por el nuevo. El valor por defecto es cero (no reemplazar).
POST /results/config (ISA-95 compliant, para más información lea el documento de B2MML)
Este método crea un nuevo resultado usando datos B2MML codificados como JSON. El usuario debe ser administrador.
Parámetros de solicitud (Request parameters, para obtener información adicional, revise la configuración de resultados):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- data [obligatorio]: los datos que definen el resultados en formato B2MML codificado como JSON.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la respuesta en formato B2MML codificado como JSON.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo:
{ "SyncProductDefinition": { "ApplicationArea": { "Sender": { "ComponentID": "ERP", "ConfirmationCode": "Always" }, "CreationDateTime": "2017-02-10T07:30:03" }, "DataArea": { "Sync": { "ActionCriteria": { "ActionExpression": { "@actionCode": "Add" } } }, "ProductDefinition": [ { "ID": "PROD001", "Description": "Product Description", "Location": { "EquipmentID": "COMPANY", "EquipmentElementLevel": "Enterprise" }, "ProductSegment": { "EquipmentSpecification": { "EquipmentID": "PROC001", "EquipmentSpecificationProperty": [ { "ID": "Equivalence", "Quantity": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" } }, { "ID": "CycleT", "Quantity": { "QuantityString": "10", "DataType": "FLOAT", "UnitOfMeasure": "SEC" } }, { "ID": "CycleQ", "Quantity": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" } } ] } }, "Any": { "ProductType": "0", "Equivalence": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" }, "Weight": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "KG" }, "DocumentURL": "\\\\DOCS_FOLDER\\DOC1.INF", "Fields": { "Field": { "ID": "FIELD", "Description": "Field_Description", "DataType": "STRING", "Mandatory": "Ifempty", "Context": "Input", "StandardClass": "Lot", "MaxLength": "20", "Calculated": "0", "Locked": "0", "Inherits": "1", "Stock": "1" } } } }, { "ID": "PROD001.S1", "Description": "Scrap_Description", "Location": { "EquipmentID": "COMPANY", "EquipmentElementLevel": "Enterprise" }, "ProductSegment": { "EquipmentSpecification": { "EquipmentID": "PROC001", "EquipmentSpecificationProperty": [ { "ID": "Equivalence", "Quantity": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" } }, { "ID": "CycleT", "Quantity": { "QuantityString": "10", "DataType": "FLOAT", "UnitOfMeasure": "SEC" } }, { "ID": "CycleQ", "Quantity": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" } } ] }, "MaterialSpecification": { "MaterialDefinitionID": "PROD001", "MaterialUse": "Consumed", "Quantity": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" } } }, "Any": { "ProductType": "0", "Equivalence": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "UN" }, "Weight": { "QuantityString": "1", "DataType": "FLOAT", "UnitOfMeasure": "KG" }, "DocumentURL": "\\\\DOCS_FOLDER\\DOC2.INF", "Fields": { "Field": { "ID": "FIELD", "Description": "Field_Description", "DataType": "STRING", "Mandatory": "Ifempty", "Context": "Input", "StandardClass": "Lot", "MaxLength": "20", "Calculated": "0", "Locked": "0", "Inherits": "1", "Stock": "1" } } } } ] } } } |
Notas:
El sistema ignorará las etiquetas B2MML que no estén presentes en este documento, aunque podrían considerarse para futuras versiones.
Any: se refiere a propiedades de resultados que no se encuentran en el estándar:
- ProductType: producción, retrabajo o chatarra.
- Equivalence: cada conteo de producción es equivalente a cuántas piezas.
- Weight: peso de cada pieza (equiv.).
- Fields: se refiere a la lista de propiedades personalizadas agregadas por el usuario:
- ID, Descripción, Tipo de datos, Obligatorio, Contexto, Clase estándar, Longitud máx., Calculado, Bloqueado, Herencias y Stock se describen en la sección de configuración de campos.
- ID, Description, DataType, Mandatory, Context, StandardClass, MaxLength, Calculated, Locked, Inherits y Stock están descritos en la sección de configuración de campos.
Ejemplo de respuesta:
{ "status":"0", "data":"{ \"ConfirmBOD\":{ \"ApplicationArea\":{ \"Sender\":{\"ComponentID\":\"EDINN\",\"ConfirmationCode\":\"Always\"}, \"CreationDateTime\":\"2019-11-12T11:16:57\" }, \"DataArea\":{ \"Confirm\":{ \"ResponseCriteria\":{\"ResponseExpression\":{\"@actionCode\":\"Accepted\"}} }, \"BOD\":[ {\"Description\":\"Accepted PROD001\",\"Note\":\"Product PROD001 updated successfully\"}, {\"Description\":\"Accepted PROD001.S1\",\"Note\":\"Product PROD001.S1 updated successfully\"} ] } } }", "message":"Success" } |
DELETE /results/config/{id}
Este método borra un resultado. El usuario debe ser administrador.
Atributo de solicitud (Request attribute):
- id [obligatorio]: Id del resultado que queremos eliminar.
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.
GET /results/config/{result}/relatedresults
Este método devuelve las relaciones de un resultado.
Atributo de solicitud (Request attribute):
- result [obligatorio]: Id del resultado cuyos resultados relacionados queremos obtener.
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.
- result [obligatorio] : el Id. del resultado.
- type [obligatorio] : el índice del tipo.
- type = 0: Producción
- type = 1: Desecho
- type = 2: Retrabajo
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.
Request: {"type":"get", "url":"results/config/res0001/relatedresults", "data":"company=testco&session=neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV&type=1"} Reponse (success): { "status":"0", "data":[ {"Id_prod":"res001.S1","Desc":"Setup"}, {"Id_prod":"res001.S2","Desc":"Operator"}, {"Id_prod":"res001.S3","Desc":"Raw material"} ], "message":"Success" } Reponse (error): {"status":"1005", "data":"<a href='http:\/\/127.0.0.1:8080\/edinnM2\/help\/en\/API_Results_Config_Fields.html'>for additional information follow this link<\/a>", "message":"No data available"} |
POST /results/config/{result}/relatedresults
Este método permite crear la relación entre dos resultados. Si la relación ya existe y es del mismo tipo, actualiza los datos. Sino existe o es de un tipo distinto, la añade.
Atributo de solicitud (Request attribute):
- result [obligatorio]: Id del resultado al que queremos añadir un resultado relacionado.
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.
- relatedresult[obligatorio] : Resultado que queremos relacionar
- relationtype[obligatorio] : Tipo de relación.
- 1: Entrada. Cada vez que se produzca un resultado, se consumirá una cantidad del resultado relacionado.
- 2: Salida. Cada vez que se produzca un resultado, se producirá una cantidad del resultado relacionado.
- quantity: Cantidad del resultado relacionado que se consumirá o producirá cada vez que se produzca un resultado. Por defecto es 1.
- confirm: Si se pone a 1, pide confirmación cuando se va a consumir o producir el resultado relacionado y permite cambiar el resultado relacionado.
- produced: Si se pone a 1, indica que el resultado se ha producido internamente y no se ha adquirido.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve "true" en caso de éxito, y el enlace a la ayuda en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: {"type":"post", "url":"results/config/res0001/relatedresults", "data":"company=testco&session=neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV&relatedresult=res0002&relationtype=1&quantity=20"} Reponse (success): { "status":"0", "data":"true", "message":"Success" } Reponse (error): {"status":1074, "data":"<a href='http:\/\/mayen19\/edinnM2\/help\/en\/API_Results_Config_Relations.html'>for additional information follow this link<\/a>", "message":"Result not found"} |
GET /results/config/{result}/fields
Este método devuelve la definición de campos para el resultado proporcionado.
Atributos de la solicitud:
- result [obligatorio]: Id del resultado cuyos campos queremos obtener.
Parámetros de solicitud:
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id de la sesión activa.
Respuesta:
- status: devuelve "0" en caso de éxito o código del error.
- data: listado de campos pertenecientes al resultado en caso de éxito o enlace a la ayuda de la solicitud en caso de error.
- message: "Success" en caso de éxito o información descriptiva en caso de error.
Request: {"type":"get", "url":"results/config/res0001/fields", "data":"company=testco&session=neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV"} Reponse (success): { "status":"0", "data":[ { "id":"20200520113706AACCENTRAL", "parentid":"res0001", "order":"0", "name":"COLOR", "description":"NumerodeColores", "default":"4", "datatype":"4", "mandatory":"2", "fielddomainid":"", "context":"0", "calculation":"", "standardclass":"0", "maxlength":"0", "calculated":"0", "locked":"0", "inherits":"0", "stock":"0", "recurring":"0" } ], "message":"Success" } Reponse (error): {"status":"1005", "data":"<a href='http:\/\/127.0.0.1:8080\/edinnM2\/help\/en\/API_Results_Config_Fields.html'>for additional information follow this link<\/a>", "message":"No data available"} |