一括編集ジョブ コレクション リソース
一括編集ジョブ リソースのコレクションは、システムに存在するすべての一括編集ジョブを収めています。 このリソースは、新しい一括編集ジョブの投稿にも使用します。
サポートされているメソッド: GET、HEAD、POST
GET /api/massedits{?state,skip,take}
システムにあるすべての一括編集ジョブのコレクションを収めた一括編集ジョブ コレクション オブジェクトが返されます。
必要に応じて state フィルターを指定できます。このフィルターによって、指定した状態にあるジョブのみが返されます。
チャンク
1 つのチャンクに収まらないほど多くのジョブがある場合は、次のチャンクを取得するためのリンクが記述されます。
範囲設定
take パラメーターを指定すると、返されるジョブの数はそのパラメーター値 (最大で 100) に制限されます。 skip パラメーターを使用して、返されるジョブの範囲を詳しく指定することもできます。
要求の例:
RequestResponse
GET http://hostname/api/massedits?state=Pending
Host: hostname
Accept: application/json
応答の例:
RequestResponse
HTTP/1.1 200 OK
Content-Length: content lengtha
Content-Type: application/json; charset=utf-8
ETag: "hash string"
{
"items": [
... Mass Edit Job Objects
],
"next",{
"href":"http://hostname/api/massedits?skip=25"
},
"returned_items":25,
"self":{
"href":"http://hostname/api/massedits"
},
"total_items":78
}
POST /api/massedits
新しい一括編集ジョブがシステムに作成されます。 本文では、完全な一括編集ジョブ作成要求オブジェクトが想定されます。 処理に成功すると、201 Created response が返されます。この場合、Location ヘッダーには、新しく作成されたリソースの URL が含まれます。
要求の例:
RequestResponse
POST http://hostname/api/massedits
Host: hostname
Content-Type: application/json
{
"state_description":"In progress",
"collection":{
"relation":{
"href":"http://server/api/entities/23/CollectionToAsset"
},
"role":"Parent"
},
"operations":[
{
"type":"SetProperty",
"property":"AssetName",
"culture":"en-US",
"value":"New name for this asset."
},
{
"type":"SetProperty",
"property":"AssetTitle",
"value":{
"en-US":"New name for this asset.",
"nl-BE":"De naam voor dit nieuwe asset."
}
},
{
"type":"ClearRelation",
"relation":"AssetToAssetType",
"role":"Child"
},
{
"type":"AddRelation",
"relation":"AssetToAssetType",
"role":"Child",
"value":[
{
"href":"http://server/api/entities/14"
},
{
"href":"http://server/api/entities/14"
}
]
},
{
"type":"RemoveRelation",
"relation":"AssetToAssetType",
"role":"Child",
"value":[
{
"href":"http://server/api/entities/14"
}
]
}
]
}
応答の例:
RequestResponse
HTTP/1.1 201 Created
Location: http://hostname/api/massedits/5549