Compartilhar 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 que estão disponíveis para uso em relatórios. Ela obtém todas as consultas definidas pelo sistema e pelo usuário por padrão.

Sintaxe da solicitação

Método URI da solicitação
GET 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 Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>
Tipo de conteúdo string Application/JSON

Parâmetro de caminho

Nenhum

Parâmetro de consulta

Nome do parâmetro Tipo Obrigatório Descrição
queryId string Não Filtrar para obter detalhes somente de consultas com a ID fornecida neste argumento
queryName string Não Filtrar para obter detalhes somente de consultas com o nome fornecido neste argumento
IncludeSystemQueries boolean Não Inclua consultas predefinidas do sistema na resposta. O valor padrão é True.
IncludeOnlySystemQueries boolean Não Inclua apenas consultas do sistema na resposta. O valor padrão é False

Carga de solicitação

Nenhum

Glossário

Nenhum

Response

A carga de solicitação é estrutura conforme a seguir:

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

Carga 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 dos elementos da resposta.

Parâmetro Descrição
QueryId UUID exclusivo da consulta
Name Nome fornecido à 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 de sistema predefinidas
User ID de usuário que criou a consulta
CreatedTime Hora da criação da consulta
TotalCount Número de conjuntos de itens na Matriz de valores
StatusCode Código de resultado. Os valores possíveis são 200, 400, 401, 403, 500