Sitecore API catalog
/
Jobs API
/
Targets

Jobs API (v2.0)

Use the Jobs API to retrieve, create, update, and delete job targets or the job description. This REST API lets you interact with:

  • M.Target entities, which are targets of a job.
  • The M.JobDescription entity, which contains information about what to do and what is in progress.

Note
To help you switch to the Jobs API, we provide guidance on how to update calls in your code.

Authentication

To use the Try it feature of the Jobs API, you need:

Download OpenAPI description
index.json
index.yaml
Overview
License closed source
Languages
Servers
https://{server}/

Jobs

The Jobs endpoint is used to retrieve a specific job.

Operations

Job description

The Jobs description entity contains information for the worker about what needs to be done and what is in progress.

Operations

Targets

A target entity is a target of a job (meaning a background processes). Each job can have one or more targets.

Operations

Create a job target

Request

Creates a new target for the specified job and returns the job target ID, for example 39605.

Path
idinteger(int64)required

The ID for the job target, for example 39605. An ID of 0 creates a new ID.

Bodyapplication/jsonrequired

The request containing the updated target information.

idinteger or null(int64)

Gets or sets the entity ID.

identifierstring or null

Gets or sets the entity identifier.

propertiesobject or null

Gets or sets the properties of the entity.

relationsobject or null

Gets or sets the relations of the entity.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

entitydefinitionobject(Link)

A link to the user who created this job.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

selfobject(Link)

A link to the user who created this job.

curl -i -X POST \
  'https://your-server/api/jobs/{id}/targets' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {
        "parents": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "parent": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "children": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "child": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "inherits_security": true,
        "parent_total": 0,
        "child_total": 0,
        "self": {
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        }
      },
      "property2": {
        "parents": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "parent": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "children": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "child": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "inherits_security": true,
        "parent_total": 0,
        "child_total": 0,
        "self": {
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        }
      }
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_system_owned": true,
    "inherits_security": true,
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    }
  }'

Responses

Target successfully created.

Retrieve all job targets

Request

Retrieves all the targets associated with a job.

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?condition=string&cultures=string&location=string&skip=0&state=string&take=25&type=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)

A link to the user who created this job.

previousobject(Link)

A link to the user who created this job.

identifierstring or null

Gets or sets the identifier of the resource.

selfobject(Link)

A link to the user who created this job.

property name*anyadditional property
Response
application/json
{
  "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
}

Retrieve a specific job target

Request

Using the job ID and the target ID retrieves a job.

Path
idinteger(int64)required

The ID for the job, for example 39596.

targetIdinteger(int64)required

The target ID, for example 34489.

Query
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/{targetId}?cultures=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation.

Bodyapplication/json
idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity. It must be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. For example, nYrCIN0aQxCqY4qbHbwAlg.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

A link to the user who created this job.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

A link to the user who created this job.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

A link to the user who created this job.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

A link to the user who created this job.

copyobject(Link)

A link to the user who created this job.

copyasyncobject(Link)

A link to the user who created this job.

permissionsobject(Link)

A link to the user who created this job.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

A link to the user who created this job.

saved_selectionsobject(Link)

A link to the user who created this job.

rolesobject(Link)

A link to the user who created this job.

annotationsobject(Link)

A link to the user who created this job.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

A link to the user who created this job.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

A link to the user who created this job.

property name*anyadditional property
Response
application/json
{
  "id": 0,
  "identifier": "string",
  "cultures": [
    "string"
  ],
  "properties": {
    "property1": {},
    "property2": {}
  },
  "relations": {
    "property1": {},
    "property2": {}
  },
  "created_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "created_on": "2019-08-24T14:15:22Z",
  "modified_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modified_on": "2019-08-24T14:15:22Z",
  "locked_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "locked_on": "2019-08-24T14:15:22Z",
  "entitydefinition": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copy": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copyasync": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "permissions": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "requested_permissions": {
    "property1": true,
    "property2": true
  },
  "lifecycle": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "saved_selections": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "roles": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "annotations": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "is_root_taxonomy_item": true,
  "is_path_root": true,
  "inherits_security": true,
  "is_system_owned": true,
  "version": 0,
  "full": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modules": [
    "string"
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}

Update a job target

Request

Updates a target associated with a job. It ensures that both the job and target exist and that the user has access to them. Properties or relations not included in the request will be set to null.

Path
idinteger(int64)required

The ID for the job, for example 39596.

targetIdinteger(int64)required

The target ID, for example 39595.

Bodyapplication/jsonrequired

The request containing the updated target information.

idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity. It must be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. For example, nYrCIN0aQxCqY4qbHbwAlg.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

A link to the user who created this job.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

A link to the user who created this job.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

A link to the user who created this job.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

A link to the user who created this job.

copyobject(Link)

A link to the user who created this job.

copyasyncobject(Link)

A link to the user who created this job.

permissionsobject(Link)

A link to the user who created this job.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

A link to the user who created this job.

saved_selectionsobject(Link)

A link to the user who created this job.

rolesobject(Link)

A link to the user who created this job.

annotationsobject(Link)

A link to the user who created this job.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

A link to the user who created this job.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

A link to the user who created this job.

property name*anyadditional property
curl -i -X PUT \
  'https://your-server/api/jobs/{id}/targets/{targetId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "cultures": [
      "string"
    ],
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {},
      "property2": {}
    },
    "created_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "created_on": "2019-08-24T14:15:22Z",
    "modified_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modified_on": "2019-08-24T14:15:22Z",
    "locked_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "locked_on": "2019-08-24T14:15:22Z",
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copy": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copyasync": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "permissions": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "requested_permissions": {
      "property1": true,
      "property2": true
    },
    "lifecycle": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "saved_selections": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "roles": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "annotations": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "inherits_security": true,
    "is_system_owned": true,
    "version": 0,
    "full": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modules": [
      "string"
    ],
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "property1": null,
    "property2": null
  }'

Responses

Entity successfully updated or deleted.

Partially update a job target

Request

Partial update on a target associated with a job. It ensures that the job and target exist and that the user has access to them. The properties and relations included in the request will be updated.

Path
idinteger(int64)required

The ID for the job, for example 39596.

targetIdinteger(int64)required

The ID for the target, for example 39594.

Bodyapplication/jsonrequired

The request containing the updated target information.

idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity. It must be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. For example, nYrCIN0aQxCqY4qbHbwAlg.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

A link to the user who created this job.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

A link to the user who created this job.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

A link to the user who created this job.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

A link to the user who created this job.

copyobject(Link)

A link to the user who created this job.

copyasyncobject(Link)

A link to the user who created this job.

permissionsobject(Link)

A link to the user who created this job.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

A link to the user who created this job.

saved_selectionsobject(Link)

A link to the user who created this job.

rolesobject(Link)

A link to the user who created this job.

annotationsobject(Link)

A link to the user who created this job.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

A link to the user who created this job.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

A link to the user who created this job.

property name*anyadditional property
curl -i -X PATCH \
  'https://your-server/api/jobs/{id}/targets/{targetId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "cultures": [
      "string"
    ],
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {},
      "property2": {}
    },
    "created_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "created_on": "2019-08-24T14:15:22Z",
    "modified_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modified_on": "2019-08-24T14:15:22Z",
    "locked_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "locked_on": "2019-08-24T14:15:22Z",
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copy": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copyasync": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "permissions": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "requested_permissions": {
      "property1": true,
      "property2": true
    },
    "lifecycle": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "saved_selections": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "roles": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "annotations": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "inherits_security": true,
    "is_system_owned": true,
    "version": 0,
    "full": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modules": [
      "string"
    ],
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "property1": null,
    "property2": null
  }'

Responses

Entity successfully updated.

Delete a job target

Request

Deletes a target for a job using its ID.

Path
idinteger(int64)required

The ID for the job, for example 39596.

targetIdinteger(int64)required

The target ID, for example, 39595.

curl -i -X DELETE \
  'https://your-server/api/jobs/{id}/targets/{targetId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Entity successfully deleted.