Páginas filhas
  • API Grupos de Materiais Manutenção Automotiva

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Disponibilizado endpoint para integração do cadastro de Grupos de Materiais com os métodos GET, POST, PUT, PATCH e DELETE.

 

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

codigo

Código do Grupo de Material

4

NUMBER

S

S

N

-

Gerado automaticamente no Insert, obrigatório no Update

descricaodescricaoAbreviada

Descrição Abreviada do Grupo de Material

1040

STRING

N

N

S

-

-

descricaoAbreviadadescricao

Descrição Abreviada do Grupo de Material

4010

STRING

N

N

TRUNC(descricao, 10)

-

fgCustoOS

Flag de Custos da O.S.

1

STRING

N

N

N

S = Sim | N = Não

fgCustoAbastecimento

Flag de Custos de Abastecimento

1

STRING

N

N

N

S = Sim | N = Não

fgCustoLubrificacao

Flag de Custos de Lubrificação

1

STRING

N

N

N

S = Sim | N = Não

fgExportaErp

Flag Controlador de Exportação para o ERP

1

STRING

N

N

N

S = Exporta | N = Não exporta

codigoErp

Código de Relacionamento com o ERP

15

STRING

N

N

-

-


GET (Consulta Grupos de Materiais)

http:127.0.0.1:8080/api/entity/v1/grupoMateriais?page=1&pagesize=20

Bloco de código
languagejava
titleResponse
{
    "hasNext": false,
    "items": [
        {
            "codigoEmpresacodigo": "EMP90"1,
            "codigoMatercodigoErp": "MATER1234"null,
            "dataReferdescricaoAbreviada": "2024-09-01TESTE DESC",
            "daSituacaoErpdescricao": "DescriçãoTESTE do retorno do ERP",
            "dataSituacaoErp": "2024-09-01DESCR TA-API-HUB",
            "situacaoErpfgCustoOS": "SN",
            "qtMaterfgCustoAbastecimento": 123,
            "qtValor": 123"N",
            "qtValor1fgCustoLubrificacao": 123456789,
            "qtValor2N": 123456789,
            "qtValor3fgExportaErp": 123456789,
            "qtValor4": 0"N",
            "instanciarowversion": "INST01"1
        }
    ]
}

Parâmetros

  • page: Número da página.
  • pagesize: Quantidade máxima de registros por página.

Observações-

  • Todos os atributos podem ser usados como parâmetro para a busca.


POST (Cadastra Grupo de Material)

http:127.0.0.1:8080/api/entity/v1/grupoMateriais

Estrutura de dados para envio:

Bloco de código
languagejava
titleValor MaterialBody
collapsetrue
{
  "codigoEmpresa": "EMP9043",
  "codigoMatercodigo": "MATER1234"1,
  "dataRefer": "2024-09-01",
  "daSituacaoErpdescricao": "DescriçãoGRUPO do retorno do ERP",
  "dataSituacaoErp": "2024-09-01",
  "situacaoErp": "S",
  "codigoExterno":"INSTEX01",
  "qtMater": 123,
  "qtValor": 123,
  "qtValor1": 123456789,
  "qtValor2": 123456789,
  "qtValor3": 123456789,
  "qtValor4": null
} MATERIAL TA-API-HUB"
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleValor MaterialResponse
collapsetrue
{
    "codigoEmpresacodigo": "EMP90"1,
    "codigoMaterdescricao": "MATER1234GRUPO MATERIAL TA-API-HUB",
    "dataReferfgCustoOS": "2024-09-01N",
    "daSituacaoErpfgCustoAbastecimento": "Descrição do retorno do ERPN",
    "dataSituacaoErpfgCustoLubrificacao": "2024-09-01N",
    "situacaoErpfgExportaErp": "SN",
    "codigoExternorowversion": "INSTEX01"1,
    "qtMaterdescricaoAbreviada": 123,"GRUPO MATE"
}

Observações

  • Caso o atributo codigo não seja informado na requisição, será atribuído automaticamente o primeiro código disponível que for encontrado a partir do 1 até o final da sequência 9999.


PUT/PATCH (Atualiza Grupo de Material)

http:127.0.0.1:8080/api/entity/v1/grupoMateriais

Estrutura de dados para envio:

Bloco de código
languagejava
titleBody
collapsetrue
{
    "qtValorcodigo": 1231,
    "qtValor1descricao": 123456789 "TESTE DESCR TA-API-HUB",
    "qtValor2descricaoAbreviada": 123456789""
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{,
    "qtValor3codigo": 1234567891,
    "qtValor4descricao": 0"TESTE DESCR TA-API-HUB",
    "instanciadescricaoAbreviada": "INST01TESTE DESC"
}

PUT (Atualiza Grupo de Material)

...

Observações

  • Quando PATCH poderão ser enviados apenas os atributos que necessitam de atualização e os atributos que compõe a chave primária (conforme exemplo acima).
  • No caso de PUT deverão ser enviados os atributos necessários/obrigatórios e os atributos que compõe a chave primária.


DELETE (Apaga Grupo de Material)

http:127.0.0.1:8080/api/entity/v1/grupoMateriais?codigo=1

Observações-

  • É obrigatório informar os atributos que

...

  • compõem a chave primária como parâmetros da chamada.