Отмена операции

Статья
06/14/2024

Примечание.

Программные интерфейсы портала Cloud Partner интегрированы с Центром партнеров, они продолжат в нем работу. Переход повлечет за собой небольшие изменения. Ознакомьтесь с изменениями, описанными в статье Справочные материалы по API Портала Cloud Partner, чтобы убедиться, что ваш код продолжит работать после перехода в Центр партнеров. Программные интерфейсы CPP следует использовать только для существующих продуктов, которые уже были интегрированы, до перехода в Центр партнеров; новые продукты должны использовать программные интерфейсы отправки Центра партнеров.

Этот API в настоящее время отменяет операцию на предложение. Используйте получения операций API для получения operationId, чтобы передать его в API. Отмена обычно является синхронной операцией, однако в некоторых сложных сценариях для отмены существующей операции может потребоваться новая операция. В этом случае в тексте ответа HTTP содержит расположение операции, который необходим для запроса состояния.

POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/cancel?api-version=2017-10-31

Параметры универсального кода ресурса (URI)

Имя	Description	Тип данных
publisherid	Идентификатор издателя, например `contoso`	Строка
offerId	Идентификатор предложения	Строка
api-version	Текущая версия клиента API	Дата

Имя	Value
Тип контента	application/json
Авторизация	Маркер носителя YOUR TOKEN

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

Запросить

{
   "metadata": {
     "notification-emails": "jondoe@contoso.com"
    }
}

Свойства текста запроса

Имя	Description
электронные уведомления	Список адресов электронной почты, разделенных запятыми, для получения уведомлений о ходе публикации.

Response

Перенесенные предложения

Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31

Предложения, которые не были перенесены

Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31

Заголовок ответа

Имя	Value
Расположение	Соответствующий путь для получения состояния этой операции.

Коды состояния ответа

Код	Description
200	Все в порядке. Запрос успешно обработан и выполнение операции синхронно отменяется.
202	Принято. Запрос успешно обработан и происходит отмена операции. Расположение операции отмены возвращается в заголовок ответа.
400	Неправильный/недопустимый запрос. Текст ответа ошибки может предоставлять дополнительные сведения.
403	Доступ запрещен. Клиент имеет доступ к указанному в запросе пространству имен.
404	Не найдено. Указанная сущность не существует.

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