Webapi

WebAPI – Controlos de Condição e Valores de Controlo de Condição

106 views 28 Abril, 2017 28 Fevereiro, 2018 Valuekeep 0

Este serviço permite a obtenção e manipulação de Controlos de Condição e Valores de Controlo de Condição no Valuekeep.

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

Lista de Controlos de Condição

GET /api/mytenant/myorganization/maintenancemanagementcore/monitorings/GetMonitoringsByVersionAndRecords?version=AAAA&maxRecords=2000

Este método permite obter a lista de controlos de condição. 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/monitorings/GetMonitoringsByVersionAndRecords?version=AAAAAAAAAAA=&maxRecords=200

Obtém no máximo 200 controlos de condição com versão superior a “AAAAAAAAAAA=”.

Obter Valores de Controlo de Condição

 GET /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/GetMonitoringValuesByFilter

Este método permite obter a lista de valores de controlos de condição, 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 controlos de condição 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 controlos de condição associados a esta OT.
  • AssetKey: Código do Ativo. São devolvidos os valores de controlos de condição associados a este ativo.
  • LocationKey: Código da Localização. São devolvidos os valores de controlos de condição associados a esta localização.
  • MonitoringKey: Código do Valor do Controlo de Condição. São devolvidos os valores deste controlo de condição.

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/monitoringvalues/GetMonitoringValuesByFilter?stateKey=001&stateKey=002&maxRecords=50&assignedTo=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 valores de controlos de condição 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/monitoringvalues/GetMonitoringValuesByFilter?workorderkey=WO001

Obtém os valores de controlos de condição para a OT “WO001”.

Criar Valores de Controlo de Condição

POST /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues

Este método permite criar valores de controlos de condição para um determinado controlo de condição. O “corpo” da mensagem deve ser preenchido com a estrutura do recurso MonitoringValueResource.

Exemplo:

{
“Date”: “2017-04-05T09:54:12.8997517+01:00”,
“Value”: 100,
“MovingAverage”: null,
“Notes”: “”,
“MonitoringAssetKey”: “”,
“MonitoringLocationKey”: “”,
“Monitoring”: “AC-0001”,
“Issue”: null,
“Notification”: null,
“WorkOrder”: “OT0018”,
“UserFields”: []
}

Alterar Valores de Controlo de Condição

PUT /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/{id}

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

Exemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/8badd58e-ae1a-e711-9d09-c01885a63e51

{
“ReadingNumber”: 2,
“Date”: “2017-04-06T09:54:12.8997517+01:00”,
“Value”: 120,
“MovingAverage”: null,
“Notes”: “”,
“MonitoringAssetKey”: “”,
“MonitoringLocationKey”: “”,
“Monitoring”: “MN-0003”,
“Notification”: null,
“UserFields”: [],
“Id”: “8badd58e-ae1a-e711-9d09-c01885a63e51”
}

Este pedido serve para atualizar o registo de valores do controlo de condição com o identificador “8badd58e-ae1a-e711-9d09-c01885a63e51”.
Após o pedido, o recurso devolvido tem o valor do campo “Version” atualizado.

Tags:

Foi útil?