Sitecore API catalog/Jobs API/
/
Create a job target

Create a job target

Request

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

Security
OAuth2
Path
idinteger, (int64)required

The ID for the job target, for example 39605.

Bodyapplication/jsonrequired

The request containing the 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)

Represents a link to a resource.

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)

Represents a link to a resource.

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.