Visão geral dos relatórios #

O recurso Relatórios fornece a capacidade de consultar e executar relatórios configurados no espaço de trabalho referenciado.

/{VERSÃO}/workspaces/{WORKSPACE_ID}/reports

Interfaces disponíveis #

Interface	Descrição
Obter tudo	Retorna uma coleção de relatórios configurados.
Pós-Pedido	Publica uma solicitação para executar o relatório.
Obter status	Consulta o status da solicitação fornecida.
Obter resultados	Consulta os dados de resultado da solicitação fornecida.

Esquemas #

Relatórios #

Chave	Descrição	Tipo
ID	Identificador exclusivo para fazer referência a este relatório	GUID
Designação	Nome amigável para a instância de relatório	string

Status do relatório #

Dados	Descrição	Tipo
dateCriado	Carimbo de data/hora da data de criação do pedido	Data/Hora
inquilinoId	ID do locatário do cliente da solicitação	GUID
requestId	ID exclusivo para o pedido.	GUID
Relatório	ID exclusivo para a instância do relatório.	GUID
Situação	Enum do < do pedido de relatório c0> estado</c0>	string
statusMensagem	Mensagem expandida para o status	string
reportTemplateName	Nome do modelo para o reportId. Cada tipo de modelo contém informações de chamada diferentes. (por exemplo, listas, resumos, etc.)	string
rowLimitExceeded	Valor Bool que indica se a saída do relatório está truncada com base no limite de linha configurado.	Bool

Relatório de Resultados #

Solicitar	Descrição	Tipo
requestId	ID exclusivo para o pedido.	GUID
inquilinoId	ID do locatário do cliente da solicitação	GUID
solicitar	O objeto Request 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.	string
queryCount	Número de registos tratados para o relatório	Int
totalContagem	Número de registos devolvidos no relatório	string
rowLimitExceeded	Valor Bool que indica se a saída do relatório está truncada com base no limite de linha configurado	string
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 determinado campo referenciado em » displayFields' não existe na linha de dados, é vazio (string) ou false (bool).	Matriz
Resumo	Se aplicável, contém dados de linha de resumo para cada linha na matriz de dados.	Matriz

Objeto de solicitação #

Solicitar	Descrição	Tipo
requestId	ID exclusivo para o pedido.	GUID
dateCriado	Carimbo de data/hora da data de criação do pedido	Data/Hora
inquilinoId	ID do locatário do cliente da solicitação	GUID
Relatório	ID exclusivo para a instância do relatório.	GUID
reportTemplateName	Nome do modelo para o reportId. Cada tipo de modelo contém informações de chamada diferentes. (por exemplo, listas, resumos, etc.)	string
filterCondições	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)
displayCampos	Matriz de campos retornados para cada linha do 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)	string
metadados	Outras informações sobre o relatório devolvido	Objeto

Objeto de ordem de classificação #

Solicitar	Descrição	Tipo
fieldName	Nome da identificação do campo	string
Direção	Enum para a ordem de classificação aplicada a este campo	Ordem de classificação

Exibir objeto de campo #

Solicitar	Descrição	Tipo
fieldName	Nome da identificação do campo	string
obrigatório	Valor Bool que indica se o campo é obrigatório para o relatório	Bool

Enums #

Situação #

Valor	Descrição
Início	Inicializando a consulta
Contagem	Contagem de linhas de dados aplicáveis
Consultando	Consultar dados aplicáveis para o banco de dados
Processado	Processamento dos dados do relatório.
Classificação	Classificando os dados do relatório.
Total	Preenchimento de campos totais
TotalingPercent	Preenchimento de campos % totais
Conversão	Conversão de conjunto de dados de retorno
Concluída	Concluída

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.
Última Semana	Dados da semana anterior.
Este Mês	Dados do mês atual.
Último Mês	Dados do mês anterior.
EsteTrimestre	Dados do trimestre em curso

Ordem de classificação #

Valor	Descrição
Ascendente	1
Descendente	2

Filtros Adicionais #

Operadores #

Valor	Descrição	Aplica-se a
=	Igual	Todos os tipos de dados
!=	Não é igual	Todos os tipos de dados
>	Maior que	Duplo, Datetime
>=	Maior que ou igual a	Duplo, Datetime
<	Menos do que	Duplo, Datetime
<=	Menor que ou igual a	Duplo, Datetime
SW	Começa com.	String
NSW	Não começa por.	String
CT	Contém.	String
NCT	Não contém	String
Eca.	Termina com	String
Novo	Não termina com	String

Exemplos #

Exemplo - Direção de Chamada = Entrada #

{
    "reportId": "00000000-0000-0000-0000-00000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "Condições adicionais" : \[{
        "fieldName" : "callDir",
        "operador" : "=",
        "valores": ["2"][ "2" ]
    }]

}

Exemplo - Discagem Direta para Entrada = '(123) 456 7890' #

{
    "reportId": "00000000-0000-0000-0000-00000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "Condições adicionais" : \[{
        "fieldName" : "ddi",
        "operador" : "=",
        "valores" : ["+11234567890"][ "+11234567890" ]
    }]

}

Exemplo - A marcação direta para o interior começa com '123' #

{
    "reportId": "00000000-0000-0000-0000-00000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "Condições adicionais" : \[{
        "fieldName" : "ddi",
        "operador" : "=",
        "valores" : ["+1123"][ "+1123" ]
    }]

}

Exemplo - Números de utilizador 1002 e 1002 #

{
    "reportId": "00000000-0000-0000-0000-00000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "Condições adicionais" : \[{
        "fieldName" : "userNum",
        "operador" : "=",
        "valores": ["1001", "1002"][ "1001", "1002" ]
    }]

}