Visão geral dos relatórios
#
O recurso Relatórios fornece a capacidade de consultar e executar relatórios configurados no workspace referenciado.
/{VERSÃO}/espaços de trabalho/{WORKSPACE_ID}/relatórios
Interfaces disponíveis
#
Esquemas
#
Relatórios
#
| Chave |
Descrição |
Tipo |
| id |
Identificador exclusivo para fazer referência a este relatório |
GUID |
| nome |
Nome amigável para a instância de relatório |
corda |
Status do relatório
#
| Dados |
Descrição |
Tipo |
| dateCreated |
Carimbo de data/hora da data de criação da solicitação |
Data e hora |
| ID do inquilino |
ID do locatário do cliente da solicitação |
GUID |
| ID do pedido |
ID exclusivo para a solicitação. |
GUID |
| Relatório |
ID exclusivo para a instância do relatório. |
GUID |
| estado |
Enumeração do < da solicitação de relatório c0> status</c0> |
corda |
| mensagem de status |
Mensagem expandida para o status |
corda |
| nome_do_modelo_relatório |
Nome do modelo para o reportId. Cada tipo de modelo contém informações de chamada diferentes. (por exemplo, listas, resumos, etc.) |
corda |
| rowLimitExceeded |
Valor booleano que indica se a saída do relatório está truncada com base no limite de linha configurado. |
Bool |
Resultados do relatório
#
| Pedir |
Descrição |
Tipo |
| ID do pedido |
ID exclusivo para a solicitação. |
GUID |
| ID do inquilino |
ID do locatário do cliente da solicitação |
GUID |
| pedir |
O objeto de solicitação contém detalhes sobre o relatório, incluindo informações sobre campos retornados, classificação e filtros aplicados. |
Objeto de solicitação |
| queryDuration |
Tempo necessário para extrair dados para a solicitação em milissegundos. |
int |
| totalDuração |
Tempo necessário para executar a solicitação em milissegundos. |
corda |
| queryCount |
Número de registros processados para o relatório |
int |
| contagem total |
Número de registros retornados no relatório |
corda |
| rowLimitExceeded |
Valor booleano que indica se a saída do relatório está truncada com base no limite de linha configurado |
corda |
| dados |
Uma matriz de linhas de dados que contém o resultado do relatório. Use as informações displayFields no objeto Request para identificar os detalhes dos dados retornados. Nota: Se um campo específico for referenciado em ' camposdeexibição' não existe na linha de dados, está vazio (string) ou falso (bool). |
Array |
| resumo |
Se aplicável, contém dados de linha de resumo para cada linha na matriz de dados. |
Array |
Objeto de solicitação
#
| Pedir |
Descrição |
Tipo |
| ID do pedido |
ID exclusivo para a solicitação. |
GUID |
| dateCreated |
Carimbo de data/hora da data de criação da solicitação |
Data e hora |
| ID do inquilino |
ID do locatário do cliente da solicitação |
GUID |
| Relatório |
ID exclusivo para a instância do relatório. |
GUID |
| nome_do_modelo_relatório |
Nome do modelo para o reportId. Cada tipo de modelo contém informações de chamada diferentes. (por exemplo, listas, resumos, etc.) |
corda |
| filterConditions |
Detalhes do filtro aplicado ao relatório |
Objeto |
| sortFields |
Matriz de ordens de classificação aplicadas a 1 ou mais campos. |
Matriz (Ordem de classificação) |
| campos de exibição |
Matriz de campos que são retornados para cada linha no relatório |
Matriz (Campo de exibição) |
| childDisplayFields |
Matriz de campos filho que são retornados para cada linha no relatório (se aplicável) |
corda |
| metadados |
Outras informações sobre o relatório devolvido |
Objeto |
Objeto de ordem de classificação
#
| Pedir |
Descrição |
Tipo |
| nome_do_campo |
Nome do ID para o campo |
corda |
| direção |
Enumeração para a ordem de classificação aplicada a este campo |
Ordem de classificação |
Exibir objeto de campo
#
| Pedir |
Descrição |
Tipo |
| nome_do_campo |
Nome do ID para o campo |
corda |
| obrigatório |
Valor booleano que indica se o campo é obrigatório para o relatório |
Bool |
Enumerações
#
Estado
#
| Valor |
Descrição |
| Começo |
Inicializando a consulta |
| Contando |
Contagem de linhas de dados aplicáveis |
| Consultar |
Consultar dados aplicáveis para o banco de dados |
| Processados |
Processando os dados do relatório. |
| Classificação |
Classificando os dados do relatório. |
| Totalizando |
Preenchendo campos de total |
| TotalingPercent |
Preenchendo campos de % total |
| Converter |
Conjunto de dados de retorno do convertig |
| Completar |
Concluído |
Filtros de data predefinidos
#
| Valor |
Descrição |
| Hoje |
Dados de hoje até 15 minutos antes da execução do relatório |
| Ontem |
Dados do dia anterior. |
| Esta semana |
Dados da semana atual. |
| Semana passada |
Dados da semana anterior. |
| Este mês |
Dados do mês atual. |
| Último mês |
Dados do mês anterior. |
| Este trimestre |
Dados do trimestre atual |
Ordem de classificação
#
| Valor |
Descrição |
| Ascendente |
1 |
| Descendente |
2 |