1. 一括編集対象コレクション リソース

一括編集対象コレクション リソース

一括編集対象リソースのコレクションは、特定の一括編集ジョブの一括編集対象をすべて収めています。

サポートされているメソッド: GET、HEAD

GET /api/massedits/{jobid}/targets{?skip,take}

この特定の一括編集ジョブで扱う一括編集対象のコレクションを収めた一括編集対象コレクション オブジェクトが返されます。 1 つのページに収まらないほど多くの対象がある場合は、次のページを取得するためのリンクが記述されます。

チャンク

1 つのチャンクに収まらないほど多くの対象がある場合は、次のチャンクを取得するためのリンクが記述されます。

範囲設定

take パラメーターを指定すると、返される対象の数はそのパラメーター値 (最大で 100) に制限されます。 skip パラメーターを使用して、返される対象の範囲を詳しく指定することもできます。

要求の例:

GET http://hostname/api/massedits/500/targets
Host: hostname
Accept: application/json

応答の例:

HTTP/1.1 200 OK
Content-Length: content lengtha
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "items":[
        {
            "entity":{
                "href":"http://hostname/api/entities/140"
            }
            "state_description":"Pending",
            "state":"Pending",
            "condition":"Pending",
            "started_on":null,
            "completed_on":null,
            "self":{
                "href":"http://hostname/api/massedits/500/targets/1932",
                "title":"This mass edit target."
            },
            "job":{
                "href":"http://hostname/api/massedits/500",
                "title":"The Mass Edit Job that contains this target."
            }
        },
        ...
    ],
    "total_items":400,
    "returned_items":25,
    "self":{
        "href":"http://hostname/api/massedits/500/targets"
    },
    "next":{
        "href":"http://hostname/api/massedits/500/targets?skip=25"
    }
}
この記事を改善するための提案がある場合は、 お知らせください!