Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

codigo

Código do Material

12

INTEGER

S

S

-

-

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

-

-

fgCustoLubrificacao

Flag de Custos de Lubrificação

1

STRING

N

N

-

S = Sim | N = Não

fgExportaErp

Flag Controlador de Exportação para o ERP

1

STRING

N

N

-

S = Exporta | N = Não exporta

codigoErp

Código de Relacionamento com o ERP

15

STRING

N

N

-

-


GET (Consulta Materiais)

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

{
    "hasNext": false,
    "items": [
        {
            "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",
            "rowversion": 1
        }
    ]
}

Parâmetros

Observações

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


POST (Cadastra Material)

http:127.0.0.1:8080/entity/v1/materiais

Estrutura de dados para envio:

{
	"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",
	"rowversion": null
}

Estrutura de dados retorno:

{
    "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",
    "rowversion": 1
}


PUT (Atualiza Material)

http:127.0.0.1:8080/entity/v1/materiais

Estrutura de dados para envio:

{
    "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"
}

Estrutura de dados retorno:

{
    "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"
}


DELETE (Apaga Material)

http:127.0.0.1:8080/entity/v1/materiais

Observações

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