compute_and_jobs

2025.11

The Compute API enables users to submit and execute SAS code using REST calls. Users can manage Compute contexts, create sessions, submit jobs, and access information about the session.


Compute

2025.09

2025.10

2025.08

2025.07

2025.03

2024.09

2024.03

Viya_35

This API defines the replacements for SAS Application Servers that have been used throughout SAS Version 9.

  There are endpoints that are described by this API that enable you to use create,
read, update, and delete operations to define a Compute context. A Compute context is analogous to the SAS Application Server from SAS V9.
There are also endpoints that enable you to request a SAS Compute Server session. This session runs on a SAS Compute Server and serves as the access point to SAS client processing in this environment. This session functions as the replacement for SAS Workspace Server and SAS Stored Process Server functionality from SAS V9.

A context is created for a user. Context names should be specific to each application or product that they pertain to. For example, SAS Studio might have a context that is named 'SASStudio'. A context contains all the information that is needed to instantiate sessions from that context.

To execute SAS code, request a session by POST to a URL, such as /compute/sessions/?contextName=SASStudio. Either a SAS Compute Server instance is found that matches the request or a new instance is started. A server is assigned a GUId that is used to identify it. A new session is created for a user in the SAS Compute Server, links to the session are created, and other server links are provided. Sessions are assigned a counter identifier, such as 001 or 002. You can then issue a POST request to the session URI with that identifier. For example, use the /compute/sessions/001/job path to execute SAS code in session 001. Include the code that you want to execute in the body of the POST request.

Links to a job are provided in the response to the POST request to execute code. These links enable you to execute and access multiple submissions from the same session. To access the state of a submission, the results, the log, or listings that are generated by code execution, use the links that are provided in the response to POST for a job. For example, sessions/001/jobs/1/log accesses the log that is generated by the first submission to session 001.

>

Updates the name, label, format, or informat information for a specified column.

Table Column

Specifies the information to update for the column.

Specifies the ETag of the column that you are updating.

If-Match

sessionId

libref

Specifies the table that contains the column to update.

tableName

columnName

Specifies a tag that identifies the revision of this object.

ETag

Error

application/vnd.sas.error

No resource exists at the requested path.

The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resources last modified timestamp.

The request headers did not include an `If-Match` or `If-Unmodified-Since` precondition.

Update column information

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

Provides a request to generate a column collection.

Column Request

Provides information about the context that is stored for a service.

Context

Enables the creation of a new Compute context.

Context Creation Request

Provides summary information about the context that is stored for a service.

Context Summary

Provides a paginated collection of context summaries.

Context Summary Collection

Provides a collection that contains the members of a directory-based fileref object.

Directory Collection

Describes a member of a directory-based fileref object.

Directory Member

Provides information about a resource from a different service that can be referenced by the Compute service.

External Resource

Provides properties of a file or directory object.

File Properties

Provides a collection that contains the members of a directory.

File Properties Collection

File Request Properties

File Resource

Provides a description of a SAS fileref object.

Fileref

Enables you to create a new SAS fileref object.

Fileref Creation Request

Provides summary information about a SAS fileref.

Fileref Summary

Provides a collection of fileref summaries.

Fileref Summary Collection

Provides a collection of format summaries.

Format Summary Collection

Provides a description of a job that has been submitted to a Compute session.

Job Collection

Provides a collection of line objects that comprise the output for a job.

Job Listing

Provides a collection of line objects that comprise the log for a job.

Job Log

Provides an object that you use to request a new job in a Compute session.

Job Request

Job Statistics

Provides information about the Launch context that is used by the Compute service.

Launch Context

Library

Library Assignment Request

Library Concatenation

Library Summary

Provides a collection of library summaries.

Library Summary Collection

Provides an individual line from a log or listing resource.

Line

A link to a related operation or resource.

Link

Provides information about the output for a session or job.

Listing Statistics

Provides information about the log for a session or a job.

Log Statistics

Requests that session or job log or listing output be uploaded to the Files service.

Output Stream Request to Files Service

Provides data from a table for use in building prompts

Prompt Content

Contains the formatted and raw row data for prompt content

Prompt Content Data

Provides a request that you can use to build prompt content based on a given dataset.

Prompt Content Request

Provides a result that was created by a job and that is available for use by a consumer of a service.

Result

Provides a paginated collection of result objects.

Result Collection

Provides a paginated collection of table rows.

Row Collection

Provides data from a table in row set formation.

Row Set

Provides a request that you can use to generate a row set.

Row Set Request

Provides a request that you can use to obtain rows from a table or data set.

Rows Request

Provides a running SAS Compute Server process.

SAS Compute Server

Provides a summary of a SAS Compute Server process that is currently running.

SAS Compute Server Summary

Provides a paginated collection of server summary objects.

SAS Compute Server Summary Collection

Provides a description of a SAS LIBNAME engine.

SAS Engine

Provides a paginated collection of SAS engine objects.

SAS Engine Collection

Provides the SAS options and initialization code that is used by the Compute service and its sessions.

SAS Environment

Provides a description of a SAS format or informat.

SAS Format

Provides a summary of a SAS format or informat.

SAS Format Summary

Describes a SAS macro variable that is available from the current session.

SAS Macro Variable

Provides a paginated collection of SAS macro variables.

SAS Macro Variable Collection

Specifies information about a SAS option that is used in the current session.

SAS Option

Session

Provides a collection of line objects that comprise the output for a session.

Session Listing

Provides a collection of line objects that comprise the log for a session.

Session Log

Provides an object that you use to request a new Compute session.

Session Request

Session Statistics

Provides a Compute session summary object.

Session Summary

Provides a paginated collection of Compute session summaries.

Session Summary Collection

Specifies the format to use for values in a column.

Simple Column Formatting

Provides information about a SAS table or data set.

Table

Provides a paginated collection of table columns.

Table Column Collection

Specifies information that you use to access data sets or tables that are protected. Provide password values in the format password-type=password. Possible values for password-type are "ALTER", "PW", "READ", or "WRITE". A password value must be a valid eight-character SAS name.

Table Protection Information

Provides sorting options to use with a table or data set.

Table Sorting Request

Table Summary

Provides a paginated collection of SAS table or data set summaries.

Table Summary Collection

Provides general information about a task, its status, and any errors encountered during execution.

Task

Provides an object that you use to execute a task.

Task Request

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

Specifies the format to apply to a column when retrieving data from a cell.

User Specified Column Formatting

Provides information about a SAS table view.

View

Provides a request that you can use to create a view on a table or data set.

Name	Type	Required	Description
columnName	string	true	Specifies the column name to update.
libref	string<object-id>	true	Specifies the libref for the request.
sessionId	string<object-id>	true	Specifies the ID of the session.
tableName	string<object-id>	true	Specifies the table that contains the column to update.

Name	Type	Required	Description
version	integer<int32>	false	Specifies the version number of this representation schema. This is version 2.
id	string<object-id>	false	Specifies the identifier for this column.
name	string	false	Specifies the name for this column.
index	integer<int32>	false	Specifies the numerical index for this column. This is a zero-based index.
label	string	false	Specifies the label for this column. The label is optional.
length	integer<int32>	false	Specifies the length of the data in this column.
byteLength	integer<int32>	false	Specifies the byte length of the data in this column. This parameter is set to the same value as the Length field. Support for this parameter was added in version 2.
charLength	integer<int32>	false	Specifies the character length of the data in this column. This is set to same value as length for CHAR data type, the specified length for bounded VARCHAR data type, and "-1" for all other data types. Support for this parameter was added in version 2.
type	string	false	Specifies the data type of the column.
format	Simple Column Formatting	false	Specifies the format to use for values in a column.
informat	Simple Column Formatting	false	Specifies the format to use for values in a column.

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No resource exists at the requested path.		Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resources last modified timestamp.		Schema
428	Precondition Required	The request headers did not include an `If-Match` or `If-Unmodified-Since` precondition.		Schema

Update column information

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses