Partilhar via

Obter API de consultas de relatório para o mercado comercial

  • Artigo

A API Obter consultas de relatório obtém todas as consultas disponíveis para uso em relatórios. Ele obtém todas as consultas definidas pelo sistema e pelo usuário por padrão.

Sintaxe de solicitação

Método Solicitar URI
OBTER https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Necessário. O token de acesso do Microsoft Entra no formato Bearer <token>
Tipo de conteúdo corda Application/JSON

Parâmetro Caminho

Nenhum

Parâmetro de consulta

Nome do parâmetro Tipo Necessário Descrição
queryId string Não Filtrar para obter detalhes de apenas consultas com o ID fornecido no argumento
queryName corda Não Filtrar para obter detalhes apenas de consultas com o nome fornecido no argumento
IncludeSystemQueries Booleano Não Inclua consultas predefinidas do sistema na resposta. O valor padrão é True.
IncludeOnlySystemQueries Booleano Não Inclua apenas consultas do sistema na resposta. O valor padrão é False

Pedido de carga útil

Nenhum

Glossário

Nenhum

Resposta

A carga útil de resposta está estruturada da seguinte forma:

Código de resposta: 200, 400, 401, 403, 404, 500

Carga útil de resposta:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Glossário

Esta tabela descreve as principais definições de elementos na resposta.

Parâmetro Descrição
QueryId UUID exclusivo da consulta
Name Nome dado à consulta no momento da criação da consulta
Description Descrição fornecida durante a criação da consulta
Query Cadeia de caracteres de consulta de relatório
Type Definir como userDefined para consultas criadas pelo usuário e system para consultas predefinidas do sistema
User ID de utilizador que criou a consulta
CreatedTime Hora de criação da consulta
TotalCount Número de conjuntos de dados na matriz Valor
StatusCode Código do resultado. Os valores possíveis são 200, 400, 401, 403, 500