Fields - Get Cascade Delete Job Details
指定したフィールドの連鎖削除ジョブを取得します。
GET {endpoint}/fields/cascade-delete/{jobId}?api-version=2023-11-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net) |
job
|
path | True |
string |
ジョブの ID。 |
api-version
|
query | True |
string |
要求された API バージョン |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Authorization | True |
string |
承認された API 呼び出しに対して有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザー キャッシュをクリアする必要がある場合があることに注意してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
エラー ヘッダー x-ms-error-code: string |
セキュリティ
Authorization
承認された API 呼び出しに対して有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザー キャッシュをクリアする必要がある場合があることに注意してください。
型:
apiKey
/:
header
例
Fields_GetCascadeDeleteJobDetails
要求のサンプル
GET {endpoint}/fields/cascade-delete/JOB123?api-version=2023-11-01-preview
応答のサンプル
{
"id": "JOB123",
"status": "Succeeded",
"message": "Job completed successfully.",
"durationInSeconds": 14.7977857,
"createdDateTime": "2021-04-19T11:31:20Z",
"lastActionDateTime": "2021-04-19T11:31:34Z",
"startTime": "2021-04-19T11:31:19Z",
"endTime": "2021-04-19T11:31:34Z",
"partyId": "PARTY123",
"resourceId": "FIELD123",
"resourceType": "field"
}
定義
名前 | 説明 |
---|---|
Cascade |
連鎖削除ジョブのスキーマ。 |
Error |
Azure AgPlatform サービスからのエラー。 |
Error |
Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。 |
Inner |
エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
Job |
ジョブの状態。 指定できる値は、'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled' です。 |
CascadeDeleteJob
連鎖削除ジョブのスキーマ。
名前 | 型 | 説明 |
---|---|---|
createdDateTime |
string |
dateTime で作成されたジョブ。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 |
durationInSeconds |
number |
ジョブの実行時間 (秒単位)。 |
endTime |
string |
ジョブの終了時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 |
errorCode |
string |
ジョブが失敗した場合のエラー コード。 |
id |
string |
一意のジョブ ID。 |
lastActionDateTime |
string |
ジョブは dateTime で最後に処理されました。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 |
message |
string |
ジョブの詳細をキャプチャするステータス メッセージ。 |
partyId |
string |
パーティ ID。 |
resourceId |
string |
リソースの ID。 |
resourceType |
string |
リソースの型。 |
startTime |
string |
ジョブの開始時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 |
status |
ジョブの状態。 指定できる値は、'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled' です。 |
Error
Azure AgPlatform サービスからのエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセット。 |
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
|
message |
string |
人が判読できるエラーの表現。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。
名前 | 型 | 説明 |
---|---|---|
error |
Azure AgPlatform サービスからのエラー。 |
|
traceId |
string |
一意のトレース ID。 |
InnerError
エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
名前 | 型 | 説明 |
---|---|---|
code |
string |
を含むエラーによって提供されたエラー コードよりも具体的なエラー コード。 |
innererror |
エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
JobStatus
ジョブの状態。 指定できる値は、'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled' です。
名前 | 型 | 説明 |
---|---|---|
Cancelled |
string |
|
Failed |
string |
|
Running |
string |
|
Succeeded |
string |
|
Waiting |
string |