Webapi

WebAPI – Órdenes de Trabajo

151 views 28 April, 2017 12 July, 2019 Valuekeep 0

Este servicio permite obtener y modificar las Órdenes de Trabajo en Valuekeep. A continuación, se muestra un análisis de los métodos disponibles en el servicio.

Obtener Órdenes de Trabajo

GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrdersByFilter

Este método permite obtener la lista de las OT, aplicando diversos filtros. La lista de OT puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la OT")
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • DaysLimit: Número máximo de días desde la fecha de creación de la OT
  • AssignedTo: Login del usuario del trabajador asignado a las tareas de la OT
  • Version: Versión
  • WOResponsible: Responsable por la OT
  • WCResponsible: Responsable por el Centro de Trabajo
  • WOOrWCResponsible: Responsable por la OT o por el Centro de Trabajo

Todos los filtros son opcionales. La lista de OT que se devuelve está ordenada por versión y por orden creciente. Si se define el filtro por usuario, para cada OT solo se devuelven las tareas asignadas a ese usuario. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrdersByFilter?stateKey=001&stateKey=002&maxRecords=50&daysLimit=30&assignedTo=myuser&version=AAAAAAAAAAA=

Se obtienen como máximo 50 OT en los estados "Pendiente" y "Pendiente de Aprobación", creadas en los últimos 30 días, con tareas asignadas al trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

  GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrdersByFilterForMobile

Este método permite obtener la lista de las OT, aplicando diversos filtros. La lista de OT puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la OT")
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • AssignedTo: Login del usuario del trabajador asignado a las tareas de la OT
  • CreatedBy: Login de usuario del trabajador que ha creado la OT
  • Version: Versión
  • WOOrWCResponsible: Responsable por la OT o por el Centro de Trabajo
  • CanceledStates: Booleano que indica si se deben incluir las OT en el estado cancelado
  • FinalState: Booleano que indica si se deben incluir las OT en el estado final
  • FinalStateDaysLimit: Número máximo de días desde la fecha de cierre de la OT

Todos los filtros son opcionales. La lista de OT que se devuelve está ordenada por versión y por orden creciente. Si se define el filtro por usuario, para cada OT solo se devuelven las tareas asignadas a ese usuario. En el caso de que no se especifiquen los parámetros CanceledStates FinalState, el método no devuelve las OT en los estados cancelado y final. Si se especifican, solo se devuelven las OT en el estado cancelado y/o en el estado final, según los parámetros definidos. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrdersByFilterForMobile?maxRecords=100&canceledStates=true&finalState=true&finalStateDaysLimit=30&assignedTo=myuser&version=AAAAAAAAAAA=

Se obtienen como máximo 100 OT en los estados cancelado y final, cerradas en los últimos 30 días, con tareas asignadas al trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

Obtener Costes de las Órdenes de Trabajo

GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderCostsByFilter

Este método permite obtener la lista de Costes de las OT, aplicando diversos filtros. La lista de Costes de las OT puede filtrarse por:

  • WorkOrderKey: Clave de la OT.
  • IssueKey: Clave de la Incidencia asociada a la OT.
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • Issuer: Login de usuario del trabajador que ha realizado la solicitud de la incidencia asociada a la OT
  • Version: Versión
  • HasIssue: Campo que indica si la lista solo incluye las OT con una incidencia asociada
  • DaysLimit: Número máximo de días desde la creación de la Orden de Trabajo.
  • Year: Año de las incidencias
  • Responsible: Login del usuario responsable por el activo, localización o ruta de la orden de trabajo.
  • WOResponsible: Responsable por la OT
  • WCResponsible: Responsable por el Centro de Trabajo
  • WOOrWCResponsible: Responsable por la OT o por el Centro de Trabajo
  • Createdby: login del usuario que ha creado la OT

Todos los filtros son opcionales. La lista de Costes de las OT que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderCostsByFilter?issuer=myuser&issueKey=IC0001&maxrecords=50&version=AAAAAAAAAAA=&hasIssue=true

Se obtienen como máximo 50 Costes de las OT con incidencia asignada, creadas por el trabajador con login "myuser" y una versión superior a la "AAAAAAAAAAA=".

Obtener Lista de Tiempos de Respuesta de las Órdenes de Trabajo

GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfWorkOrders/GetResponseTimesOfWorkOrdersByFilter

Este método permite obtener una lista de los Tiempos de Respuesta de las Órdenes de Trabajo, aplicando diversos filtros. La lista de Tiempos de Respuesta de las Órdenes de Trabajo puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la Orden de Trabajo")
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • WorkOrderKey: Por la clave de la Orden de Trabajo
  • Version: Versión
  • DaysLimit: Número máximo de días desde la creación de la Orden de Trabajo
  • Year: Año de las órdenes de trabajo, surgen todas las órdenes de trabajo cuyo año es superior al indicado en el filtro
  • Responsible: Login del usuario responsable por el activo de la orden de trabajo
  • WOResponsible: Responsable por la OT
  • WCResponsible: Responsable por el Centro de Trabajo
  • WOOrWCResponsible: Responsable por la OT o por el Centro de Trabajo

Todos los filtros son opcionales. La lista de Tiempos de Respuesta de las Órdenes de Trabajo que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfWorkOrders/GetResponseTimesOfWorkOrdersByFilter?stateKey=001&stateKey=002&maxRecords=50&woresponsible=myuser&version=AAAAAAAAAAA=

Se obtienen como máximo 200 registros de Tiempos de Respuesta de las Órdenes de Trabajo en los estados "Pendiente de Aprobación" y "Aprobado", en los que el responsable por las órdenes de trabajo es el trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

Obtener Trabajadores Asignados a la Orden de Trabajo

GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderAssignedEmployees

Este método permite obtener la lista de Trabajadores Asignados a la OT, aplicando diversos filtros. La lista de Trabajadores Asignados a la OT puede filtrarse por:

  • WorkOrderKey: Clave de la OT;
  • StateKey: Lista de estados (valores en "Tabla de Estados de la OT");
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo);
  • HasIssue: Campo que indica si la lista solo incluye las OT con una incidencia asociada;
  • DaysLimit: Número máximo de días desde la creación de la orden de trabajo;
  • CreationYear: Año de creación de la OT;
  • Version: Versión;
  • WOResponsible: Responsable por la OT;
  • WCResponsible: Responsable por el Centro de Trabajo;

Todos los filtros son opcionales. La lista de Trabajadores Asignados a la OT que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderAssignedEmployees?maxrecords=50&version=AAAAAAAAAAA=&hasIssue=true

Se obtienen como máximo 50 registros de asignación con incidencia definida y una versión superior a la "AAAAAAAAAAA=".

Crear una Orden de Trabajo

POST /api/mytenant/myorganization/maintenancemanagementcore/workorders/CreateWorkOrder

Este método ofrece una forma simplificada de crear una Orden de Trabajo para un determinado Activo, Localización, Ruta de Activos o Ruta de Localizaciones. En el “cuerpo” del mensaje debe introducirse la estructura del recurso WorkOrderInfoResource.

Ejemplo:

{ "WorkOrderKey": "WO135", "Description": "Orden de Trabajo", "WorkOrderTypeKey": "PR", "AssetKey": "AC-0022", "LocationKey": null, "AssetRouteKey": null, "LocationRouteKey": null, "MaintenancePlanKeys": ["PM-000012.1", "PM-000013.1"], "WorkCenterKey": "CTEGH", "PriorityLevelKey": "ALTA", "Remarks": "Observaciones Generales", "Date": "2015-08-31T11:15:17.477+00:00" }

Asignar una Orden de Trabajo

POST /api/mytenant/myorganization/maintenancemanagementcore/workordertaskassignments/AssignWorkOrder

Este método ofrece una forma fácil de asignar una Orden de Trabajo a Trabajadores. En el “cuerpo” del mensaje debe introducirse la estructura del recurso WorkOrderAssignmentResource.

Ejemplo:

{ "WorkOrderKey": "WO0034", "EmployeesToAssign": [ "0002", "0006" ] }

Desasignar una Orden de Trabajo

POST /api/mytenant/myorganization/maintenancemanagementcore/workordertaskassignments/AssignWorkOrder

Este método ofrece una forma fácil de desasignar una Orden de Trabajo a Trabajadores. En el “cuerpo” del mensaje debe introducirse la estructura del recurso WorkOrderAssignmentResource.

Ejemplo:

{ "WorkOrderKey": "WO0022", "EmployeesToUnassign": [ "0002", "0006" ] }

Actualizar una Orden de Trabajo

PUT /api/mytenant/myorganization/maintenancemanagementcore/workorders/{workOrderKey}

Este método permite actualizar una Orden de Trabajo. Para ello, en el “cuerpo” del mensaje http debe introducirse la estructura del recurso WorkOrderResource completa (incluidos los que no se han modificado).

Eliminar una Orden de Trabajo

DELETE /api/mytenant/myorganization/maintenancemanagementcore/workorders/{workOrderKey}

Este método permite eliminar una determinada Orden de Trabajo por su clave natural. Ejemplo: Eliminar la Orden con la clave natural Sample001
DELETE /api/mytenant/myorganization/maintenancemanagementcore/workorders/Sample001

Modificar estado de las Órdenes de Trabajo

PUT /api/mytenant/myorganization/maintenancemanagementcore/workorders/ChangeWorkOrderState

Este método permite modificar el estado de diversas Órdenes de Trabajo. Para ello, hay que introducir el StateResource. En el resource se introducen la clave natural de WorkOrder (EntityKey), la clave natural del estado (NewState), el motivo de la modificación (usado solo cuando se rechaza (reason) y la fecha de la transición de estado (StateChangeDate). Ejemplo: { "StateLines" : [ { "EntityKey" : "OT0004", "NewState" : "003.WORKORDER", "Reason" : "TESTE", "StateChangeDate" : "2015-07-27T11:15:17.477+00:00", }, { "EntityKey" : "OT0005", "NewState" : "003.WORKORDER", "Reason" : "TESTE3", "StateChangeDate" : "2015-07-27T11:15:17.477+00:00", } ] }

Tabla de Estados de la Orden de Trabajo

Estos son los estados disponibles por defecto para las OT. Para obtener los estados configurados hay que usar el método descrito en "Obtener Lista de Estados de las OT".

Código Estado
001 Pendiente de Aprobación
002 Pendiente
003 Aprobado
004 En Curso
005 Cancelado
006 Cerrado
007 Ejecutado
008 Suspendido

Modificar campos de la Orden de Trabajo

PUT /api/mytenant/myorganization/maintenancemanagementcore/WorkOrders/UpdateWorkOrderInfo

Este método permite modificar algunos campos de la orden de trabajo; el resource necesario se indica a continuación:

  • WorkOrderKey: La clave de la OT
  • Description: La descripción de la OT
  • WorkOrderTypeKey: La clave del tipo de la OT
  • WorkCenterKey: La clave del centro de trabajo de la OT
  • AssetKey: La clave del activo asociado a la OT
  • LocationKey: La clave de la localización asociada a la OT
  • PriorityLevelKey: La clave del nivel de prioridad del solicitante de la OT
  • OperatingConditionKey: La clave del estado de funcionamiento de la OT
  • Remarks: Las observaciones de la OT
  • MaintenancePlanKeys: La lista de clave de los planes de mantenimiento de la OT
  • Date: La fecha de creación de la OT

Ejemplo: { "WorkOrderKey" : "WO000020", "Description" : "Mudar o óleo.", "WorkOrderTypeKey" : "CR", "WorkCenterKey" : "MN", "AssetKey" : "A-00012", "LocationKey" : "", "PriorityLevelKey" : "N", "OperatingConditionKey": "DS" "Remarks" : "", "MaintenancePlanKeys": ["MP-00002.1", "MP-00003.1"], "Date": "2017-08-31T11:15:17.477+00:00"
}

Obtener Lista de Estados de las OT

GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderStates?version=AAAA

Este método permite obtener la lista de estados de las OT. Para esta lista solo es necesario el filtro Version.

Obtener el detalle de la Información de la OT

A través del siguiente método puede obtenerse el detalle de la información sobre la OT:

  • Consumos
  • Mano de Obra
  • Contadores
  • Monitorizaciones
  • Otros Costes

Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrderReportInfo?workOrderKey=OT0040

Obtener el número de órdenes de trabajo asignadas por estado

A través del siguiente método puede obtenerse el número de órdenes de trabajo asignadas por estado, usando los siguientes parámetros:

  • assignedTo – asignadas al técnico.
  • version

devuelve la lista y el número de órdenes de trabajo asignadas, agrupadas por estado. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/GetWorkOrdersAssignedByStates?assignedTo=admin&version=AAAA

Campos de Usuario

A través de los siguientes métodos, puede obtenerse los campos de usuario y modificarse los valores sin editar la OT directamente. Lista de campos de usuario: Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/getuserfields GET /api/mytenant/myorganization/maintenancemanagementcore/workorders/getuserfields?workorderkey=WO0001
El método sin parámetros devuelve los campos de usuario asociados a la entidad Orden de Trabajo con valores por defecto o vacíos. El método con parámetro devuelve la lista de campos de usuario y valores correspondientes para la OT indicada.   Modificar valores de campos de usuario: Ejemplo: PUT /api/mytenant/myorganization/maintenancemanagementcore/workorders/updateuserfields?workOrderKey=WO0001
[ { "Name": "USER_CHAVEALT", "Value": "xxx1" }, { "Name" : "USER_CONTABILIDAD", "Value" : false } ]   Este método actualiza los valores de los campos de usuario de la OT. Debe usarse el nombre devuelto por el método anterior. Los tipos de campo compatibles por este método son: Texto Breve (20), Texto (100), Texto Largo (255), Booleano, Fecha, Fecha y Hora, Número, Decimal, Porcentaje, Correo electrónico, URL.

Tags:

¿Fue útil?