Webapi

WebAPI – Registo de Pedidos Internos

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

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

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

Obter Pedidos Internos

GET /api/mytenant/myorganization/maintenancemanagementcore/internalrequestextendeds/GetInternalRequestsByFilter

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

  • StateKey: Lista de estados (valores em “Tabela de Estados do Pedido Interno”)
  • RequestedBy: Login do utilizador do funcionário que registou o pedido interno
  • MaxRecords: Número máximo de registos (pode pedir no máximo 200 registos de cada vez)
  • WorkOrder: Código de uma Ordem de Trabalho
  • AssignedTo: Login do utilizador do funcionário atribuído à ordem de trabalho
  • Version: Versão do Pedido Interno
  • InternalRequest: Código de um Pedido Interno

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

Exemplos:

GET /api/mytenant/myorganization/maintenancemanagementcore/internalrequestextendeds/GetInternalRequestsByFilter?stateKey=001&stateKey=002&maxRecords=50&requestedBy=myuser&version=AAAAAAAAAAA=

Obtém no máximo 50 pedidos internos 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/internalrequestextendeds/GetInternalRequestsByFilter?workorder=WO001&assignedTo=wouser&version=AAAAAAAAAAA=

Obtém os pedidos internos para a OT “WO001” em que o utilizador atribuído à OT seja o “wouser” e com versão superior a “AAAAAAAAAAA=”.

GET /api/mytenant/myorganization/maintenancemanagementcore/internalrequestextendeds/GetInternalRequestsByFilter?internalrequest=IR.2017.1

Obtém o pedido interno com o código “IR.2017.1”.

Criar Pedido Interno

POST /api/mytenant/myorganization/maintenancemanagementcore/internalrequestextendeds/CreateInternalRequestExtended

Este método permite criar pedidos internos. O corpo da mensagem deve ser preenchido com a estrutura do recurso InternalRequestExtended.

Exemplo:

{
“SerieNaturalKey”: “2017”,
“DocumentTypeNaturalKey”: “PI”,
“DocumentDate”: “2017-03-15T17:32:48.483”,
“Description”: “PI 000001”,
“Remarks”: ” – PI 000001rnrn”,
“IsPrinted”: false,
“Motive”: “”,
“SourceDoc”: “”,
“ExternalId”: “”,
“ExternalVersion”: “”,
“IsExternallyManaged”: false,
“SchemaEntStateNaturalKey”: “006.PI”,
“CompanyNaturalKey”: “TEST_15032017_001”,
“WarehouseNaturalKey”: “A1”,
“RequestedByNaturalKey”: “0002”,
“CostCenterNaturalKey”: null,
“WorkOrderKey”: “”,
“DocumentLines”: [
{
“LineNumber”: 1,
“Description”: “Cadeira QUEEN”,
“Quantity”: 5,
“RequestDate”: “2017-03-15T17:32:48.483”,
“ConversionFactor”: 1,
“Note”: “”,
“OpenQuantity”: 0,
“DeliveryDate”: “2017-03-15T17:32:48.483”,
“OriginalQuantity”: 5,
“Motive”: “”,
“BaseUnitNaturalKey”: “UN”,
“SchemaEntStateNaturalKey”: “006.PI”,
“PurchaseItemNaturalKey”: “A0001”,
“UnitNaturalKey”: “UN”,
“UserFields”: [],
“Index”: 1
}
]
}

O método devolve a lista de pedidos internos criados.

Os campos SerieNaturalKey, DocumentTypeNaturalKey e DocumentDate são opcionais e serão preenchidos com valores predefinidos caso estejam vazios.

Lista de Estados dos Pedidos Internos

GET /api/mytenant/myorganization/maintenancemanagementcore/internalrequestextendeds/GetInternalRequestStates

Este método permite obter a lista de estados dos pedidos internos. Para esta lista não é necessário nenhum filtro.

Tabela de Estados do Pedido Interno

Código Estado
001  Aguarda Aprovação
002  Rascunho
003  Aprovado
004  Rejeitado
005  Cancelado
006  Fechado
Tags:

Foi útil?