Webapi

WebAPI – Incidencias

49 views 30 June, 2017 3 February, 2020 Valuekeep 0

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

Obtener Lista de Incidencias

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesByFilter Este método permite obtener una lista de las Incidencias, aplicando diversos filtros. Esta lista puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la Incidencia")
  • 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 Incidencia
  • Issuer: Login de usuario del trabajador que registró la Incidencia
  • Version: Versión
  • Responsible: Responsable por el activo, la localización o la ruta
  • 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 Incidencias que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesByFilter?stateKey=001&stateKey=002&maxRecords=50&daysLimit=30&issuer=myuser&version=AAAAAAAAAAA= Se obtienen como máximo 50 incidencias en los estados "Pendiente de Aprobación" y "Aprobado", creadas en los últimos 30 días, registradas por el trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

Obtener Lista de SLA de las Incidencias

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesSLAByFilter Este método permite obtener una lista de SLA de las Incidencias, aplicando diversos filtros. La lista de SLA de las Incidencias puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la Incidencia")
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • issueKey: Por la clave de la Incidencia.
  • Issuer: Login de usuario del trabajador que registró la Incidencia
  • Version: Versión
  • DaysLimit: Número máximo de días desde la creación de la incidencia.
  • Year: Año de las incidencias. Surgen todos los registros de incidencias cuyo año es igual o superior al indicado en el filtro.
  • Responsible: Login del usuario responsable por el activo de la incidencia.

Todos los filtros son opcionales. La lista de SLA de las Incidencias que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesSLAByFilter?stateKey=001&stateKey=002&maxRecords=50&issuer=myuser&version=AAAAAAAAAAA= Se obtienen como máximo 200 registros de SLA de Incidencias en los estados "Pendiente de Aprobación" y "Aprobado", registradas por el trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

Obtener Lista de Tiempos de Respuesta de las Incidencias

GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfIssues/GetResponseTimesOfIssuesByFilter Este método permite obtener una lista de los Tiempos de Respuesta de las Incidencias, aplicando diversos filtros. La lista de Tiempos de Respuesta de las Incidencias puede filtrarse por:

  • StateKey: Lista de estados (valores en "Tabla de Estados de la Incidencia")
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • issueKey: Por la clave de la Incidencia.
  • Issuer: Login de usuario del trabajador que registró la Incidencia
  • Version: Versión
  • DaysLimit: Número máximo de días desde la creación de la incidencia.
  • Year: Año de las incidencias, surgen todos los registros de incidencias cuyo año es superior al indicado en el filtro.
  • Responsible: Login del usuario responsable por el activo de la incidencia.

Todos los filtros son opcionales. La lista de Tiempos de Respuesta de las Incidencias que se devuelve está ordenada por versión y por orden creciente. Ejemplo: GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfIssues/GetResponseTimesOfIssuesByFilter?stateKey=001&stateKey=002&maxRecords=50&issuer=myuser&version=AAAAAAAAAAA= Se obtienen como máximo 200 registros de Tiempos de Respuesta de las Incidencias en los estados "Pendiente de Aprobación" y "Aprobado", registradas por el trabajador con login "myuser" y con una versión superior a la "AAAAAAAAAAA=".

Obtener Lista de Estados de las Incidencias

GET /api/mytenant/myorganization/maintenancemanagementcore/issues/GetIssueStates?version=AAAA Este método permite obtener la lista de estados de las incidencias. Para esta lista solo es necesario el filtro Version.

Obtener Lista de Transiciones de Estados de las Incidencias

GET /api/mytenant/myorganization/maintenancemanagementcore/issues/GetIssueStateTransitions?version=AAAA Este método permite obtener la lista de transiciones de estados de las incidencias. Para esta lista solo es necesario el filtro Version.

Modificar Estado de la Incidencia

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueState Este método permite cambiar el estado de diversas incidencias. Para ello, hay que introducir el StateResource. En el resource se introducen la clave natural de la incidencia (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" : "000001", "NewState" : "006.ISSUE", "Reason" : "To executed", "StateChangeDate" : "2017-03-27T11:15:17.477+00:00", }, { "EntityKey" : "000002", "NewState" : "005.ISSUE", "Reason" : "To in progress", "StateChangeDate" : "2017-03-27T11:15:17.477+00:00", } ] }

Modificar Estado de la Incidencia con Orden de Trabajo

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueStateAndGenerate?issueKey=IS000020 Este método permite cambiar el estado de una incidencia con opción de generar una orden de trabajo. Para ello, hay que introducir el IssueToGenerateResource. En el resource se introducen la clave natural de la incidencia (IssueKey), la clave natural del estado (NewState), el motivo de la modificación (usado solo cuando se rechaza (Reason)), la fecha de transición de estado (StateChangeDate) y los demás campos necesarios para crear la Orden de Trabajo, la clave natural del plan de mantenimiento (MaintenancePlanKey), la clave del centro de trabajo (WorkCenterKey), la clave del tipo de orden de trabajo (WorkOrderTypeKey), la definición si se debe crear la orden de trabajo y el estado en el que debe estar esa orden de trabajo. Si en el resource el campo de la clave natural del activo (AssetKey) o el campo de la clave natural de la localización (LocationKey) está introducido, la incidencia se actualiza para el activo o la localización introducida. Ejemplo: { "IssueKey" : "IS000020", "NewState" : "002.ISSUE", "Reason" : "Approve Issue.", "StateChangeDate" : "2017-08-09T11:26:18.477+00:00", "MaintenancePlanKey" : "MP-000001.1", "WorkCenterKey" : "MN", "WorkOrderTypeKey" : "CR", "AssetKey": "", "LocationKey": "L0001", "CreateWorkOrder" : true, "WorkOrderStateToCreate": "001.WORKORDER" }

Modificar Clasificación de la Incidencia

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueRate?IssueKey={issueKey} Este método permite cambiar la clasificación de una incidencia. Para ello, hay que introducir el IssueRateResource. En el resource se introducen la clave natural de la incidencia (IssueKey), la clasificación de la incidencia y las observaciones de la clasificación de la incidencia. Ejemplo: { "IssueKey" : "IS000007", "Rate" : "5", "RateRemarks" : "La Incidencia se ha solucionado correctamente." }

Tabla de Estados de la Incidencia

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

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

Crear Incidencia

POST /api/mytenant/myorganization/maintenancemanagementcore/Issues/CreateIssue Este método permite crear incidencias; el resource necesario se indica a continuación:

  • IssueTypeKey: La clave del Tipo de Incidencia
  • Description: La descripción de la Incidencia
  • PriorityLevelKey: La clave del nivel de prioridad del solicitante de la Incidencia
  • ApprovedPriorityLevelKey: La clave del nivel de prioridad del aprobador de la Incidencia
  • IssueDate: La fecha de la Incidencia
  • AssetKey: La clave del activo asociado a la Incidencia
  • LocationKey: La clave de la localización asociada a la Incidencia
  • IssuerKey: La clave del solicitante de la Incidencia
  • Remarks: Las observaciones de la Incidencia

Ejemplo: { "IssueTypeKey" : "EE", "Description" : "The TV doesn't work.", "PriorityLevelKey" : "N", "IssueDate" : "2017-08-09T11:26:18.477+00:00", "AssetKey" : "A-00012", "LocationKey" : "", "Remarks": "Need it fixed ASAP." }

Modificar campos de la Incidencia

PUT /api/mytenant/myorganization/maintenancemanagementcore/Issues/UpdateIssueInfo Este método permite modificar algunos campos de la incidencia; el resource necesario se indica a continuación:

  • IssueKey: La clave de la Incidencia
  • Description: La descripción de la Incidencia
  • IssueDate: La fecha de la Incidencia
  • IssueTypeKey: La clave del Tipo de Incidencia
  • AssetKey: La clave del activo asociado a la Incidencia
  • LocationKey: La clave de la localización asociada a la Incidencia
  • PriorityLevelKey: La clave del nivel de prioridad del solicitante de la Incidencia
  • Remarks: Las observaciones de la Incidencia

Ejemplo: { "IssueKey" : "IS000020", "Description" : "The TV doesn't work.", "IssueDate" : "2017-08-09T11:26:18.477+00:00", "IssueTypeKey" : "EE", "AssetKey" : "A-00012", "LocationKey" : "", "PriorityLevelKey" : "N", "Remarks": "Need it fixed ASAP." }

Tags:

¿Fue útil?