Job description

Retrieve the job description

Retrieves the description for a specific job using its ID, for example 39595.

get/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/get.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.

Query parameters

culturesstring[]

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

Response

Successful operation.

idinteger

The ID for the entity, for example 39752.

identifierstring nullable

The identifier for the entity.

culturesstring[] nullable

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

propertiesobject nullable

The properties of the entity.

relationsobject nullable

The relations of the entity.

created_onstring date-time

The date and time when the entity was created.

modified_onstring date-time

The date and time when the entity was last modified.

locked_onstring date-time nullable

The date and time when the entity was locked.

requested_permissionsobject nullable

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

is_root_taxonomy_itemboolean nullable

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

is_path_rootboolean nullable

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

The version of the entity.

modulesstring[] nullable

The modules associated with the entity.

Changes

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