Webapi

WebAPI – Contadores y Valores de Contador

54 views 28 April, 2017 10 April, 2018 Valuekeep 0

Este servicio permite obtener y modificar los Contadores y los Valores de Contador en Valuekeep.

A continuación, se muestra un análisis de los métodos disponibles en el servicio.

Lista de Contadores

GET /api/mytenant/myorganization/maintenancemanagementcore/meters/GetMetersByVersionAndRecords?version=AAAA&maxRecords=2000

Este método permite obtener la lista de contadores. La lista puede filtrarse por:

  • Version: Versión
  • MaxRecords: Opcional. Número máximo de registros que se devuelven (si no se define, por defecto devuelve 2000 registros)

Ejemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/meters/GetMetersByVersionAndRecords?version=AAAAAAAAAAA=&maxRecords=200

Se obtienen como máximo 200 contadores con una versión superior a la “AAAAAAAAAAA=”.

Obtener Valores de Contador

GET /api/mytenant/myorganization/maintenancemanagementcore/metervalues/GetMeterValuesByFilter

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

  • Version: Versión mínima a partir de la que se devuelve la lista
  • MaxRecords: Número máximo de registros (puede solicitarse un máximo de 200 registros al mismo tiempo)
  • StateKey: Lista de estados (comprobar valores en Crear una Orden de Trabajo en la sección Estados, solo la parte numérica de la clave natural)
  • AssignedTo: Login del usuario del trabajador. Se devuelven los valores de contadores asociados a las OT con tareas asignadas a este trabajador.
  • WorkOrderKey: Código de una Orden de Trabajo. Se devuelven los valores de contadores asociados a esta OT.
  • AssetKey: Código del Activo. Se devuelven los valores de contadores asociados a este activo.
  • LocationKey: Código de la Localización. Se devuelven los valores de contadores asociados a esta localización.
  • MeterKey: Código del Contador. Se devuelven los valores de este contador.

Todos los filtros son opcionales. La lista de valores que se devuelve está ordenada por versión y por orden creciente.

Ejemplos:

GET /api/mytenant/myorganization/maintenancemanagementcore/metervalues/GetMeterValuesByFilter?stateKey=001&stateKey=002&maxRecords=50&assignedTo=myuser&version=AAAAAAAAAAA=

Se obtienen como máximo 50 valores de contador para OT en los estados “Pendiente” y “Pendiente de Aprobación”, registrados para el trabajador con el login “myuser” y con una versión superior a la “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/metervalues/GetMeterValuesByFilter?workorderkey=WO001

Se obtienen los valores de contador para la OT “WO001”.

Crear Valores de Contador

POST /api/mytenant/myorganization/maintenancemanagementcore/metervalues

Este método permite crear valores de contador para un determinado contador. En el “cuerpo” del mensaje debe introducirse la estructura del recurso MeterValueResource..

Ejemplo:

{
“Date”: “2017-03-24T00:00:00+00:00”,
“IncrementValue”: 155,
“MeterReading”: 0,
“Meter”: “ASSET-0003”,
“WorkOrder”: null,
“Notes”: null
}

Modificar Valores de Contador

PUT /api/mytenant/myorganization/maintenancemanagementcore/metervalues/<id>

Este método permite modificar registros de valores de contadores. El valor de <id> debe ser el identificador del registro de valores de contador y en el “cuerpo” del mensaje debe introducirse la estructura del recurso MeterValueResource.

Ejemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/metervalues/ab5b8fbe-2916-e711-9d08-c01885a63e51

{
“ReadingNumber”: 12,
“Date”: “2017-03-22T00:00:00+00:00”,
“MeterCumulativeReading”: 5945.35,
“IncrementValue”: 300,
“MeterReading”: 5945.35,
“Notes”: null,
“TotalCost”: 0,
“TotalCostBase”: 0,
“TotalCostReporting”: 0,
“UnitCost”: 0,
“UnitCostBase”: 0,
“UnitCostReporting”: 0,
“Meter”: “CA-0001”,
“Origin”: 1,
“ParentMeterValue”: null,
“WorkOrder”: “OT0019”,
“UserFields”: [],
“Id”: “ab5b8fbe-2916-e711-9d08-c01885a63e51”
}

Esta solicitud sirve para actualizar el registro de valores de contadores con el identificador “ab5b8fbe-2916-e711-9d08-c01885a63e51”.
Después de la solicitud, el recurso que se devuelve tiene el valor del campo “Version” actualizado.

Códigos de los Tipos de Contador

Los métodos de WebAPI de los contadores usan los siguientes códigos para los tipos de contadores:

Clave Descripción
1 Lectura
2 Aumento
Tags:

Foi útil?