Job Router Operations - Close Job
完了したジョブを閉じます。
POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?api-version=2023-11-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
assignment
|
path | True |
string |
ジョブ割り当ての ID。 |
|
endpoint
|
path | True |
string |
コミュニケーション リソースの URI |
|
job
|
path | True |
string |
ジョブの ID。 |
|
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| closeAt |
string |
指定しない場合、ワーカー容量は JobClosedEvent 通知と共にすぐに解放されます。 指定した場合、ワーカー容量は、UTC の将来の時刻に JobClosedEvent 通知と共に解放されます。 |
| dispositionCode |
string |
ジョブの結果を示し、このフィールドに独自のカスタム値を設定します。 |
| note |
string |
ジョブの Notes コレクションに現在のタイムスタンプで追加されるメモ。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
object |
要求は成功しました。 |
| Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
例
Closes a completed job
要求のサンプル
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"
}
応答のサンプル
{}定義
| 名前 | 説明 |
|---|---|
|
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 オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
error オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
| innererror |
内部エラー。 |
CloseJobOptions
ジョブを閉じるための要求ペイロード
| 名前 | 型 | 説明 |
|---|---|---|
| closeAt |
string |
指定しない場合、ワーカー容量は JobClosedEvent 通知と共にすぐに解放されます。 指定した場合、ワーカー容量は、UTC の将来の時刻に JobClosedEvent 通知と共に解放されます。 |
| dispositionCode |
string |
ジョブの結果を示し、このフィールドに独自のカスタム値を設定します。 |
| note |
string |
ジョブの Notes コレクションに現在のタイムスタンプで追加されるメモ。 |