Histórico da Página

Disponibilizado endpoint para integração do cadastro 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 Material	12	INTEGER	SS	N	--	Gerado automaticamente no Insert, obrigatório no Update
descricao	Descrição do Material	60	STRING	N	S	-	-
codigoGrupoMaterial	Código do Grupo de Material	4	INTEGER	N	S	-	-
codigoUnidadeMedida	Código da Unidade de Medida	3	STRING	N	S	-	-
codigoUnidadeMedidaErp	Código da Unidade de Medida no ERP	3	STRING	N	N	-	-
classificacaoMaterial	Flag Classificação do Material	1	STRING	N	N	M-	G = Genuíno \| O = Original \| M = Multimarcas
codigoErp	Código do ERP	25	STRING	N	N	-	-
codigoContaErp	Codigo da Conta ERP	20	STRING	N	N	-	-
codigoReferencia	Código de Referência do Material	60	STRING	N	N	-	-
codigoExterno	Codigo Externo do Material	20	STRING	N	N	-	-
descricaoExterna	Descrição Externa do Material	150	STRING	N	N	-	-
exportaPalm	Flag Controlador para exportação do registro para o PALM	1	STRING	N	NN	-	S = Sim \| N = Não
fabricante	Descrição do Fabricante do Material	60	STRING	N	N	-	-
fatorConversaoUnidMedidaErp	Fator de Conversão entre Unidades (por multiplicação)	9,5	NUMBER	N	N	-	-
indisponibilidadePedOficina	Flag para determinar a indisponibilidade do Material (Pedido de Material do Manfro (O.S))	1	STRING	N	N	-	S = Sim \| N = Não-
marca	Descrição da Marca do Material	60	STRING	N	N	-	-
materialAtivo	Flag para inativação de materiais	1	STRING	N	SN	S	S = Sim \| N = Não
materialCompra	Flag Controlador se material é estoque ou compra	1	STRING	N	N	-	S = Sim \| N = Não
materialEstoque	Flag Controlador se material é de estoque	1	STRING	N	N	-	S = Sim \| N = Não
materialServico	Flag Materiais ou serviços	1	STRING	N	N	S-	M = Material \| S = Serviço
observacaoIntegracao	Observação (utilizada qdo dado é inserida/atualizado por sistema externo)	250	STRING	N	N	-	-

...

GET (Consulta Materiais)

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

Bloco de código

language	java
title	Response

{
    "hasNext": false,
    "items": [
        {
            "codigocodigoExterno": 1null,
            "descricaocodigoContaErp": "TESTE MATERIAL"null,
            "codigoExternocodigo": "1"123,
            "codigoContaErpcodigoGrupoMaterial": "1",
            "codigoErpcodigoUnidadeMedida": "1UN",
            "codigoReferenciadescricao": "COD_REFTESTE MATERIAL API-HUB",
            "codigoGrupoMaterialcodigoUnidadeMedidaErp": 2null,
            "codigoUnidadeMedidacodigoErp": "UN"null,
            "codigoUnidadeMedidaErpcodigoReferencia": null,
            "fatorConversaoUnidMedidaErp": null,
            "exportaPalm": null,
            "observacaoIntegracao": null,
            "materialCompra": null,
            "materialEstoque": null,
            "materialServico": null,
            "indisponibilidadePedOficina": null,
            "materialAtivo": "S",
            "classificacaoMaterial": "M"null,
            "fabricante": "FAB"null,
            "marca": "MAR"null,
            "descricaoExterna": "TESTE MATERIAL"null,
            "rowversion": 1
        }
    ]
}

Parâmetros

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

...

POST (Cadastra Material)

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

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
	"codigo": 1123,
	"descricao": "TESTE MATERIAL API-HUB",
	"codigoExterno    "codigoGrupoMaterial": "1",
	"codigoContaErp    "codigoUnidadeMedida": "1UN",
	"codigoErpcodigoExterno": "1"null,
	"codigoReferenciacodigoContaErp": "COD_REF"null,
	"codigoGrupoMaterialcodigoErp": 2null,
	"codigoUnidadeMedidacodigoReferencia": "UN"null,
	"codigoUnidadeMedidaErp": null,
	"fatorConversaoUnidMedidaErp": null,
	"exportaPalm": null,
	"observacaoIntegracao": null,
	"materialCompra": null,
	"materialEstoque": null,
	"materialServico": null,
	"indisponibilidadePedOficina": null,
	"materialAtivo": "S"null,
	"classificacaoMaterial": "M"null,
	"fabricante": "FAB"null,
	"marca": "MAR"null,
	"descricaoExterna": "TESTE MATERIAL",
	"rowversion": null
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
    "codigo": 1123,
    "descricao": "TESTE MATERIAL API-HUB",
    "codigoExternocodigoGrupoMaterial": "1",
    "codigoContaErpcodigoUnidadeMedida": "1UN",
    "codigoErpcodigoExterno": "1"null,
    "codigoReferenciacodigoContaErp": "COD_REF"null,
    "codigoGrupoMaterialcodigoErp": 2null,
    "codigoUnidadeMedidacodigoReferencia": "UN"null,
    "codigoUnidadeMedidaErp": null,
    "fatorConversaoUnidMedidaErp": null,
    "exportaPalm": null,
    "observacaoIntegracao": null,
    "materialCompra": null,
    "materialEstoque": null,
    "materialServico": null,
    "indisponibilidadePedOficina": null,
    "materialAtivo": "S",
    "classificacaoMaterial": "M"null,
    "fabricante": "FAB"null,
    "marca": "MAR"null,
    "descricaoExterna": "TESTE MATERIAL"null,
    "rowversion": 1
}

PUT/PATCH (Atualiza Material)

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

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
    "codigo": 1,
    "descricao": "TESTE MATERIAL",
    "codigoExterno": "1",
    "codigoContaErp": "1",
    "codigoErp": "1",
    "codigoReferencia": "COD_REF",
    "codigoGrupoMaterial": 2,
    "codigoUnidadeMedida": "UN",
    "codigoUnidadeMedidaErp": null,
    "fatorConversaoUnidMedidaErp": null,
    "exportaPalm": null,
    "observacaoIntegracao": null,
    "materialCompra": null,
    "materialEstoque": null,
    "materialServico": null,
    "indisponibilidadePedOficina": null,
    "materialAtivo": "S",
    "classificacaoMaterial": "M",
    "fabricante": "FAB",
    "marca": "MAR",
    "descricaoExterna": "TESTE MATERIAL"
}

...

Bloco de código

language	java
title	Response
collapse	true

{
    "codigo": 1,
    "descricao": "TESTE MATERIAL",
    "codigoExterno": "1",
    "codigoContaErp": "1",
    "codigoErp": "1",
    "codigoReferencia": "COD_REF",
    "codigoGrupoMaterial": 2,
    "codigoUnidadeMedida": "UN",
    "codigoUnidadeMedidaErp": null,
    "fatorConversaoUnidMedidaErp": null,
    "exportaPalm": null,
    "observacaoIntegracao": null,
    "materialCompra": null,
    "materialEstoque": null,
    "materialServico": null,
    "indisponibilidadePedOficina": null,
    "materialAtivo": "S",
    "classificacaoMaterial": "M",
    "fabricante": "FAB",
    "marca": "MAR",
    "descricaoExterna": "TESTE 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 Material)

http:127.0.0.1:8080/api/entity/v1/materiais?codigo=123

Observações

É obrigatório informar os atributos que compõem a chave primária como parâmetros da chamada.

...

Páginas filhas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Parâmetros