Job Router Operations - Close Job
關閉已完成的作業。
POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?api-version=2023-11-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
assignment
|
path | True |
string |
作業指派的標識碼。 |
endpoint
|
path | True |
string |
通訊資源的 URI |
job
|
path | True |
string |
作業的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
closeAt |
string |
如果未提供,背景工作角色容量會隨著JobClosedEvent通知立即釋放。 如果提供,背景工作角色容量會在 UTC 的未來時間連同 JobClosedEvent 通知一起發行。 |
dispositionCode |
string |
指出作業的結果,以您自己的自定義值填入此欄位。 |
note |
string |
請注意,將會附加至具有目前時間戳之作業的 Notes 集合。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
object |
要求成功。 |
Other Status Codes |
非預期的錯誤回應。 Headers x-ms-error-code: string |
範例
Closes a completed job
Sample Request
POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:close?api-version=2023-11-01
{
"dispositionCode": "JobCompleted.",
"note": "Closing job"
}
Sample Response
{}
定義
名稱 | Description |
---|---|
Azure. |
error 物件。 |
Azure. |
包含錯誤詳細數據的回應。 |
Azure. |
物件,包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
Close |
要求關閉作業的承載 |
Azure.Core.Foundations.Error
error 物件。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
details |
導致此錯誤之特定錯誤的詳細數據陣列。 |
|
innererror |
物件,包含比目前對象有關錯誤更具體的資訊。 |
|
message |
string |
人類可讀取的錯誤表示法。 |
target |
string |
錯誤的目標。 |
Azure.Core.Foundations.ErrorResponse
包含錯誤詳細數據的回應。
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
Azure.Core.Foundations.InnerError
物件,包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
innererror |
內部錯誤。 |
CloseJobOptions
要求關閉作業的承載
名稱 | 類型 | Description |
---|---|---|
closeAt |
string |
如果未提供,背景工作角色容量會隨著JobClosedEvent通知立即釋放。 如果提供,背景工作角色容量會在 UTC 的未來時間連同 JobClosedEvent 通知一起發行。 |
dispositionCode |
string |
指出作業的結果,以您自己的自定義值填入此欄位。 |
note |
string |
請注意,將會附加至具有目前時間戳之作業的 Notes 集合。 |