Job Router Operations - Cancel Job

Служба:

Communication

Версия API:

2023-11-01

Отправляет запрос на отмену существующего задания по идентификатору при предоставлении причины отмены бесплатной формы.

POST {endpoint}/routing/jobs/{jobId}:cancel?api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Uri ресурса коммуникации
jobId	path	True	string	Идентификатор задания.
api-version	query	True	string	Версия API, используемая для этой операции.

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

Имя	Тип	Описание
dispositionCode	string	Указывает результат задания, заполните это поле собственными пользовательскими значениями. Если значение не указано, по умолчанию задано значение "Отменено".
note	string	Примечание, которое будет добавлено в коллекцию заметок задания с текущей меткой времени.

Ответы

Имя	Тип	Описание
200 OK	object	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

AadOauth2Auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://communication.azure.com/.default

Примеры

Cancels a job

Submits request to cancel an existing job

Cancels a job

Образец запроса

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

Пример ответа

Код состояния:

200

{}

Submits request to cancel an existing job

Образец запроса

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

Пример ответа

Код состояния:

200

{}

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	Запрос полезных данных для отмены задания.

Azure.Core.Foundations.Error

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

CancelJobOptions

Запрос полезных данных для отмены задания.

Имя	Тип	Описание
dispositionCode	string	Указывает результат задания, заполните это поле собственными пользовательскими значениями. Если значение не указано, по умолчанию задано значение "Отменено".
note	string	Примечание, которое будет добавлено в коллекцию заметок задания с текущей меткой времени.