一括編集ジョブ オブジェクト
一括編集ジョブ オブジェクトは、一括編集ジョブに関する情報を収めています。 次のプロパティが存在します。
名前 | 型 | 説明 |
---|---|---|
self | リンク | この一括編集ジョブのリソースへのリンク |
owner | リンク | この一括編集ジョブを送信したユーザー エンティティ リソースへのリンク。 |
title | ラベル | さまざまな言語で UI に表示するタイトル。 |
state_description | ラベル | 一括編集ジョブの現在の状態の説明。 |
state | 文字列 | 一括編集ジョブの状態。 可能な値: Created 、Pending 、InProgress 、Completed |
condition | 文字列 | 一括編集ジョブの条件。 可能な値: Pending 、Success 、Failure |
started_on | 文字列 | この一括編集ジョブの開始日時を ISO 8601 形式で表記した文字列。 |
completed_on | 文字列 | この一括編集ジョブの完了日時を ISO 8601 形式で表記した文字列。 |
target_count | 数値 | 一括編集ジョブに存在するターゲットの数。 |
targets_completed | 数値 | 完了したターゲットの数。 |
targets | リンク | このジョブのターゲット リソースへのリンク。 |
例
RequestResponse
{
"state_description":"InProgress",
"state":"InProgress",
"condition":"Pending",
"started_on":"...",
"completed_on":null,
"target_count":215,
"targets_completed":100,
"self":{
"href":"http://hostname/api/massedits/1493",
"title":"This mass edit job."
},
"targets":{
"href":"http/hostname/api/massedits/1493/targets",
"title":"The collection of targets for this Mass Edit Job."
}
}