logo

Mass Edit Target Collection Resource

The Collection of Mass Edit Targets Resource contains all of the Mass Edit Targets for a specific Mass Edit Job.

Methods supported: GET, HEAD

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

Returns a Mass Edit Target Collection Object that contains the collection of all Mass Edit Targets for this particular Mass Edit Job. If there are more targets than that can fit in a single page, a link is included to retrieve the next page.

Chunking

If there are more targets than can fit in a single chunk, a link is included to retrieve the next chunk.

Ranging

If the take parameter is specified, the number of targets returned is limited to that parameter (up to 100). The skip parameter can also be included to further determine which range of targets is returned.

Example Request:

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

Example Response:

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"
    }
}

Can we improve this article ? Provide feedback