compute_and_jobs

2024.09

2023.10

2024.03

2024.11

2024.10

2024.08

2024.12

The Job Definitions API enables users to manage job definitions. <details> <summary>Overview</summary> The Job Definitions API manages job definitions using the Create, Read, Update, and Delete operations. A Job Definition is a batch execution that contains a list of input parameters, a job type, and a "code" attribute. A job definition can run in multiple execution environments, based on the type of the job. Possible types might include "cas", "compute", or "rest". The "code" for a job definition depends on the job definition type. For example, for a job of type "compute", the code is SAS code; and for a job of type "rest", the code is an UnRAVL script. </details> <details> <summary>Security</summary> <ul> <li>AuthorizationAuthenticated users have access (create, update, read, delete, add, remove) to job definitions created by themselves by default. Folders API authorizations are applied to job definitions contained in folders. If there is no explicit PROHIBIT by a folder API rule to disable access granted by the job definition API, then rules on a folder have no impact. The Authorization API automatically protects any endpoints of any API that includes dependencies on it. This dependency intercepts calls to the endpoints and builds an authorization context, which is then sent to the Authorization API for evaluation. If the context is granted permission to perform the request action on that endpoint, it returns an HTTP status code of 200 and allows the request to proceed. If the context is prohibited, it returns an HTTP status code of 403 and the request does not continue further. This access is controlled by authorization rules that can be created through bootstrapping, by an administrative user, or by other methods. </li> <li>Authentication The Job Definition API is secured and only accessible by authenticated users. </li></ul> </details> <details> <summary>Terminology</summary> <ul> <li>job definition a batch execution that contains a list of input parameters, a job type, and a "code" attribute. A job definition can run in multiple execution environments, based on the type of the job. </li> </ul> </details>

Job Definitions

2023.03

Viya_35

The Job Definitions API enables users to manage job definitions. <details> <summary>Overview</summary> The Job Definitions API manages job definitions using the Create, Read, Update, and Delete operations. A Job Definition is a batch execution that contains a list of input parameters, a job type, and a "code" attribute. A job definition can run in multiple execution environments, based on the type of the job. Possible types might include "cas", "compute", or "rest". The "code" for a job definition depends on the job definition type. For example, for a job of type "compute", the code is SAS code; and for a job of type "rest", the code is an UnRAVL script. </details> <details> <summary>Security</summary> <ul> <li>AuthorizationAll authenticated users have full access (create, update, read, delete, add, remove) to job definitions by default. Folders API authorizations are applied to job definitions contained in folders. If there is no explicit PROHIBIT by a folder API rule to disable access granted by the job definition API, then rules on a folder have no impact. The Authorization API automatically protects any endpoints of any API that includes dependencies on it. This dependency intercepts calls to the endpoints and builds an authorization context, which is then sent to the Authorization API for evaluation. If the context is granted permission to perform the request action on that endpoint, it returns an HTTP status code of 200 and allows the request to proceed. If the context is prohibited, it returns an HTTP status code of 403 and the request does not continue further. This access is controlled by authorization rules that can be created through bootstrapping, by an administrative user, or by other methods. </li> <li>Authentication The Job Definition API is secured and only accessible by authenticated users. </li></ul> </details> <details> <summary>Terminology</summary> <ul> <li>job definitiona batch execution that contains a list of input parameters, a job type, and a "code" attribute. A job definition can run in multiple execution environments, based on the type of the job. </li> </ul> </details>

Returns header information and checks the status of the Job Definitions service.

The request succeeded. The service is available.

Check service availability

Job Definition Parameter Schema

Job Definition Schema

A pageable collection of job definition objects.

Job Definition Collection

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

A link to a related operation or resource.

Link

Error

The list of links to top-level resources and operations available from the root of the API.

Check service availability

Request Samples

Response Samples

Responses