PCPA121 - Criar uma API Rest para realizar o cadastro de formulário de apontamento
Linha de Produto: | Protheus |
Segmento: | Manufatura |
Módulo: | SIGAPCP - Planejamento e Controle da Produção |
Função: | PCPA121 - Cadastro de Formulário de Apontamento FormRegistration - API Rest Cadastro de Formulário de Apontamento. |
Situação/Requisito: | Necessidade de criar uma API Rest para realizar o cadastro de formulário de apontamento. |
Solução/Implementação: | Foi criada a tabela SOX que armazenará o Cadastro de formulário de apontamento. Neste cadastro o usuário poderá cadastrar o código do formulário, a descrição do formulário, o ícone/imagem que irá representar o formulário e qual será o programa de apontamento que o formulário irá representar. A API terá os métodos GET, POST, PUT e DELETE. Método POST : Parâmetros Query: Não recebe parâmetros Endereço: POST localhost:8040/rest/FormRegistration Parâmetros recebidos no corpo da requisição : { "code": "0035", "description": "Formulario SFCA ", "iconName": "555", "appointmentType": "4" } Retorno: Código 201 e o Registro que foi criado no texto JSON. Método PUT: Parâmetros Query: Não recebe parâmetros Endereço: PUT localhost:8040/rest/FormRegistration Parâmetros recebidos no corpo da requisição : { "code": "0035", "description": "Formulario SFCA ", "iconName": "555", "appointmentType": "4" } Retorno: Código 201 e o Registro que foi atualizado no texto JSON. Método DELETE: Parâmetros Query: Não recebe parâmetros Endereço: DELETE localhost:8040/rest/FormRegistration Parâmetros recebidos no corpo da requisição : { "code": "0035", "description": "Formulario SFCA ", "iconName": "555", "appointmentType": "4" } Retorno: Código 201 e o Registro que foi atualizado no texto JSON. Método GET: Parâmetros Query: Recebe parâmetros de página (page), código do formulário (code), inicio Endereço: localhost:8040/rest/FormRegistration?page=2 localhost:8040/rest/FormRegistration?page=2&count=1 localhost:8040/rest/FormRegistration?code=0024 localhost:8040/rest/FormRegistration Retorno: Código 200 e os Registros que foram consultados em texto JSON. Exemplo de Retorno com vários registros [ Exemplo de Retorno com um único registro: { Obs.: Este cadastro será utilizado futuramente no APP Apontamento de Produção. |
Requisito: | DMANSMARTSQUAD1-7353 |