NN-Agent

$ cat tipos-de-dados.md

Tipos de dados e formato de erro

Os tipos usados em todos os endpoints e o JSON padrão devolvido quando algo dá errado.

Tipos de dados

Todos os endpoints recebem JSON (ou multipart, no caso de certificados). Estes são os tipos usados nas tabelas deste guia.

  • string

    "MINHA_BASE"

    Texto entre aspas. Também carrega datas ("2026-11-11"); converta no SQL com TO_DATE.

  • number

    1521

    Número sem aspas. No Oracle, colunas NUMBER voltam como texto ("10").

  • boolean

    true

    true ou false. Em campos multipart, envie o texto "true" ou "false".

  • object

    { "status": 200 }

    Grupo de campos entre chaves. Usado em pool, response e service.

  • array

    [ { … }, { … } ]

    Lista. Usada em parameters, steps e fields.

  • enum

    "oracle"

    Um valor de uma lista fixa. Maiúsculas e minúsculas importam (ex.: type: "QUERY").

  • file

    certificado.pfx

    Arquivo enviado em multipart/form-data. Nos commands, o campo type "byte" recebe arquivo.

  • out

    "time": "out"

    Parâmetro de saída de procedure ou bloco anônimo. Só o primeiro OUT é devolvido.

400404502504

Formato de erro

Qualquer erro devolve o mesmo JSON. O status padrão é 400 (validação, token, erro do banco).

Resposta · 400 Bad Request
{
  "timestamp": "2026-11-11T16:03:19Z",
  "status": 400,
  "error": "Bad Request",
  "message": "ORA-20005: Saldo insuficiente: disponivel 5, solicitado 999999",
  "path": "/api/suprimentos/movimentos",
  "trace": null
}
  • timestampstring

    Data e hora (ISO 8601).

  • statusnumber

    Código HTTP.

  • errorstring

    Texto do status.

  • messagestring

    Motivo do erro (inclui ORA-xxxxx).

  • pathstring

    Caminho chamado.

  • traceany

    Detalhe extra, quando houver.

  • 400

    Validação, token ausente ou inválido, key duplicada, erro do banco, header de timeout inválido.

  • 404

    Rota inexistente (ou removida).

  • 405

    Método não permitido para o caminho.

  • 502

    Falha de conexão com a API externa.

  • 504

    Timeout da requisição estourado.

Próxima página

Endpoint /database

Continuar →