Webapi

WebAPI – Registo de Consumos

112 views 28 Abril, 2017 8 Fevereiro, 2018 Valuekeep 0

Este serviço permite a obtenção e manipulação de Consumos no Valuekeep.

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

Obter Registos de Consumo

GET /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions/GetWorkOrderReportConsumptionByFilter

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

  • StateKey: Lista de estados (verificar valores em Criar uma Ordem de Trabalho na secção Estados, apenas a parte numérica da chave natural)
  • CreatedBy: Login do utilizador do funcionário que criou o registo de consumo
  • WorkOrderKey: Pelo código de uma Ordem de Trabalho
  • MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
  • Version: Versão
  • WOResponsible: Responsável da OT
  • WCResponsible: Responsável do Centro de Trabalho
  • WOOrWCResponsible: Responsável da OT ou do Centro de Trabalho

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

Exemplos:

GET /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions/GetWorkOrderReportConsumptionByFilter?stateKey=001&stateKey=002&maxRecords=50&createdBy=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 registos de consumo das ordens de trabalho nos estados “Pendente” e “Aguarda Aprovação”, registados pelo funcionário com o login “myuser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions/GetWorkOrderReportConsumptionByFilter?workorderkey=WO001

Obtém os registos de consumo para a OT “WO001”.

Criar Registo de Consumo

POST /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions

Este método permite criar um Registo de Consumo para uma determinada Ordem de Trabalho. O “corpo” da mensagem deve ser preenchido com a estrutura do recurso WorkOrderReportConsumptionResource.

Exemplo:

{
“Description”: “Consumo Exemplo”,
“ReportDate”: “2017-03-20T00:33:47.4007+00:00”,
“WorkOrder”: “WO4237”,
“Location”: null,
“Asset”: “SSPDF P0”,
“WorkOrderTaskReportConsumptions”:
[
{
“Date”: “2017-03-20T00:33:37.3937668+00:00”,
“Quantity”: 1,
“Remarks”: “”,
“MaintenancePlan”: “LIMPTAP-000012.1”,
“Warehouse”: “A1”,
“Unit”: “UN”,
“Task”: “EC.3”,
“Item”: “A0001”
}
],
“Currency”: “EUR”,
“Company”: “ORG1”,
“ReportingExchangeRate”: 0,
“CostCenter”: null,
“Remarks”: “Sem observações.”
}

Alterar Registo de Consumo

PUT /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions?sequencekey=<sequencekey>

Este método permite alterar registos de consumo da ordem de trabalho. O valor de <sequencekey> deve ser o identificador do registo de consumo e o “corpo” da mensagem deve ser preenchido com a estrutura do recurso WorkOrderReportConsumption.

Exemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/workorderreportconsumptions?sequencekey=I00002

{
“SequenceKey”: “I00002”,
“Description”: “1112”,
“ReportDate”: “2017-03-17T18:22:47.0205025+00:00”,
“IsPrinted”: null,
“StockIssueEmitted”: true,
“ExchangeRate”: 1,

}

Este pedido serve para atualizar o registo de consumo com a SequenceKey “I00002”.
Após o pedido, o recurso devolvido tem o valor do campo “Version” atualizado.

Tags:

Foi útil?