Поделиться через


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

Этот API используется для возобновления выполнения приостановленного отчета.

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

Способ URI запроса
PUT https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/resume/{reportId}

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

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

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

нет

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

Наименование параметра Обязательное поле Type Описание
reportId Да строка Идентификатор изменяемого отчета

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

нет

Response

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

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

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

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

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

Параметр Описание
ReportId Универсальный уникальный идентификатор (UUID) созданного отчета
ReportName Имя, предоставленное в полезных данных запроса во время создания отчета
Description Описание, предоставленное в полезных данных запроса во время создания отчета
QueryId Идентификатор запроса, предоставленный в полезных данных запроса во время создания отчета
Query Текст запроса, который будет выполнен для этого отчета
User Идентификатор пользователя, используемый для создания отчета
CreatedTime Время создания отчета в формате UTC: гггг-мм-ddTчч: мм: ссZ
ModifiedTime Время последнего изменения отчета в формате UTC: гггг-мм-ddTчч: мм: ссZ
ExecuteNow Параметр ExecuteNow, предоставленный в полезных данных запроса во время создания отчета
queryStartTime Время начала запроса, предоставленное в полезных данных запроса во время создания отчета. Это применимо только в том случае, если ExecuteNow задано значение True
queryEndTime Время окончания запроса, предоставленное в полезных данных запроса во время создания отчета. Это применимо только в том случае, если ExecuteNow задано значение True
StartTime Время начала, предоставленное в полезных данных запроса во время создания отчета
ReportStatus Состояние выполнения отчета. Возможные значения: Paused (Приостановлено), Active (Активно) и Inactive (Неактивно).
RecurrenceInterval Интервал повторения, предоставленный в полезных данных запроса во время создания отчета
RecurrenceCount Оставшееся число повторений для отчета
CallbackUrl URL-адрес обратного вызова, предоставленный в полезных данных запроса во время создания отчета
CallbackMethod Метод обратного вызова, предоставленный в полезных данных запроса во время создания отчета
Format Формат файлов отчета, предоставленных в полезных данных запроса во время создания отчета
EndTime Время окончания, предоставленное в полезных данных запроса во время создания отчета. Это применимо только в том случае, если ExecuteNow задано значение True
TotalRecurrenceCount RecurrenceCount в полезных данных запроса во время создания отчета
nextExecutionStartTime Метка времени UTC при запуске следующего отчета
TotalCount Число записей в массиве значений
StatusCode Код результата. Возможные значения — 200, 400, 401, 403, 500
message Сообщение о состоянии из выполнения API