API обновления отчета

Статья
06/29/2024

Этот API помогает изменить параметр отчета.

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

Способ	URI запроса
PUT	`https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/{Report ID}`

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

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

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

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

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

нет

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

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string",
 "CallbackMethod": "string"
}

Запрос глоссария

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

Параметр	Обязательное поле	Описание	Допустимые значения
ReportName	Да	Имя, назначаемое отчету	Строка
Description	No	Описание созданного отчета	Строка
Время начала	Да	Метка времени, после которой начнется создание отчета	Строка
ПовторениеInterval	No	Периодичность создания отчета в часах. Минимальное значение — 4	Целое
Повторение	No	Число создаваемых отчетов. По умолчанию не ограничено.	Целое
Формат	No	Формат экспортируемого файла. Значение по умолчанию — CSV	CSV/TSV
CallbackURL	No	URL-адрес обратного вызова HTTPS, вызываемый при создании отчета	Строка
CallbackMethod	No	Метод Http, используемый для обратного вызова	GET/POST

Response

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

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

Пример полезных данных ответа:

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

Глоссарий ответа

В следующей таблице описаны ключевые элементы ответа.

Параметр	Описание
ReportId	Универсальный уникальный идентификатор (UUID) обновляемого отчета
ReportName	Имя, присвоенное отчету в полезных данных запроса
Description	Описание отчета в полезных данных запроса
QueryId	Идентификатор запроса, переданный во время создания отчета.
Query	Текст запроса, который будет выполнен для этого отчета
User	Идентификатор пользователя, используемый для создания отчета
CreatedTime	Время создания отчета. Формат времени: гггг-ММ-ддTЧЧ:мм:ссZ
ModifiedTime	Время последнего изменения отчета. Формат времени: гггг-ММ-ддTЧЧ:мм:ссZ
ExecuteNow	Флаг ExecuteNow, заданный во время создания отчета
Время начала	Время, когда начнется выполнение отчета. Формат времени: гггг-ММ-ддTЧЧ:мм:ссZ
ReportStatus	Состояние выполнения отчета. Возможные значения: Paused (Приостановлено), Active (Активно) и Inactive (Неактивно).
ПовторениеInterval	Интервал повторения, предоставленный в полезных данных запроса
Повторение	Число повторений, предоставленное в полезных данных запроса
CallbackUrl	URL-адрес обратного вызова, предоставленный в запросе.
CallbackMethod	Метод обратного вызова, предоставленный в запросе
Формат	Формат файлов отчета.
TotalCount	Число наборов данных в массиве Value.
Сообщение	Сообщение о состоянии из выполнения API
StatusCode	Код результата. Возможные значения — 200, 400, 401, 403, 500

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