Webapi

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesByFilter

Este método permite obter uma lista de Ocorrências, aplicando vários filtros. Pode obter esta lista filtrada por:

• StateKey: Lista de estados (valores em “Tabela de Estados da Ocorrência”)
• MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
• DaysLimit: Número máximo de dias desde a data de criação da Ocorrência
• Issuer: Login do utilizador do funcionário que registou a Ocorrência
• Version: Versão
• Responsible: Responsável do ativo, da localização ou da rota
• WOResponsible: Responsável da OT
• WCResponsible: Responsável do Centro de Trabalho
• WOOrWCResponsible: Responsável da OT ou do Centro de Trabalho
• CreatedBy: Login do utilizador que criou a OT

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

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesByFilter?stateKey=001&stateKey=002&maxRecords=50&daysLimit=30&issuer=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 ocorrências nos estados “Aguarda Aprovação” e “Aprovado”, criadas nos últimos 30 dias, registadas pelo funcionário com login “myuser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesSLAByFilter

Este método permite obter uma lista de SLA de Ocorrências, aplicando vários filtros. Pode obter a lista de SLA de Ocorrências filtrada por:

• StateKey: Lista de estados (valores em “Tabela de Estados da Ocorrência”)
• MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
• issueKey: Pela chave da Ocorrência.
• Issuer: Login do utilizador do funcionário que registou a Ocorrência
• Version: Versão
• DaysLimit:  Número máximo de dias desde a criação da ocorrência.
• Year: Ano das ocorrências. Aparecem todos os registos de ocorrências cujo ano seja igual ou superior ao colocado no filtro.
• Responsible: Login do utilizador responsável do ativo da ocorrência.

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

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/Issues/GetIssuesSLAByFilter?stateKey=001&stateKey=002&maxRecords=50&issuer=myuser&version=AAAAAAAAAAA=

Obtém no máximo 200 registos de SLA de Ocorrências nos estados “Aguarda Aprovação” e “Aprovado”, registadas pelo funcionário com login “myuser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfIssues/GetResponseTimesOfIssuesByFilter

Este método permite obter uma lista de Tempos de Resposta das Ocorrências, aplicando vários filtros. Pode obter a lista de Tempos de Resposta das Ocorrências filtrada por:

• StateKey: Lista de estados (valores em “Tabela de Estados da Ocorrência”)
• MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
• issueKey: Pela chave da Ocorrência.
• Issuer: Login do utilizador do funcionário que registou a Ocorrência
• Version: Versão
• DaysLimit:  Número máximo de dias desde a criação da ocorrência.
• Year: Ano das ocorrências, aparecem todos os registos de ocorrências cujo ano seja superior ao colocado no filtro.
• Responsible: Login do utilizador responsável do ativo da ocorrência.

Todos os filtros são opcionais. A lista de Tempos de Resposta das Ocorrências devolvida está ordenada por versão em ordem crescente.

Exemplo:

GET /api/mytenant/myorganization/maintenancemanagementcore/ResponseTimesOfIssues/GetResponseTimesOfIssuesByFilter?stateKey=001&stateKey=002&maxRecords=50&issuer=myuser&version=AAAAAAAAAAA=

Obtém no máximo 200 registos de Tempos de Resposta das Ocorrências nos estados “Aguarda Aprovação” e “Aprovado”, registadas pelo funcionário com login “myuser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/issues/GetIssueStates?version=AAAA

Este método permite obter a lista de estados das ocorrências. Para esta lista apenas é necessário o filtro Version.

GET /api/mytenant/myorganization/maintenancemanagementcore/issues/GetIssueStateTransitions?version=AAAA

Este método permite obter a lista de transições de estados das ocorrências. Para esta lista apenas é necessário o filtro Version.

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueState

Este método permite mudar o estado de várias ocorrências. Para isso é necessário preencher a StateResource. A resource é preenchida com a Chave Natural da ocorrência (EntityKey), a chave natural do estado (NewState), razão da alteração (apenas utilizada quando é rejeitado (reason)), e a data de transição de estado (StateChangeDate).

Exemplo:
{
“StateLines” : [
{
“EntityKey” : “000001”,
“NewState” : “006.ISSUE”,
“Reason” : “To executed”,
“StateChangeDate” : “2017-03-27T11:15:17.477+00:00”,
},
{
“EntityKey” : “000002”,
“NewState” : “005.ISSUE”,
“Reason” : “To in progress”,
“StateChangeDate” : “2017-03-27T11:15:17.477+00:00”,
}
]
}

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueStateAndGenerate?issueKey=IS000020

Este método permite mudar o estado de uma ocorrência com opção de gerar uma ordem de trabalho. Para isso é necessário preencher a IssueToGenerateResource.

A resource é preenchida com a Chave Natural da ocorrência (IssueKey), a chave natural do estado (NewState), razão da alteração (apenas utilizada quando é rejeitado (Reason)), a data de transição de estado (StateChangeDate), e os restantes campos necessários para a criação da Ordem de Trabalho, a chave natural do plano de manutenção (MaintenancePlanKey), a chave do centro de trabalho (WorkCenterKey), a chave do tipo de ordem de trabalho (WorkOrderTypeKey), a definição se deve criar a ordem de trabalho e o estado em que essa ordem de trabalho deve ficar.

Quando na resource o campo da chave natural do ativo (AssetKey) ou o campo da chave natural da localização (LocationKey) está preenchido, a ocorrência é atualizada para o ativo ou a localização preenchida.

Exemplo:
{
“IssueKey” : “IS000020”,
“NewState” : “002.ISSUE”,
“Reason” : “Approve Issue.”,
“StateChangeDate” : “2017-08-09T11:26:18.477+00:00”,
“MaintenancePlanKey” : “MP-000001.1”,
“WorkCenterKey” : “MN”,
“WorkOrderTypeKey” : “CR”,
“AssetKey”: “”,
“LocationKey”: “L0001”,
“CreateWorkOrder” : true,
“WorkOrderStateToCreate”: “001.WORKORDER”
}

PUT /api/mytenant/myorganization/maintenancemanagementcore/issues/ChangeIssueRate?IssueKey={issueKey}

Este método permite mudar a classificação de uma ocorrência. Para isso é necessário preencher a IssueRateResource. A resource é preenchida com a Chave Natural da ocorrência (IssueKey), a classificação da ocorrência e as observações da classificação da ocorrência.

Exemplo:
{
“IssueKey” : “IS000007”,
“Rate” : “5”,
“RateRemarks” : “A Ocorrência foi corretamente resolvida.”
}

Estes são os estados disponíveis por omissão para as ocorrências. Para obter os estados configurados para as ocorrências use o método descrito em “Obter Lista de Estados das Ocorrências”.

POST /api/mytenant/myorganization/maintenancemanagementcore/Issues/CreateIssue

Este método permite criar ocorrências; a resource necessária é descrita abaixo:

• IssueTypeKey: A chave do Tipo de Ocorrência
• Description: A descrição da Ocorrência
• PriorityLevelKey: A chave do nível de prioridade do requisitante da Ocorrência
• ApprovedPriorityLevelKey: A chave do nível de prioridade do aprovador da Ocorrência
• IssueDate: A data da Ocorrência
• AssetKey: A chave do ativo associado à Ocorrência
• LocationKey: A chave da localização associada à Ocorrência
• IssuerKey: A chave do requisitante da Ocorrência
• Remarks: As observações da Ocorrência

Exemplo:

{

“IssueTypeKey” : “EE”,
“Description” : “The TV doesn’t work.”,

“PriorityLevelKey” : “N”,
“IssueDate” : “2017-08-09T11:26:18.477+00:00”,
“AssetKey” : “A-00012”,
“LocationKey” : “”,
“Remarks”: “Need it fixed ASAP.”
}

PUT /api/mytenant/myorganization/maintenancemanagementcore/Issues/UpdateIssueInfo

Este método permite alterar alguns campos da ocorrência; a resource necessária é descrita abaixo:

• IssueKey: A chave da Ocorrência
• Description: A descrição da Ocorrência
• IssueDate: A data da Ocorrência
• IssueTypeKey: A chave do Tipo de Ocorrência
• AssetKey: A chave do ativo associado à Ocorrência
• LocationKey: A chave da localização associada à Ocorrência
• PriorityLevelKey: A chave do nível de prioridade do requisitante da Ocorrência
• Remarks: As observações da Ocorrência

Exemplo:

{
“IssueKey” : “IS000020”,
“Description” : “The TV doesn’t work.”,
“IssueDate” : “2017-08-09T11:26:18.477+00:00”,
“IssueTypeKey” : “EE”,
“AssetKey” : “A-00012”,
“LocationKey” : “”,
“PriorityLevelKey” : “N”,
“Remarks”: “Need it fixed ASAP.”
}