Lista de erros do Reporter

Formato do erro O Reporter retorna erros como problem details RFC 9457 com o media type application/problem+json:

{
  "type": "https://errors.lerian.studio/v1/RPT-0012",
  "title": "Bad Request",
  "status": 400,
  "detail": "The specified templateID is not a valid UUID. Please check the value passed.",
  "code": "RPT-0012"
}

Definições dos campos

type – Uma URI que identifica o erro no catálogo de erros da Lerian. Construída como https://errors.lerian.studio/v1/<code>.
title – O texto do status HTTP (por exemplo, Bad Request).
status – O código de status HTTP.
detail – Orientação detalhada para ajudar você a resolver o erro. Nas respostas 5xx, o detalhe é sempre sanitizado para internal error para que nenhuma causa interna vaze; use code para o tratamento programático.
code – Um identificador estável e único para o erro (RPT-NNNN). Útil para tratamento programático e solicitações de suporte.
errors – Lista opcional de detalhes de validação por campo, cada um com um message e uma location.

Algumas mensagens contêm marcadores como %v ou %s — o Reporter os substitui pelos valores específicos da sua requisição.

Erros do Reporter

Os erros a seguir podem ocorrer ao interagir com os endpoints do Reporter. Consulte as tabelas abaixo para os códigos de erro possíveis, o que significam e como resolvê-los.

400 — Erros de validação

`code`	Descrição	`detail`
RPT-0001	Missing required fields	One or more required fields are missing. Please ensure all required fields are included.
RPT-0002	Invalid file format	The uploaded file must be a .tpl file. Other formats are not supported.
RPT-0003	Invalid output format	The outputFormat field must be one of: html, csv, or xml.
RPT-0004	Invalid header	One or more header values are missing or incorrectly formatted. Please verify required headers %v.
RPT-0005	Invalid File Uploaded	The file you submitted is invalid. Please check the uploaded file with error: %v
RPT-0006	Error File Empty	The file you submitted is empty. Please check the uploaded file.
RPT-0007	Error File Content Invalid	The file content is invalid because is not %s. Please check the uploaded file.
RPT-0008	Invalid Map Fields	The field on template file is invalid. Invalid field %s on %s.
RPT-0009	Invalid Path Parameter	Path parameters is in an incorrect format. Please check the following parameter %v and ensure they meet the required format before trying again.
RPT-0010	Update Output format without template File	Can not update output format without passing template file. Please check information passed and try again.
RPT-0012	Invalid templateID	The specified templateID is not a valid UUID. Please check the value passed.
RPT-0013	Invalid ledgerID	The specified ledgerID inside ledger ID list is not a valid UUID. Please check the value passed %v.
RPT-0014	Missing required fields	The fields mapped on template file are missing in the table schema or may be empty. Please check the fields passed: ‘%v’.
RPT-0015	Unexpected Fields in the Request	The request body contains more fields than expected. Please send only the allowed fields as per the documentation. The unexpected fields are listed in the fields object.
RPT-0016	Missing Fields in Request	Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.
RPT-0017	Bad Request	The server could not understand the request due to malformed syntax. Please check the listed fields and try again.
RPT-0019	Invalid Query Parameter	One or more query parameters are in an incorrect format. Please check the following parameters ‘%v’ and ensure they meet the required format before trying again.
RPT-0023	Invalid Date Range Error	Both ‘initialDate’ and ‘finalDate’ fields are required and must be in the ‘yyyy-mm-dd’ format. Please provide valid dates and try again.
RPT-0024	Pagination Limit Exceeded	The pagination limit exceeds the maximum allowed of %v items per page. Please verify the limit and try again.
RPT-0025	Invalid Sort Order	The ‘sort_order’ field must be ‘asc’ or ‘desc’. Please provide a valid sort order and try again.
RPT-0026	Metadata Key Length Exceeded	The metadata key %v exceeds the maximum allowed length of %v characters. Please use a shorter key.
RPT-0027	Metadata Value Length Exceeded	The metadata value %v exceeds the maximum allowed length of %v characters. Please use a shorter value.
RPT-0028	Invalid Metadata Nesting	The metadata object cannot contain nested values. Please ensure that the value %v is not nested and try again.
RPT-0030	Missing Schema Table	The schema table %v is missing for data source ‘%v’. Please check the information passed.
RPT-0031	Missing Data Source Table	The data source %v is missing. Please check the value passed.
RPT-0032	Script Tag Detected	The template file contains a script tag and is not allowed. Please check the template file and try again.
RPT-0035	Ambiguous Schema Reference	The table ‘%v’ exists in multiple schemas: %v. Please use explicit schema syntax: database:schema.table
RPT-0036	Schema Not Found	The schema ‘%v’ was not found in database ‘%v’. Please verify the schema name.
RPT-0037	Table Not Found in Schema	The table ‘%v’ was not found in schema ‘%v’ of database ‘%v’. Please verify the table name and schema.
RPT-0038	Database Not Registered	The database ‘%v’ is not registered. Please verify the datasource configuration.
RPT-0041	Bucket Required	The storage bucket name is required. Please check the storage configuration.
RPT-0042	Object Key Required	The object key is required for the storage operation.
RPT-0044	TTL Not Supported	TTL parameter is not supported in S3 mode. Use bucket lifecycle policies instead.
RPT-0046	Invalid Deadline Type	The ‘type’ field must be ‘regulatory’ or ‘custom’. Please provide a valid deadline type and try again.
RPT-0047	Invalid Deadline Frequency	The ‘frequency’ field must be one of: ‘once’, ‘daily’, ‘weekly’, ‘monthly’, ‘semiannual’, ‘annual’. Please provide a valid frequency and try again.
RPT-0048	Invalid Deadline Color	The ‘color’ field must be a valid hex color code (e.g., ‘#FF5733’). Please provide a valid color and try again.
RPT-0050	Months of Year Not Applicable	The ‘monthsOfYear’ field is not applicable for frequency ‘%v’. It can only be used with ‘semiannual’ or ‘annual’ frequencies.
RPT-0052	Months of Year Required	The ‘monthsOfYear’ field is required for frequency ‘%v’. Please specify which months of the year the deadline should recur on.
RPT-0054	Months of Year Out of Range	Each value in ‘monthsOfYear’ must be between 1 and 12. Received invalid value: %v.
RPT-0055	Due Date in the Past	The ‘dueDate’ must be today or a future date. Please provide a date that is not in the past.
RPT-0056	Months of Year Count Mismatch	The number of months in ‘monthsOfYear’ does not match the ‘%v’ frequency. ‘semiannual’ requires exactly 2 months and ‘annual’ requires exactly 1 month.
RPT-0059	Schema Validation Failed	The schema validation failed. Please verify the fields against the data source schema.
RPT-0062	Invalid UTF-8 Encoding	The ‘%v’ field contains invalid UTF-8 byte sequences. Please provide valid UTF-8 text and try again.
RPT-0107	Falha na pré-visualização de template	Não foi possível renderizar a pré-visualização do template. Corrija o template ou os dados de exemplo e tente novamente. O detalhe da resposta identifica a recusa específica.

A mensagem do RPT-0003 lista html, csv e xml, mas a API aceita cinco formatos de saída: HTML, PDF, CSV, XML e TXT. Veja Upload de template.

404 — Não encontrado

`code`	Descrição	`detail`
RPT-0011	Entity Not Found	No %v entity was found for the given ID. Please make sure to use the correct ID for the entity you are trying to manage.
RPT-0020	Invalid Date Format Error	The ‘initialDate’, ‘finalDate’, or both are in the incorrect format. Please use the ‘yyyy-mm-dd’ format and try again.
RPT-0021	Invalid Final Date Error	The ‘finalDate’ cannot be earlier than the ‘initialDate’. Please verify the dates and try again.
RPT-0022	Date Range Exceeds Limit Error	The range between ‘initialDate’ and ‘finalDate’ exceeds the permitted limit of %v months. Please adjust the dates and try again.
RPT-0043	Object Not Found	The requested object was not found in storage.
RPT-0057	Data Source Not Found	The requested data source was not found. Please verify the data source ID.

409 — Conflitos

`code`	Descrição	`detail`
RPT-0039	Duplicate Request In Flight	A duplicate request is currently being processed. Please wait and try again.
RPT-0040	Idempotency Conflict	A request with this idempotency key has already been processed.
RPT-0045	Duplicate Deadline	A deadline with the same name, type, due date, and frequency already exists. Please use different values or update the existing deadline.

422 — Não processável

`code`	Descrição	`detail`
RPT-0029	Report status not Finished	The Report is not ready to download. Report is processing yet.

429 — Solicitações em excesso

`code`	Descrição	`detail`
RPT-0108	Pré-visualização de template ocupada	Todas as vagas configuradas para pré-visualizações simultâneas estão em uso. O template não foi rejeitado; tente novamente em breve.

500 — Erros do servidor

`code`	Descrição	`detail`
RPT-0018	Internal Server Error	internal error

Toda falha inesperada durante o processamento síncrono de um endpoint aparece como HTTP 500 com code: RPT-0018 e um detail sanitizado para internal error — causas internas nunca vazam no corpo da resposta. Falhas assíncronas do worker e da geração de relatórios seguem os status e metadados descritos abaixo; elas não são retornadas na requisição original como HTTP 500.

Erros de geração de relatórios (assíncronos)

A geração de relatórios roda de forma assíncrona no worker. Uma seção de extração de dados que falha não é retornada na requisição HTTP original: o relatório termina com status Error quando todas as seções falham ou Partial quando algumas falham. Em ambos os casos, metadata.error_code é RPT-0060; metadata.sections é indexado pelo nome do banco de dados, e cada entrada com falha contém apenas seu error_code classificado (RPT-0018 para uma falha sem tipo). Outras falhas do worker terminam com status Error e um metadata.error_code seguro que não é RPT: report_generation_failed, report_generation_timeout ou report_generation_canceled; elas não têm um mapa sections nem preservam o código RPT subjacente.

`code`	Descrição	Significado
RPT-0033	Encryption data error	Falha ao descriptografar os dados de CRM durante a extração.
RPT-0034	Communication Error with SeaweedFS	Erro ao comunicar com o armazenamento de arquivos para baixar ou enviar um arquivo. Tente novamente.
RPT-0058	Data Source Unavailable	A fonte de dados está indisponível no momento. Os resultados podem estar incompletos.
RPT-0060	Extraction Job Failed	O job de extração falhou. Tente novamente mais tarde ou contate o suporte.
RPT-0061	Template Rendering Failed	A template não pôde ser renderizada com os dados fornecidos. É um erro permanente e não será resolvido com novas tentativas.
RPT-0063	CRM Hash Key Not Configured	A chave de hash do CRM não está configurada.
RPT-0064	CRM Encrypt Key Not Configured	A chave de criptografia do CRM não está configurada.
RPT-0065	Record Decryption Failed	Falha na descriptografia do registro.
RPT-0066	Cipher Init Failed	Falha na inicialização do cifrador.
RPT-0067	Invalid Extracted Data	Os dados extraídos são inválidos.
RPT-0068	Unexpected Collection Result	A coleta de dados retornou um resultado inesperado.
RPT-0069	Data Source Not Found	A fonte de dados referenciada pelo relatório não foi encontrada.
RPT-0070	Data Source Unavailable	A fonte de dados ficou indisponível durante a extração.

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Métricas

API de Streaming

Tratamento de erros

Lista de erros do Reporter

Erros do Reporter

400 — Erros de validação

404 — Não encontrado

409 — Conflitos

422 — Não processável

429 — Solicitações em excesso

500 — Erros do servidor

Erros de geração de relatórios (assíncronos)

​Erros do Reporter

​400 — Erros de validação

​404 — Não encontrado

​409 — Conflitos

​422 — Não processável

​429 — Solicitações em excesso

​500 — Erros do servidor

​Erros de geração de relatórios (assíncronos)

Erros do Reporter

400 — Erros de validação

404 — Não encontrado

409 — Conflitos

422 — Não processável

429 — Solicitações em excesso

500 — Erros do servidor

Erros de geração de relatórios (assíncronos)