Job description

Create or update the job description

Creates a job description entity if it does not exist or updates the job description entity. It confirms that the job exists and that the user has permission to access it. Properties or relations not included in the request will be set to null.

put/api/jobs/{id}/description

Request

Base URL
https://your-server
Auth
OAuth 2
Authorization code/oauth/authorize
Client credentials
Token URL/oauth/token
TypeScript
https://skmtc.dev/sitecore/apis/jobs-api/docs/api/jobs/:id/description/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The ID for the job, for example 39596.

Request body

idinteger nullable

The unique job description ID.

identifierstring nullable

The unique job description identifier.

propertiesobject nullable

The job description properties.

relationsobject nullable

The job description relations.

is_root_taxonomy_itemboolean nullable

A value indicating whether the job description is a root taxonomy item.

is_path_rootboolean nullable

A value indicating whether the job description is a path root.

is_system_ownedboolean

A value indicating whether the job description is system owned.

inherits_securityboolean

A value indicating whether the job description inherits security.

Response

Job description successfully created.

Changes

No recorded changes to this operation across all 1 revision of this API.