Удаление API отчетов для коммерческой платформы
При выполнении этот API удаляет все записи об отчете и записи о выполнении отчета.
синтаксис запроса
Метод | URI запроса |
---|---|
УДАЛИТЬ | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID} |
заголовок запроса
Заголовок | Тип | Описание |
---|---|---|
Авторизация | струна | Обязательно. Токен доступа Microsoft Entra в формате Bearer <token> |
Тип контента | струна | Application/JSON |
параметр пути
Никакой
параметр запроса
Имя параметра | Обязательно | струна | Описание |
---|---|---|---|
reportId |
Да | струна | Идентификатор измененного отчета |
глоссарий
Никакой
ответа
Нагрузка ответа структурирована следующим образом:
Код ответа: 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, когда отчет был создан в этом формате: гггг-ММ-ддTHH:мм:ssZ |
ModifiedTime |
Время последнего изменения отчета в формате UTC: yyyy-MM-ddTHH:mm:ssZ |
ExecuteNow |
Параметр ExecuteNow, предоставленный в теле запроса во время создания отчета |
queryStartTime |
Время начала запроса, предоставленное в полезных данных запроса во время создания отчета. Это применимо только в том случае, если для ExecuteNow задано значение True. |
queryEndTime |
Время окончания запроса, предоставленное в полезных данных запроса во время создания отчета. Это применимо только в том случае, если для ExecuteNow задано значение True. |
StartTime |
Время начала, указанное в данных запроса при создании отчета |
ReportStatus |
Состояние выполнения отчета. Возможные значения: Приостановка, Активностьи Неактивность. |
RecurrenceInterval |
Интервал повторения, предоставленный в полезных данных запроса во время создания отчета |
RecurrenceCount |
Оставшееся количество повторений для этого отчета |
CallbackUrl |
URL-адрес обратного вызова, предоставленный в теле запроса во время создания отчета |
CallbackMethod |
Метод обратного вызова, указанный в полезной нагрузке запроса при создании отчета |
Format |
Формат файлов отчета, предоставляемых в теле запроса при создании отчета |
EndTime |
Время окончания, указанное в данных запроса при создании отчета. Это применимо только в том случае, если для ExecuteNow задано значение True. |
TotalRecurrenceCount |
RecurrenceCount , предоставленный в данных запроса во время создания отчета |
nextExecutionStartTime |
Метка времени UTC, когда начнется выполнение следующего отчета. |
TotalCount |
Число записей в массиве значений |
StatusCode |
Код результата. Возможные значения: 200, 400, 401, 403, 500 |
message |
Сообщение о состоянии из выполнения API |