compute_and_jobs

2025.07

2025.08

2025.11

2025.09

2025.10

2025.03

The Batch API provides a full suite of capabilities for Batch job execution, control, and management, including robust file handling and job monitoring.


Batch

Determines whether an endpoint is currently available.

Returns the offset of the first resource item to return. The default value is "0".

start

Limits the maximum number of resource items to return. The default value is "10".

limit

Specifies the filter criteria for returned items.

filter

Sorts returned items by the specified criteria.

sortBy

Error

application/vnd.sas.error

The query server request is not valid due to one of the following reasons: <UL> <LI> The start or limit value is not a number. <LI> The start or limit value is less than 0. <LI> The filter parameter is not a valid value. <LI> The sortBy parameter is not a valid value. </UL> See the returned error response for more information.


The requested response type is not acceptable. See the returned error response for more information and acceptable response types.

Check endpoint availability

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

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

Job request to run a command as a background task.

Batch Command Job Request

Provides information about the Launcher context and other processing information that is used by the Batch service.

Batch Context

Provides an array of context-information objects that satisfies the context-collection request.

Batch Context Collection

Provides information to create a Batch context through the transfer service.

Batch Context Import Create Request

Provides information to create a Batch context.

Batch Context Request

Batch Job

Provides an array of job-information objects that satisfies the job-collection request.

Batch Job Collection

Provides information about a job's processing state.

Batch Job State

Job request to run a SAS program as a background task.

Batch SAS Job Request

Provides information about a file set that contains files sent to and from the cluster.

File Set

Provides an array of file set information objects that satisfies the file-set collection request.

File Set Collection

Provides information about a file in a file set.

File Set File

Provides an array of file-information objects for the specified file set.

File Set File Info Collection

Job request to run a command with user interaction.

Interactive Command Job Request

Job request to run SAS interactively in line mode.

Interactive SAS Job Request

Options that are passed on every job request that describe how to process the job.

Job Launch Options

Job STDIO Input

Job STDIO Output

A link to a related operation or resource.

Link

The summarized representation of a resource. Often used in collection responses when more specific details aren't needed.

Resource Summary

Provides information about a reusable Batch server.

Reusable Batch Server

Provides an array of reusable Batch server-information objects that satisfies the server-collection request.

Reusable Batch Server Collection

This class is used to provide common attributes and behaviors around tracking who and when objects were created and modified to representation objects.

Tracked Resource

Content providers implementing the Transfer Object Provider contract use this media type to store information about the content to be transfered.

Transfer Object

Content providers implementing the Transfer Object Provider contract use this media type to provide connection information for the content to be transfered.

Name	Type	Required	Description
filter	string<filter-criteria>	false	Specifies the filter criteria for returned items.
limit	integer	false	Limits the maximum number of resource items to return. The default value is "10".
sortBy	string<sort-criteria>	false	Sorts returned items by the specified criteria.
start	integer	false	Returns the offset of the first resource item to return. The default value is "0".

Status	Meaning	Description
200	OK	The request succeeded.
400	Bad Request	The query server request is not valid due to one of the following reasons: The start or limit value is not a number. The start or limit value is less than 0. The filter parameter is not a valid value. The sortBy parameter is not a valid value. See the returned error response for more information.	Schema
406	Not Acceptable	The requested response type is not acceptable. See the returned error response for more information and acceptable response types.	Schema

Check endpoint availability

Request Samples

Response Samples

Query Parameters

Responses