Job Router Operations - Decline Job Offer

服務:

Communication

API 版本:

2023-11-01

拒絕在工作中工作的供應專案。

POST {endpoint}/routing/workers/{workerId}/offers/{offerId}:decline?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	通訊資源的 URI
offerId	path	True	string	供應項目的標識碼。
workerId	path	True	string	背景工作角色的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
retryOfferAt	string	如果未提供 RetryOfferAt，則除非背景工作取消註冊並重新註冊，否則此工作不會再次提供給拒絕此工作的背景工作。 如果提供 RetryOfferAt 時間，則作業將會在 UTC 的重試時間重新比對符合資格的背景工作。 拒絕工作的背景工作也符合當時的工作資格。

回應

名稱	類型	Description
200 OK	object	要求已成功。
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

範例

Declines an offer to work on a job

範例要求

HTTP

POST https://contoso.westus.communications.azure.com/routing/workers/DefaultWorker/offers/1d5896f3-8b54-40be-82d3-910323f5e2af:decline?api-version=2023-11-01

{
  "retryOfferAt": "2023-05-26T00:00:00.0000000Z"
}

範例回覆

狀態碼:

200

{}

定義

名稱	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。
DeclineJobOfferOptions	要求拒絕供應項目的承載。

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	內部錯誤。

DeclineJobOfferOptions

要求拒絕供應項目的承載。

名稱	類型	Description
retryOfferAt	string	如果未提供 RetryOfferAt，則除非背景工作取消註冊並重新註冊，否則此工作不會再次提供給拒絕此工作的背景工作。 如果提供 RetryOfferAt 時間，則作業將會在 UTC 的重試時間重新比對符合資格的背景工作。 拒絕工作的背景工作也符合當時的工作資格。