Job Router Operations - Unassign Job

服務:

Communication

API 版本:

2023-11-01

取消指派作業。

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

URI 參數

名稱	位於	必要	類型	Description
assignmentId	path	True	string	作業指派的標識碼。
endpoint	path	True	string	通訊資源的 URI
jobId	path	True	string	作業的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
suspendMatching	boolean	如果 SuspendMatching 為 true，則作業不會排入佇列，以便與背景工作重新比對。

回應

名稱	類型	Description
200 OK	UnassignJobResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
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
}

定義

名稱	Description
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
UnassignJobOptions	要求取消指派作業的承載。
UnassignJobResult	作業成功取消指派之後的響應承載。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

UnassignJobOptions

要求取消指派作業的承載。

名稱	類型	Description
suspendMatching	boolean	如果 SuspendMatching 為 true，則作業不會排入佇列，以便與背景工作重新比對。

UnassignJobResult

作業成功取消指派之後的響應承載。

名稱	類型	Description
jobId	string	未指派作業的標識碼。
unassignmentCount	integer	作業未指派的次數。 最多 3。