PUBLICAÇÃO WEB SERVICE REST DO CADASTRO DE MOTIVO DE PARADA(APENAS CONSULTA)

Características do Requisito

Linha de Produto:

Microsiga Protheus

Segmento:

Supply Chain - Agroindústria

Módulo:

SIGAAGR

Rotinas:

Rotina

Nome Técnico

Cadastro de motivo de parada

UBAA110

País:

Brasil

Bancos de Dados:

Todos

Tabelas Utilizadas:

NBP

Sistemas Operacionais:

Todos


Pré-requisito

  No que diz respeito ao sistema, a funcionalidade de integração está funcional. Porém, é necessário configurar o AppServer para que o Protheus disponibilize a URL de acesso ao serviço de Web Service REST do sistema. Uma vez configurado o serviço, a integração está pronta para ser utilizada.

  Para isso, segue link para consulta: 1. Configuração do REST do Protheus


Descrição

  Para os usuários que possuem algum aplicativo customizado, e que precisam efetuar a consulta de motivos de parada no produto Gestão Agroindústria (SIGAAGR), foi disponibilizado o método Web Service REST. 

Método Publicado

Fonte

UBAA110

OBS: Para esta rotina, somente a consulta foi disponibilizada, o cadastro não é possível via REST.

Exemplo de Utilização

Para realizar testes, pode-se utilizar qualquer programa de sua preferência, que teste API Web Service REST. O SoapUI e o Postman  são exemplos de bons programas para isso. 


Consultando informações

Abaixo, uma consulta dos dados das tabelas referentes ao conjunto através do método GET.

Existem várias possibilidades de se restringir quais dados o GET irá retornar. Segue link da documentação relativa a este assunto: http://tdn.totvs.com.br/pages/viewpage.action?pageId=271671548


Exemplo de um retorno da rotina de cadastro de motivo de parada:

{
   "total": 1,
   "count": 1,
   "startindex": 1,
   "resources": [
      {
         "id": "UBAA110",
        "operation": 1,
        "pk": "RCBNRyAwMSAwMDEgICA=",
        "models": [
           {
              "id": "UBAA110_NBP",
              "modeltype": "FIELDS",
              "fields": [
                 {
                    "id": "NBP_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                    },
                    {
                    "id": "NBP_CODIGO",
                    "order": 2,
                    "value": "001"
                    },
                    {
                    "id": "NBP_DESCRI",
                    "order": 3,
                    "value": "FOGO NA ESTEIRA"
                    }
                 ]
              }
           ]
        }
     ]
}


Campo: NBP_FILIAL, Tipo: Caracter, Tamanho: 2, Descrição: Filial do Sistema;

Campo: NBP_CODIGO, Tipo: Caracter, Tamanho: 3, Descrição: Código Motivo de Parada ;

Campo: NBP_DESCRI, Tipo: Caracter, Tamanho: 40, Descrição: Descrição Mot. de Parada ;