Histórico da Página

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

Atributos da chave primária composta

instancia, codigoEmpresa, codigoMater, dataRefer.

GET (Consulta Grupos de Materiais)GET

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

{
    "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,
            "qtValor2": 123456789"N",
            "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.

- Caso seja informado o codigoExterno, será usado como parâmetro, para a busca, a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

POSTPOST (Cadastra Grupo de Material)

http:127.0.0.1:8080/entity/v1/valorMateriais→ cadastra um objetohttp:127.0.0.1:8080/api/entity/v1/valorMateriais/batch  → cadastra uma lista do objeto.grupoMateriais

Estrutura de dados para envio:

{
  "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
} ou uma lista  [
   {
  "codigoEmpresa": "EMP9043",
  "codigoMater": "MATER1234",
  "dataRefer": "2024-09-01",
  "daSituacaoErp": "Descrição do retorno do ERP",
  "dataSituacaoErp": "2024-09-01",
  "situacaoErp": "S",
  "codigoExterno":"INSTEX01",
  "qtMater": 123,
  "qtValor": 123,
  "qtValor1": 123456789,
  "qtValor2": 123456789,
  "qtValor3": 123456789,
  "qtValor4": null
},
{
  "codigoEmpresa": "EMP9043",
  "codigoMater": "MATER1234",
  "dataRefer": "2024-09-01",
  "daSituacaoErp": "Descrição do retorno do ERP",
  "dataSituacaoErp": "2024-09-01",
  "situacaoErp": "S",
  "qtMater": 123,
  "qtValor": 123,
  "qtValor1": 123456789,
  "qtValor2": 123456789,
  "qtValor3": 123456789,
  "qtValor4": null
}
]MATERIAL TA-API-HUB"
}

Estrutura de dados retorno:

{
    "codigoEmpresacodigo": "EMP90"1,
    "codigoMaterdescricao": "MATER1234",
GRUPO    "dataRefer": "2024-09-01MATERIAL TA-API-HUB",
    "daSituacaoErpfgCustoOS": "Descrição do retorno do ERPN",
    "dataSituacaoErpfgCustoAbastecimento": "2024-09-01N",
    "situacaoErpfgCustoLubrificacao": "SN",
    "codigoExternofgExportaErp": "INSTEX01N",
    "qtMaterrowversion": 1231,
    "qtValor": 123,
    "qtValor1": 123456789,
    "qtValor2": 123456789,
    "qtValor3": 123456789,
    "qtValor4": 0,
    "instancia": "INST01"
} ou uma lista   {
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 1,
    "failRecords": 1,
    "result": [
        {
            "recordId": {
                "codigoEmpresa": "EMP90",
                "codigoMater": "MATER1234",
                "instancia": "201",
                "dataRefer": "2024-09-01"
            },
            "status": "SUCCESS",
            "message": null
        },
        {
            "recordId": {
                "codigoEmpresa": "EMP90",
                "codigoMater": "MATER1234",
                "instancia": null,
                "dataRefer": "2024-09-01"
            },
            "status": "ERROR",
            "message": "A instancia ou o código externo devem ser preenchidos"
        }
    ]
}

Observações

- Caso seja informado o codigoExterno, será cadastrado a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

...

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:

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

Estrutura de dados retorno:

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

- O retorno do cadastro em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.

PUT

http:127.0.0.1:8080/entity/v1/valorMateriais→ atualiza um objeto

http:127.0.0.1:8080/entity/v1/valorMateriais/batch  → atualiza uma lista de objeto.

Observações

- Caso seja informado o codigoExterno, será cadastrado a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

...

- O retorno do update em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.

DELETE

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

Observações-

• É obrigatório informar os atributos que

...

• compõem a chave primária

...

- Caso seja informado o codigoExterno, será usado como parâmetro, para a deleção, a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

...

• como parâmetros da chamada.