Webapi

WebAPI – Manutenção Preventiva

101 views 31 Julho, 2017 3 Setembro, 2018 Valuekeep 0

Este serviço permite a obtenção e manipulação de Manutenções Preventivas no Valuekeep.

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

Obter Lista de Eventos da Manutenção Preventiva

GET /api/mytenant/myorganization/maintenancemanagementcore/Projections/GetProjectionsByFilter

Este método permite obter uma lista de Eventos da Manutenção Preventiva, aplicando vários filtros. Pode obter a lista de Eventos da Manutenção Preventiva filtrada por:

  • StateKey: Lista de estados da ordem de trabalho (valores em “Tabela de Estados da Ordem de Trabalho”).
  • Year: Ano da data prevista dos eventos, são apresentados todos os eventos da manutenção preventiva cujo ano seja superior ao colocado no filtro.
  • DaysLimit: Número de dias anteriores à data prevista dos eventos a considerar na lista.
  • Version: Versão.
  • MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez).
  • PMResponsible: Login do utilizador responsável da manutenção preventiva.
  • WCResponsible: Login do utilizador responsável do centro de trabalho.
  • PMOrWCResponsible: Responsável da Manutenção Preventiva ou do Centro de Trabalho
  • HasWorkOder: Filtro do tipo booleano que define se retorna eventos com ou sem ordens de trabalho associadas. Por omissão este filtro tem o valor “false“.

Todos os filtros são opcionais. A lista de Eventos da Manutenção Preventiva devolvida está ordenada por versão em ordem crescente.

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/Projections/GetProjectionsByFilter?maxRecords=50&hasWorkOrder=true&stateKey=004&mpresponsible=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 registos de Eventos da Manutenção Preventiva que tenham ordem de trabalho associada e no estado “Em Curso”, em que o responsável da manutenção preventiva seja o funcionário com login “myuser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/Projections/GetProjectionsByFilter?maxRecords=50&daysLimit=30&version=AAAAAAAAAAA=

Obtém no máximo 50 registos de Eventos da Manutenção Preventiva que tenham data prevista 30 dias anteriores à data atual e com versão superior a “AAAAAAAAAAA=”.

Exemplo de funcionamento do filtro “DaysLimit”
Data atual: 28/07/2017
DaysLimit: 30 dias
Com esta definição, serão apresentados todos os eventos com data prevista superior à data 28/06/2017 (são subtraídos 30 dias à data atual).

Obter Evento da Manutenção Preventiva

GET /api/mytenant/myorganization/maintenancemanagementcore/Projections/GetProjectionByNaturalKey

Este método permite obter um evento da Manutenção Preventiva, utilizando o seguinte parâmetro:

  • NaturalKey: Composta pela chave da Manutenção Preventiva mais o evento (PM000002.4.151).

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/Projections/GetProjectionByNaturalKey?naturalKey=PM000002.4.151

Este pedido irá devolver o evento “151” da manutenção preventiva com a chave “PM000002.4” do tipo  ProjectionResource.

Criar Ordens de Trabalho a partir de Eventos da Manutenção Preventiva

PUT /api/mytenant/myorganization/maintenancemanagementcore/Projections/CreateWorkOrdersFromProjections

Este método permite criar ordens de trabalho a partir de Eventos da Manutenção Preventiva. O “corpo” da mensagem deve ser preenchido com a estrutura do recurso PreventiveProjectionsResource.

 

Exemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/Projections/CreateWorkOrdersFromProjections

{
“PreventiveMaintenanceKey” : “PM000010.1”,
“StateKey” : “004”,
“Events” : [
{“EventNumber” : “2”},
{“EventNumber” : “3”}
]
}

Este pedido serve para criar ordens de trabalho, e colocar as mesmas no estado em curso (“004”), para os eventos “2” e “3” da manutenção preventiva com a chave “PM000010”.
Após o pedido, o recurso devolvido tem as chaves das ordens de trabalho criadas para cada evento.

Os eventos que já tenham ordem de trabalho associada são ignorados.
O “StateKey” corresponde ao estado em que serão colocadas as ordens de trabalho criadas.

Alterar a data prevista de um evento de manutenção preventiva

PUT /api/mytenant/myorganization/maintenancemanagementcore/Projections/ChangeProjectionDate?naturalKey=PMKey&expectedDate=expDate

Este método permite alterar a data prevista de um evento de manutenção preventiva.

Exemplo:

PUT /api/mytenant/myorganization/maintenancemanagementcore/Projections/ChangeProjectionDate?naturalKey=PM000001.3.15&expectedDate=2018-07-30T09:55%2B01:00

Este pedido serve para alterar a data prevista, para o evento “15” da manutenção preventiva com a chave “PM000001”.
Após o pedido, é devolvido uma estrutura do tipo ProjectionResource.

O campo “expectedDate” terá de ser enviado codificado em UTF-8 , substituindo o “+” pelo código HEX “%2B”
Tags:

Foi útil?