Atributos

Descrição

Tamanho

Tipo

Requerido

Valor default

codigoDeposito

  Código de depósito de insumo

8

INTEGER

S


descricaoDeposito

  Descrição do depósito de insumo

40

STRING

S


codigoDepositoERP

  Código do depósito no ERP

15

STRING

S


codigoOrganizacaoERP

  Código da organização ERP

15

STRING

S


codigoEmpresaERP

  Código da empresa ERP

15

STRING

S


codigoLocalizacaoERP

  Código da localização ERP

15

STRING

N


Atributos da chave primária simples

codigoDeposito.

GET

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

{
    "hasNext": false,
    "items": [
        {
            "instancia": "INST01",
            "codigoEmpresa": "EMP01",
            "dataRefer": "2024-09-01",
            "codigoFuncio": 12345,
            "codigoEquipto": "EQUIP123456",
            "codigoCcusto": 1234567890,
            "quantidadeHoras": 1
        }
    ]
}

Parâmetros

Observações

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


POST

http:127.0.0.1:8080/entity/v1/depositoInsumos→ cadastra um objeto

http:127.0.0.1:8080/entity/v1/depositoInsumos/batch  → cadastra uma lista do objeto.

Estrutura de dados para envio:

{
    
  "codigoExterno": "INSTEX01",
  "codigoEmpresa": "EMP01",
  "dataRefer": "2024-09-01",
  "codigoFuncio": 12345,
  "codigoEquipto": "EQUIP123456",
  "codigoCcusto": 1234567890,
  "quantidadeHoras": 1


} ou uma lista 
[{
    
  "codigoExterno": "INSTEX01",
  "codigoEmpresa": "EMP01",
  "dataRefer": "2024-09-01",
  "codigoFuncio": 12345,
  "codigoEquipto": "EQUIP123456",
  "codigoCcusto": 1234567890,
  "quantidadeHoras": 1


}, {
    
  "codigoExterno": "INSTEX01",
  "codigoEmpresa": "EMP002",
  "dataRefer": "2024-09-01",
  "codigoFuncio": 12345,
  "codigoEquipto": "EQUIP123456",
  "codigoCcusto": 1234567890,
  "quantidadeHoras": 1.5


}]

Estrutura de dados retorno:

{
    "codigoExterno": "INSTEX01",
    "codigoEmpresa": "EMP01",
    "dataRefer": "2024-09-01",
    "codigoFuncio": 12345,
    "codigoEquipto": "EQUIP123456",
    "codigoCcusto": 1234567890,
    "quantidadeHoras": 1,
    "instancia": "INST01"
} ou uma lista  
{
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 1,
    "failRecords": 1,
    "result": [
        {
            "recordId": {
                "codigoEmpresa": "EMP01",
                "codigoFuncio": 12346,
                "codigoEquipto": "EQUIP123456",
                "codigoCcusto": 1234567890,
                "dataRefer": "2024-09-01"
            },
            "status": "SUCCESS",
            "message": null
        },
        {
            "recordId": {
                "codigoEmpresa": "EMP002",
                "codigoFuncio": 12345,
                "codigoEquipto": "EQUIP123456",
                "codigoCcusto": 1234567890,
                "dataRefer": "2024-09-01"
            },
            "status": "ERROR",
            "message": "Tamanho inválido para o atributo codigoEmpresa. Máximo: 5"
        }
    ]
}

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 codigoCcusto e o codigoEquipto não podem estar zerados ou nulos simultaneamente. Ex: caso o codigoCcusto seja zero o codigoEquipto deve existir.

- É verificado se o codigoEmpresa referencia uma empresa consolidada.

- 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/depositoInsumos→ atualiza um objeto

http:127.0.0.1:8080/entity/v1/depositoInsumos/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/entity/v1/depositoInsumos

Observações

- É obrigatório informar os atributos que formam 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.