Job Router Operations - Unassign Job

Служба:

Communication

Версия API:

2023-11-01

Отмена назначения задания.

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

Параметры URI

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

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

Имя	Тип	Описание
suspendMatching	boolean	Если suspendMatching имеет значение true, задание не помещается в очередь для повторного сопоставления с рабочей ролью.

Ответы

Имя	Тип	Описание
200 OK	UnassignJobResult	Запрос выполнен успешно.
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

Примеры

Un-assign a job

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

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:unassign?api-version=2023-11-01

{
  "suspendMatching": false
}

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

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

200

{
  "jobId": "8780b28c-7079-4de1-9143-4d369289e958",
  "unassignmentCount": 1
}

Определения

Имя	Описание
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.
UnassignJobOptions	Запрос полезных данных для отмены назначения задания.
UnassignJobResult	Полезные данные ответа после успешного отмены назначения задания.

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	Внутренняя ошибка.

UnassignJobOptions

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

Имя	Тип	Описание
suspendMatching	boolean	Если suspendMatching имеет значение true, задание не помещается в очередь для повторного сопоставления с рабочей ролью.

UnassignJobResult

Полезные данные ответа после успешного отмены назначения задания.

Имя	Тип	Описание
jobId	string	Идентификатор неназначенных заданий.
unassignmentCount	integer	Количество раз, когда задание не назначено. Не более 3.