Ir para o conteúdo

/animalsBulk — Visão Geral

Sobre o serviço

O serviço animalsBulk documenta o fluxo de carga em lote de animais para certificadoras.

O processo foi desenhado em três etapas:

  1. Gerar um idUpload para vincular o arquivo à operação.
  2. Enviar o arquivo JSON para a file-api usando o idUpload gerado.
  3. Registrar a carga e acompanhar o processamento pelo idBulk.

Esse fluxo é assíncrono: o cadastro da carga retorna rapidamente e o processamento posterior atualiza o status do lote.

Endpoints Disponíveis

Método Path Descrição
GET /animalsBulk/gerarBulkUpload Gera um idUpload para uso na file-api
POST /animalsBulk Registra a carga em lote a partir do upload já realizado
GET /animalsBulk/{idBulk}/status Consulta o status do processamento do lote

Fluxo Recomendado

Passo 1. Gerar upload

Chame GET /animalsBulk/gerarBulkUpload para obter um identificador de upload.

Passo 2. Enviar arquivo para a file-api

Use o id retornado para enviar o arquivo JSON à file-api em POST https://files-hmg-sisbov.agricultura.gov.br/file/upload/UPLOAD_DE_ARQUIVO_CARGA/id/{id}.

Antes do envio, monte o arquivo conforme o guia em Como Montar o Arquivo JSON da Carga.

No multipart/form-data, envie:

Campo Tipo Observação
extension texto Use json
file arquivo Conteúdo JSON da carga
fileName texto Nome do arquivo, sem a extensão. Ex.: arquivo

O retorno da file-api contém o campo fileName que deve ser reutilizado no passo seguinte.

Passo 3. Registrar a carga

Envie um JSON para POST /animalsBulk com:

{
  "idUpload": "00000000-0000-0000-0000-000000000000",
  "fileName": "{valor retornado no campo fileName pela file-api}"
}

Passo 4. Consultar status

Use GET /animalsBulk/{idBulk}/status até o lote atingir um status final. O processamento será feito pela aplicação ao longo do tempo, e o status atualizado conforme o andamento.

Status Possíveis

Status Significado
CARREGADO Carga registrada e aguardando processamento
EM_PROCESSAMENTO Lote em execução
PROCESSADO_COM_SUCESSO Todos os animais foram processados com sucesso
REJEITADO O lote foi rejeitado por erro estrutural ou de validação

Observações de Segurança

  • O arquivo enviado deve conter apenas os dados funcionais da carga.
  • Não inclua tokens, accesskey, secretkey ou credenciais em exemplos, logs ou documentação.
  • O campo fileName deve ser tratado como identificador técnico do arquivo retornado pela file-api.