Получение API запросов отчетов для коммерческой платформы

API получения запросов отчетов получает все запросы, доступные для использования в отчетах. Он получает все системные и пользовательские запросы по умолчанию.

Синтаксис запроса

Method	URI запроса
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Заголовок запроса

Верхний колонтитул	Тип	Description
Авторизация	строка	Обязательный. Маркер доступа Microsoft Entra в форме Bearer <token>
Тип контента	строка	Application/JSON

Параметр пути

нет

Параметр запроса

Имя параметра	Тип	Обязательное поле	Description
queryId	строка	Нет	Фильтр для получения сведений только о запросах с идентификатором, заданным в аргументе
queryName	строка	Нет	Фильтр для получения сведений только о запросах с именем, заданным в аргументе
IncludeSystemQueries	boolean	No	Включите предопределенные системные запросы в ответ. Значение по умолчанию — True.
IncludeOnlySystemQueries	boolean	No	Включите только системные запросы в ответ. Значение по умолчанию — False

Полезные данные запроса

нет

Словарь терминов

нет

Response

Полезные данные ответа имеют следующий формат:

Код ответа: 200, 400, 401, 403, 404, 500

Полезные данные ответа:

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

Словарь терминов

В этой таблице описаны основные определения элементов в ответе.

Параметр	Description
QueryId	Уникальный UUID запроса
Name	Имя, присвоенное запросу при создании запроса
Description	Описание, заданное при создании запроса
Query	Строка запроса отчета
Type	Задайте значение userDefined для созданных пользователем запросов и system для предварительно определенных системных запросов.
User	Идентификатор пользователя, создавшего запрос
CreatedTime	Время создания запроса
TotalCount	Число наборов данных в массиве Value.
StatusCode	Код результата. Возможные значения — 200, 400, 401, 403, 500