Webapi

WebAPI – Contadores e Valores de Contador

137 views 28 Abril, 2017 10 Abril, 2018 Valuekeep 0

Este serviço permite a obtenção e manipulação de Contadores e Valores de Contador no Valuekeep.

De seguida é apresentada uma análise dos métodos disponibilizados pelo serviço.

Lista de Contadores

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

Este método permite obter a lista de contadores. Pode obter a lista filtrada por:

  • Version: Versão
  • MaxRecords: Opcional. Número máximo de registos a devolver (se não for definido, por omissão devolve 2000 registos)

Exemplo:

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

Obtém no máximo 200 contadores com versão superior a “AAAAAAAAAAA=”.

Obter Valores de Contador

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

Este método permite obter a lista de valores de contadores, aplicando vários filtros. Pode obter a lista filtrada por:

  • Version: Versão miníma a partir da qual será retornada a lista
  • MaxRecords: Número máximo de registos (podem ser pedidos no máximo 200 registos de cada vez)
  • StateKey: Lista de estados (verificar valores em Criar uma Ordem de Trabalho na secção Estados, apenas a parte numérica da chave natural)
  • AssignedTo: Login do utilizador do funcionário. São devolvidos os valores de contadores associados a OTs com tarefas atribuídas a este funcionário.
  • WorkOrderKey: Código de uma Ordem de Trabalho. São devolvidos os valores de contadores associados a esta OT.
  • AssetKey: Código do Ativo. São devolvidos os valores de contadores associados a este ativo.
  • LocationKey: Código da Localização. São devolvidos os valores de contadores associados a esta localização.
  • MeterKey: Código do Contador. São devolvidos os valores deste contador.

Todos os filtros são opcionais. A lista de valores devolvida está ordenada por versão em ordem crescente.

Exemplos:

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

Obtém no máximo 50 valores de contador para OTs nos estados “Pendente” e  “Aguarda Aprovação”, registados para o funcionário com o login “myuser” e com versão superior a “AAAAAAAAAAA=”.

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

Obtém os valores de contador para a OT “WO001”.

Criar Valores de Contador

POST /api/mytenant/myorganization/maintenancemanagementcore/metervalues

Este método permite criar valores de contador para um determinado contador. O “corpo” da mensagem deve ser preenchido com a estrutura do recurso MeterValueResource.

Exemplo:

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

Alterar Valores de Contador

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

Este método permite alterar registos de valores de contadores. O valor de <id> deve ser o identificador do registo de valores de contador e o “corpo” da mensagem deve ser preenchido com a estrutura do recurso MeterValueResource.

Exemplo:

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”
}

Este pedido serve para atualizar o registo de valores de contadores com o identificador “ab5b8fbe-2916-e711-9d08-c01885a63e51”.
Após o pedido, o recurso devolvido tem o valor do campo “Version” atualizado.

Códigos dos Tipos de Contador

Os métodos da WebAPI dos contadores utilizam os seguintes códigos para os tipos de contadores:

Chave Descrição
1 Leitura
2 Incremento
Tags:

Foi útil?