Webapi

WebAPI – Registo de Mão de Obra

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

Este serviço permite a obtenção e manipulação de Registos de Mão de Obra das OTs no Valuekeep.

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

Obter Registos de Mão de Obra

GET /api/mytenant/myorganization/maintenancemanagementcore/laborreports/GetWorkOrdersLaborReportsByFilter

Este método permite obter a lista de registos de mão de obra, 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)
  • MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
  • WorkOrder: Pelo código de uma Ordem de Trabalho
  • AssignedTo: Login do utilizador do funcionário atribuído no registo da mão de obra
  • 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 mão de obra devolvida está ordenada por versão em ordem crescente. Se definir o filtro por utilizador, apenas são devolvidos os registos de mão de obra atribuídos ao funcionário desse utilizador.

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/laborreports/GetWorkOrdersLaborReportsByFilter?stateKey=001&stateKey=002&maxRecords=50&workorder=WO001&assignedTo=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 registos de mão de obra nos estados “Pendente” e “Aguarda Aprovação”, atribuídos ao funcionário com o login “myuser” e com versão superior a “AAAAAAAAAAA=”.

Criar Registo de Mão de Obra

POST /api/mytenant/myorganization/maintenancemanagementcore/laborreports

Este método permite criar registos de mão de obra para tarefas da ordem de trabalho. O corpo da mensagem deve ser preenchido com a estrutura do recurso LaborReport.

Exemplo:

{
“Date” : “2017-03-08”,
“IsDone” : “true”,
“Hours” : “4”,
“AppName” : “”,
“StartDate” : “2017-03-08T10:00:00+00:00”,
“EndDate” : “2017-03-08T14:00:00+00:00”,
“Remarks” : “observações sobre este registo”,
“Employee” : “0002”,
“Expertise” : “”,
“Skill” : “”,
“WorkOrder” : “OT0009”,
“Asset” : “CHLL 001”,
“Location” : “”,
“MaintenancePlan” : “PM-000001.1”,
“Task” : “T-000002”,
“UnderContract” : “false”
}

O método devolve a lista de registos criados, incluindo o rateio do registo pelas tarefas da OT. O campo WorkOrderReportLabor devolve a chave do documento de registo, e o campo TaskReportId o identificador da linha do registo.

Os campos StartDate e EndDate são opcionais. Caso sejam especificados, o número de horas não pode ser superior à diferença entre estas duas datas. O plano de manutenção e a tarefa também são opcionais, se não forem definidos será feito o rateio para todas as tarefas da OT ou do plano, respetivamente. Se for preenchido, o valor de AppName deve corresponder a uma aplicação autorizada a fazer registos de mão de obra com este método.

Alterar Registo de Mão de Obra

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

Este método permite alterar registos de mão de obra para tarefas da ordem de trabalho. O valor de <id> deve ser o identificador do registo e o corpo da mensagem deve ser preenchido com a estrutura do recurso LaborReport.

Exemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/laborreports/4b1c176f-1308-e711-9cee-3ca9f42265f4

{
“TaskReportId”: “4b1c176f-1308-e711-9cee-3ca9f42265f4”,
“Date”: “2017-02-27T00:00:00”,
“IsDone”: true,
“Hours”: 1,
“AppName”: “”,
“StartDate”: null,
“EndDate”: null,
“Remarks”: “observações do registo”,
“Employee”: “0007”,
“WorkOrder”: “OT0008”,
“Asset”: “”,
“Location”: “PISO 0”,
“MaintenancePlan”: “MP-000001.1”,
“Task”: “T-000002”,
“WorkOrderReportLabor”: “L00019”,
“Expertise”: “”,
“Skill”: “”,
“Id”: “4b1c176f-1308-e711-9cee-3ca9f42265f4”,
“IsActive”: true,
“IsDeleted”: false,
“Version”: “AAAAAAAAw1g=”
}

Após o pedido, o recurso devolvido tem o valor do campo “Version” atualizado.

Tags:

Foi útil?