PUBLICAÇÃO WEB SERVICE REST DO CADASTRO DE CONJUNTO(APENAS CONSULTA)
Características do Requisito
Linha de Produto: | Microsiga Protheus | ||||
Segmento: | Supply Chain - Agroindústria | ||||
Módulo: | SIGAAGR | ||||
Rotinas: |
| ||||
País: | Brasil | ||||
Bancos de Dados: | Todos | ||||
Tabelas Utilizadas: | DXC, DXE, DXF | ||||
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 conjuntos no produto Gestão Agroindústria (SIGAAGR), foi disponibilizado o método Web Service REST.
Fonte | AGRA611 |
|---|
OBS: Para esta rotina, somente a consulta foi disponibilizada, o cadastro não é possível via REST.
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.
Abaixo, uma consulta dos dados das tabelas referentes ao conjunto através do método GET.
OBS: para a consulta correta, é necessário o parâmetro FIRSTLEVEL igual a FALSE, como na imagem acima. Assim, o GET retorna os dados de todos os nível do modelo. Caso o parâmetro não seja passado, o GET retornará apenas o cabeçalho, ou seja, a tabela DXE.
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 conjuntos:
{
"id": "AGRA611",
"operation": 1,
"pk": "RCBNRyAwMSAwMDAwMDM=",
"models": [
{
"id": "MdFieldDXE",
"modeltype": "FIELDS",
"fields": [
{
"id": "DXE_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "DXE_CODIGO",
"order": 2,
"value": "000003"
},
{
"id": "DXE_DESCRI",
"order": 3,
"value": "TESTE TI CARLOS"
},
{
"id": "DXE_CODSAI",
"order": 5,
"value": "0007898535831"
},
{
"id": "DXE_UBA",
"order": 6,
"value": "01"
},
{
"id": "DXE_PSBAL",
"order": 9,
"value": "11.94"
},
{
"id": "DXE_PSMIN",
"order": 10,
"value": "10.00"
},
{
"id": "DXE_PSMAX",
"order": 11,
"value": "13.00"
},
{
"id": "DXE_RDMIN",
"order": 12,
"value": "50.00"
},
{
"id": "DXE_RDMAX",
"order": 13,
"value": "60.00"
},
{
"id": "DXE_RDMED",
"order": 14,
"value": "0"
}
],
"models": [
{
"id": "MdGridDXF",
"modeltype": "GRID",
"struct": [
{
"id": "DXF_FILIAL",
"order": 1
},
{
"id": "DXF_ITEM",
"order": 2
},
{
"id": "DXF_CODPRO",
"order": 3
},
{
"id": "DXF_QTDPRO",
"order": 5
},
{
"id": "DXF_PSUNIT",
"order": 6
},
{
"id": "DXF_LOCAL",
"order": 7
},
{
"id": "DXF_CPBAL",
"order": 8
},
{
"id": "DXF_MOVEST",
"order": 9
},
{
"id": "DXF_TM",
"order": 10
},
{
"id": "DXF_LOTCTL",
"order": 11
},
{
"id": "DXF_NMLOT",
"order": 12
},
{
"id": "DXF_LOCLIZ",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "DXF_FILIAL",
"value": "D MG 01"
},
{
"id": "DXF_ITEM",
"value": "001"
},
{
"id": "DXF_CODPRO",
"value": "1006298"
},
{
"id": "DXF_QTDPRO",
"value": "10.00"
},
{
"id": "DXF_PSUNIT",
"value": "1.00"
},
{
"id": "DXF_LOCAL",
"value": "01"
},
{
"id": "DXF_CPBAL",
"value": "1"
},
{
"id": "DXF_MOVEST",
"value": "1"
},
{
"id": "DXF_TM",
"value": "514"
},
{
"id": "DXF_LOTCTL",
"value": "123"
},
{
"id": "DXF_NMLOT",
"value": "20"
},
{
"id": "DXF_LOCLIZ",
"value": "10"
}
]
},
{
"id": 2,
"deleted": 0,
"fields": [
{
"id": "DXF_FILIAL",
"value": "D MG 01"
},
{
"id": "DXF_ITEM",
"value": "002"
},
{
"id": "DXF_CODPRO",
"value": "1006297"
},
{
"id": "DXF_QTDPRO",
"value": "1.50"
},
{
"id": "DXF_PSUNIT",
"value": "1.00"
},
{
"id": "DXF_LOCAL",
"value": "01"
},
{
"id": "DXF_CPBAL",
"value": "1"
},
{
"id": "DXF_MOVEST",
"value": "1"
},
{
"id": "DXF_TM",
"value": "514"
},
{
"id": "DXF_LOTCTL",
"value": "321"
},
{
"id": "DXF_NMLOT",
"value": "30"
},
{
"id": "DXF_LOCLIZ",
"value": "20"
}
]
},
{
"id": 3,
"deleted": 0,
"fields": [
{
"id": "DXF_FILIAL",
"value": "D MG 01"
},
{
"id": "DXF_ITEM",
"value": "003"
},
{
"id": "DXF_CODPRO",
"value": "1030867"
},
{
"id": "DXF_QTDPRO",
"value": "1.00"
},
{
"id": "DXF_PSUNIT",
"value": "0.44"
},
{
"id": "DXF_LOCAL",
"value": "01"
},
{
"id": "DXF_CPBAL",
"value": "1"
},
{
"id": "DXF_MOVEST",
"value": "1"
},
{
"id": "DXF_TM",
"value": "514"
},
{
"id": "DXF_LOTCTL",
"value": "516"
},
{
"id": "DXF_NMLOT",
"value": "40"
},
{
"id": "DXF_LOCLIZ",
"value": "30"
}
]
}
]
},
{
"id": "MdGridDes",
"modeltype": "GRID",
"struct": [
{
"id": "DXC_FILIAL",
"order": 1
},
{
"id": "DXC_ITEM",
"order": 2
},
{
"id": "DXC_CODPRO",
"order": 3
},
{
"id": "DXC_LOCAL",
"order": 5
},
{
"id": "DXC_PLUMA",
"order": 6
},
{
"id": "DXC_TIPO",
"order": 8
},
{
"id": "DXC_PERC",
"order": 9
},
{
"id": "DXC_RATEIO",
"order": 10
},
{
"id": "DXC_GRPROD",
"order": 11
},
{
"id": "DXC_PRDPRO",
"order": 12
},
{
"id": "DXC_LOCPRD",
"order": 14
},
{
"id": "DXC_TM",
"order": 15
},
{
"id": "DXC_LOTCTL",
"order": 16
},
{
"id": "DXC_NMLOT",
"order": 17
},
{
"id": "DXC_LOCLIZ",
"order": 18
},
{
"id": "DXC_LOTPRD",
"order": 19
},
{
"id": "DXC_NMLPRD",
"order": 20
},
{
"id": "DXC_LCLPRD",
"order": 21
},
{
"id": "DXC_SITLAV",
"order": 22
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "DXC_FILIAL",
"value": "D MG 01"
},
{
"id": "DXC_ITEM",
"value": "001"
},
{
"id": "DXC_CODPRO",
"value": "1006309L"
},
{
"id": "DXC_LOCAL",
"value": "01"
},
{
"id": "DXC_PLUMA",
"value": "1"
},
{
"id": "DXC_TIPO",
"value": "3"
},
{
"id": "DXC_RATEIO",
"value": "85.0000"
},
{
"id": "DXC_GRPROD",
"value": "1"
},
{
"id": "DXC_PRDPRO",
"value": "1006310"
},
{
"id": "DXC_LOCPRD",
"value": "01"
},
{
"id": "DXC_TM",
"value": "001"
},
{
"id": "DXC_LOTCTL",
"value": "LT00000003"
}
]
},
{
"id": 2,
"deleted": 0,
"fields": [
{
"id": "DXC_FILIAL",
"value": "D MG 01"
},
{
"id": "DXC_ITEM",
"value": "002"
},
{
"id": "DXC_CODPRO",
"value": "1006312"
},
{
"id": "DXC_LOCAL",
"value": "04"
},
{
"id": "DXC_PLUMA",
"value": "2"
},
{
"id": "DXC_TIPO",
"value": "1"
},
{
"id": "DXC_PERC",
"value": "51.00"
},
{
"id": "DXC_RATEIO",
"value": "14.0000"
},
{
"id": "DXC_GRPROD",
"value": "2"
}
]
},
{
"id": 3,
"deleted": 0,
"fields": [
{
"id": "DXC_FILIAL",
"value": "D MG 01"
},
{
"id": "DXC_ITEM",
"value": "003"
},
{
"id": "DXC_CODPRO",
"value": "1006313"
},
{
"id": "DXC_LOCAL",
"value": "02"
},
{
"id": "DXC_PLUMA",
"value": "2"
},
{
"id": "DXC_TIPO",
"value": "1"
},
{
"id": "DXC_PERC",
"value": "1.00"
},
{
"id": "DXC_RATEIO",
"value": "0.9999"
},
{
"id": "DXC_GRPROD",
"value": "2"
}
]
},
{
"id": 4,
"deleted": 0,
"fields": [
{
"id": "DXC_FILIAL",
"value": "D MG 01"
},
{
"id": "DXC_ITEM",
"value": "004"
},
{
"id": "DXC_CODPRO",
"value": "1066091"
},
{
"id": "DXC_LOCAL",
"value": "02"
},
{
"id": "DXC_PLUMA",
"value": "2"
},
{
"id": "DXC_TIPO",
"value": "2"
},
{
"id": "DXC_PERC",
"value": "100.00"
},
{
"id": "DXC_RATEIO",
"value": "0.0001"
},
{
"id": "DXC_GRPROD",
"value": "2"
},
{
"id": "DXC_LOTCTL",
"value": "2121"
},
{
"id": "DXC_NMLOT",
"value": "321"
},
{
"id": "DXC_LOCLIZ",
"value": "10"
}
]
}
]
}
]
}
]
}
Campo: DXE_FILIAL, Tipo: Caracter, Tamanho: 2, Descrição: Filial do Sistema;
Campo: DXE_CODIGO, Tipo: Caracter, Tamanho: 6, Descrição: Código do Conjunto;
Campo: DXE_DESCRI, Tipo: Caracter, Tamanho: 25, Descrição: Descrição do Conjunto;
Campo: DXE_CODSAI, Tipo: Caracter, Tamanho: 13, Descrição: Código S.A.I.;
Campo: DXE_UBA, Tipo: Caracter, Tamanho: 2, Descrição: Código da UBA;
Campo: DXE_PSBAL, Tipo: Numérico, Tamanho: 3 Inteiros e 2 Decimais, Descrição: Peso adicional da balança;
Campo: DXE_PSMIN, Tipo: Numérico, Tamanho: 3 Inteiros e 2 Decimais, Descrição: Peso mínimo do fardo;
Campo: DXE_PSMAX, Tipo: Numérico, Tamanho: 3 Inteiros e 2 Decimais, Descrição: Peso máximo do fardo;
Campo: DXE_RDMIN, Tipo: Numérico, Tamanho: 2 Inteiros e 2 Decimais, Descrição: Percentual de Rendimento Mínimo;
Campo: DXE_RDMAX, Tipo: Numérico, Tamanho: 2 Inteiros e 2 Decimais, Descrição: Percentual de Rendimento Máximo;
Campo: DXE_RDMED, Tipo: Numérico, Tamanho: 2 Inteiros e 2 Decimais, Descrição: Percentual de Rendimento Médio;
Campo: DXF_FILIAL, Tipo: Caracter, Tamanho: 2, Descrição: Filial do Sistema;
Campo: DXF_ITEM, Tipo: Caracter, Tamanho: 3, Descrição: Item adicional do conjunto;
Campo: DXF_CODPRO, Tipo: Caracter, Tamanho: 15, Descrição: Código do Produto;
Campo: DXF_QTDPRO, Tipo: Numérico, Tamanho: 11 Inteiros e 2 Decimais, Descrição: Quantidade do Produto;
Campo: DXF_PSUNIT, Tipo: Numérico, Tamanho: 3 Inteiros e 2 Decimais, Descrição: Peso Unitário;
Campo: DXF_LOCAL, Tipo: Caracter, Tamanho: 2, Descrição: Local de Estoque;
Campo: DXF_CPBAL, Tipo: Caracter, Tamanho: 1, Descrição: Compõe Peso Balança?;
Campo: DXF_MOVEST, Tipo: Caracter, Tamanho: 1, Descrição: Movimenta Estoque?;
Campo: DXF_TM, Tipo: Caracter, Tamanho: 3, Descrição: Tipo de Movimento;
Campo: DXF_LOTCTL, Tipo: Caracter, Tamanho: 10, Descrição: Lote do Produto;
Campo: DXF_NMLOT, Tipo: Caracter, Tamanho: 6, Descrição: Sublote;
Campo: DXF_LOCLIZ, Tipo: Caracter, Tamanho: 15, Descrição: Endereço;
Campo: DXC_FILIAL, Tipo: Caracter, Tamanho: 2, Descrição: Filial do Sistema;
Campo: DXC_ITEM, Tipo: Caracter, Tamanho: 3, Descrição: Item da Tabela;
Campo: DXC_CODPRO, Tipo: Caracter, Tamanho: 15, Descrição: Código do Produto;
Campo: DXC_LOCAL, Tipo: Caracter, Tamanho: 2, Descrição: Local de Estoque;
Campo: DXC_PLUMA, Tipo: Caracter, Tamanho: 1, Descrição: Pluma?;
Campo: DXC_TIPO, Tipo: Caracter, Tamanho: 1, Descrição: Tipo de Separação;
Campo: DXC_PERC, Tipo: Numérico, Tamanho: 3 Inteiros e 2 Decimais, Descrição: Percentual de Separação;
Campo: DXC_RATEIO, Tipo: Numérico, Tamanho: 2 Inteiros e 4 Decimais, Descrição: Percentual de Rateio de Custo;
Campo: DXC_GRPROD, Tipo: Caracter, Tamanho: 1, Descrição: Gera Produção?;
Campo: DXC_PRDPRO, Tipo: Caracter, Tamanho: 15, Descrição: Código do Produto de Produção;
Campo: DXC_LOCPRD, Tipo: Caracter, Tamanho: 2, Descrição: Local de Estoque de Produção;
Campo: DXC_TM, Tipo: Caracter, Tamanho: 3, Descrição: Local de Estoque de Produção;
Campo: DXC_LOTCTL, Tipo: Caracter, Tamanho: 10, Descrição: Lote do Produto;
Campo: DXC_NMLOT, Tipo: Caracter, Tamanho: 10, Descrição: Sublote;
Campo: DXC_LOCLIZ, Tipo: Caracter, Tamanho: 15, Descrição: Sublote;
Campo: DXC_LOTPRD, Tipo: Caracter, Tamanho: 10, Descrição: Lote do Produto de Produção;
Campo: DXC_NMLPRD, Tipo: Caracter, Tamanho: 6, Descrição: Sublote do Produto de Produção;
Campo: DXC_LCLPRD, Tipo: Caracter, Tamanho: 15, Descrição: Endereço do Produto de Produção;
Campo: DXC_SITLAV, Tipo: Caracter, Tamanho: 1, Descrição: Tipo de Produto (1=Pluma;2=Caroço;3=Fibrilha;4=Casquinha;5=Resíduo);