API Grupos de Materiais Manutenção Automotiva

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	N	-	Gerado automaticamente no Insert, obrigatório no Update
descricao	Descrição do Grupo de Material	40	STRING	N	S	-	-
descricaoAbreviada	Descrição Abreviada do Grupo de Material	10	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

Response

{
    "hasNext": false,
    "items": [
        {
            "codigo": 1,
            "codigoErp": null,
            "descricaoAbreviada": "TESTE DESC",
            "descricao": "TESTE DESCR TA-API-HUB",
            "fgCustoOS": "N",
            "fgCustoAbastecimento": "N",
            "fgCustoLubrificacao": "N",
            "fgExportaErp": "N",
            "rowversion": 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:

Body

{
    "codigo": 1,
    "descricao": "GRUPO MATERIAL TA-API-HUB"
}

Estrutura de dados retorno:

Response

{
    "codigo": 1,
    "descricao": "GRUPO MATERIAL TA-API-HUB",
    "fgCustoOS": "N",
    "fgCustoAbastecimento": "N",
    "fgCustoLubrificacao": "N",
    "fgExportaErp": "N",
    "rowversion": 1,
    "descricaoAbreviada": "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:

Body

{
    "codigo": 1,
    "descricao": "TESTE DESCR TA-API-HUB",
    "descricaoAbreviada": ""
}

Estrutura de dados retorno:

Response

{
    "codigo": 1,
    "descricao": "TESTE DESCR TA-API-HUB",
    "descricaoAbreviada": "TESTE DESC"
}

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.

Páginas filhas

API Grupos de Materiais Manutenção Automotiva

Parâmetros