Retrieve all job targets

Request

Lists all the targets associated with a job that match the criteria.

Security

OAuth2

Path

idinteger, (int64)required

The ID for the job, for example, 39596.

Query

statestring

The state of the job targets.

Example:state=Completed

conditionstring

The condition of the job targets.

Example:condition=Pending

typestring

The type of the job targets.

Example:type=Import

locationstring

The location of the targets. This is a full string match.

skipinteger, (int32)

The number of items to skip.

Default:0

takeinteger, (int32)

The number of items to take.

Default:25

culturesArray of strings

List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included.

curl -i -X GET \
  'https://your-server/api/jobs/{id}/targets?state=Completed&condition=Pending&type=Import&location=string&skip=0&take=25&cultures=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation.

Bodyapplication/json

last_hit_dataArray of strings or null

The last returned hits, which are used to fetch the next page of results.

itemsArray of objects or null(EntityResource)

Gets or sets the list of items.

total_itemsinteger or null, (int64)

Gets or sets the total number of items.

returned_itemsinteger or null, (int64)

Gets or sets the number of returned items.

offsetinteger or null, (int32)

Gets or sets the offset of the items.

nextobject(Link)

Represents a link to a resource.

previousobject(Link)

Represents a link to a resource.

identifierstring or null

Gets or sets the identifier of the resource.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property

Response

{
  "last_hit_data": [
    "string"
  ],
  "items": [
    { … }
  ],
  "total_items": 0,
  "returned_items": 0,
  "offset": 0,
  "next": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "previous": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "identifier": "string",
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}