次の方法で共有


Job Router Operations - Cancel Job

自由形式の取り消し理由を指定しながら、ID で既存のジョブを取り消す要求を送信します。

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

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

通信リソースの URI

jobId
path True

string

ジョブの ID。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
dispositionCode

string

ジョブの結果を示し、このフィールドに独自のカスタム値を設定します。 指定しない場合は、既定値の "Cancelled" が設定されます。

note

string

現在のタイムスタンプを持つジョブの Notes コレクションに追加されるメモ。

応答

名前 説明
200 OK

object

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

AadOauth2Auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前 説明
https://communication.azure.com/.default

Cancels a job
Submits request to cancel an existing job

Cancels a job

要求のサンプル

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

応答のサンプル

{}

Submits request to cancel an existing job

要求のサンプル

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

応答のサンプル

{}

定義

名前 説明
Azure.Core.Foundations.Error

エラー オブジェクト。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

CancelJobOptions

ジョブを取り消す要求ペイロード。

Azure.Core.Foundations.Error

エラー オブジェクト。

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

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

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

innererror

Azure.Core.Foundations.InnerError

内部エラー。

CancelJobOptions

ジョブを取り消す要求ペイロード。

名前 説明
dispositionCode

string

ジョブの結果を示し、このフィールドに独自のカスタム値を設定します。 指定しない場合は、既定値の "Cancelled" が設定されます。

note

string

現在のタイムスタンプを持つジョブの Notes コレクションに追加されるメモ。