Partially update the job description

Request

Updates part of the job description entity. It confirms that both the job and description exist and that the user has permission to modify them. Properties or relations not included in the request will be set to null.

Security

OAuth2

Path

idinteger, (int64)required

The ID for the job, for example 39596.

Bodyapplication/jsonrequired

The request containing the updated job description information.

idinteger, (int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity.

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)

Represents a link to a resource.

created_onstring, (date-time)

The date and time when the entity was created.

modified_byobject(Link)

Represents a link to a resource.

modified_onstring, (date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

Represents a link to a resource.

locked_onstring or null, (date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

Represents a link to a resource.

copyobject(Link)

Represents a link to a resource.

copyasyncobject(Link)

Represents a link to a resource.

permissionsobject(Link)

Represents a link to a resource.

requested_permissionsobject or null

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

lifecycleobject(Link)

Represents a link to a resource.

saved_selectionsobject(Link)

Represents a link to a resource.

rolesobject(Link)

Represents a link to a resource.

annotationsobject(Link)

Represents a link to a resource.

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)

Represents a link to a resource.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property

curl -i -X PATCH \
  'https://your-server/api/jobs/{id}/description' \
  -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.