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

Управление существующими частными предложениями с помощью API

  • Статья

Api можно использовать для удаления или отзыва существующих частных предложений.

Удаление существующего частного предложения

Используйте этот метод, чтобы удалить существующее частное предложение, пока он еще находится в состоянии черновика. Необходимо использовать идентификатор частного предложения, чтобы указать, какое частное предложение нужно удалить. Для многокомпонентных частных предложений только инициатор MPO может их удалить.

Просьба

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-07-01

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

Заголовок Тип Описание
Авторизация Струна Обязательно. Токен доступа Microsoft Entra в формате Bearer <token>.

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

$version — обязательно. Это версия схемы, которая используется в запросе.

Текст запроса

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
        {
        "$schema": "https://schema.mp.microsoft.com/schema/private-offer/2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705",
        "privateOfferType": "multipartyPromotionOriginator",
        "state": "deleted"
        }
    ]
}

Ответ

Ответ содержит идентификатор задания, который можно использовать позже для проверки состояния.

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "notStarted",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "0001-01-01",
    "errors": []
}

Коды ошибок

Код состояния HTTP Описание
401 Ошибка проверки подлинности. Убедитесь, что вы используете действительный маркер доступа Microsoft Entra.
400 Проверка схемы. Убедитесь, что текст запроса соответствует правильной схеме и включает все обязательные поля.

Отзыв существующего частного предложения

Используйте этот метод для отзыва существующего частного предложения. Отмена предложения означает, что ваш клиент больше не сможет получить доступ к нему.

Заметка

Для частных предложений с участием нескольких сторон поставщик программного обеспечения может отозвать отправленное частное предложение, если торговый партнер еще не опубликовал его и не сделал доступным для конечного клиента. Партнер канала может отказаться только от опубликованного частного предложения, если клиент не принял его. Если частное предложение уже было доступно для клиента, чтобы он мог его принять, и ISV необходимо внести изменения, партнер канала должен сначала отозвать частное предложение, чтобы ISV мог затем его отозвать и вернуть в состояние черновика для изменений.

Необходимо использовать идентификатор частного предложения, чтобы указать, какое частное предложение вы хотите отозвать.

Просьба

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-07-01

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

Заголовок Тип Описание
Авторизация Струна Обязательно. Токен доступа Microsoft Entra в форме Bearer <token>.

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

$version — обязательный. Это версия схемы, которая используется в запросе.

Тело запроса (для ISV)

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
         {
        "$schema": "https://schema.mp.microsoft.com/schema/private-offer/ 2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705", 
        "privateOfferType": "multipartyPromotionOriginator",
        "state": "withdrawn"
        }
    ]
}

Текст запроса (для партнера канала)

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
         {
        $schema": "https://schema.mp.microsoft.com/schema/private-offer/ 2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705", 
        "privateOfferType": "multiPartyPromotionChannelPartner",
        "state": "withdrawn"
        }
    ]
}

Ответ

Ответ содержит идентификатор задания, который можно использовать позже для проверки состояния.

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "notStarted",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "0001-01-01",
    "errors": []
}

Коды ошибок

Код состояния HTTP Описание
401 Ошибка проверки подлинности. Убедитесь, что вы используете действительный маркер доступа Microsoft Entra.
400 Проверка схемы. Убедитесь, что текст запроса соответствует правильной схеме и включает все обязательные поля.

Связанное содержимое