Atributos da chave primária simples

codigo

GET

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

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

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

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

Estrutura de dados para envio:

{
  "codigo": 810,
  "descricao": "Grupo teste",
  "codigoErp": "810",
  "tipoFormulacao": "F"
} 
ou lista 
[
{
  "codigo": 810,
  "descricao": "Grupo teste",
  "codigoErp": "810",
  "tipoFormulacao": "F"
},
{
  "codigo": 811,
  "descricao": "Grupo teste",
  "codigoErp": "811",
  "tipoFormulacao": "F"
}
]

Estrutura de dados retorno:

{
    "codigo": "810",
    "descricao": "Grupo teste",
    "codigoErp": "810",
    "tipoFormulacao": "F",
    "rowversion": 1,
    "descricaoAbreviada": "Grupo test"
} 
ou uma lista  
{
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 2,
    "failRecords": 0,
    "result": [
        {
            "recordId": {
                "codigo": "810"
            },
            "status": "SUCCESS",
            "message": null
        },
        {
            "recordId": {
                "codigo": "811"
            },
            "status": "SUCCESS",
            "message": null
        }
    ]
}

Observações

- A geração do código do grupo é controlada pelo parâmetro da seção INT_ERP, entrada FG_GERCOD_GRUPOINSUMO que possui dois, e somente dois, valores válidos: 1-Mesmo código ERP/2-Sequencial(último do banco+1).

    Para uso do valor 1 (Mesmo código ERP) há duas restrições: o código do ERP deve possuir no máximo 3 caracteres e ser composto somente por dígitos numéricos pois o código do grupo Bioenergia é do tipo numérico e tamanho máximo de 3. As mensagens de validação a seguir poderão aparecer caso sejam necessárias:

      a) "O campo codigoErp não pode ter mais que 3 caracteres".

      b) "O campo codigoErp não deve possuir caracteres alfanuméricos".

      Desta forma indicamos avaliar se o valor 1 de controle da geração de código é adequada no momento da implantação e do uso da API. 

     Para uso do valor 2 (Sequencial(último do banco+1)) não há restrições pois a API gerenciará a busca do código adequado liberando assim o atributo código de grupo no ERP para ter sua capacidade total de 15 caracteres.

    Caso o parâmetro da seção INT_ERP e entrada FG_GERCOD_GRUPOINSUMO não exista na base de dados do Bioenergia ou estiver com valor numérico menor que 1 ou maior que 2, será adotado pela API o valor padrão 1-Mesmo código ERP para a geração do código de grupo no Bioenergia.

- O atributo descricaoAbreviada não é obrigatório enviar, ele será populado com os N caracteres possíveis para essa coluna com base nos N primeiros caracteres do atributo descricao. Se enviado assumirá o valor enviado.

- 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.

- Caso seja enviado valor maior que o tamanho máximo dos atributos, estes terão seus conteúdos recortados não impedindo a conclusão da ação.

PUT

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

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

Observações

- O código ERP e a descrição deverão ser enviados, a descrição abreviada segue a mesma regra do POST.

- Serão atualizados somente a descrição e a descrição abreviada.

- 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.

- Caso seja enviado valor maior que o tamanho máximo dos atributos, estes terão seus conteúdos recortados não impedindo a conclusão da ação.

DELETE

http:127.0.0.1:8080/entity/v1/grupoInsumos

Observações

- É obrigatório informar o atributo codigo OU codigoErp, filtrando um único valor. Estes serão os únicos atributos usados no DELETE, sendo usado apenas o codigo caso enviado os dois.

- Caso enviado outros atributos eles serão desprezados e não impedirá o DELETE.