compute_and_jobs

2024.11

2024.12

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

2024.08

2024.10

2024.09

2024.03

2023.03

2023.10

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.

>

Returns rows in CSV format for a specified data set.

sessionId

libref

Specifies the table or data set to query.

tableName

Specifies the offset of the first row to return.

start

(Optional) Specifies the maximum number of rows to return. If not set, all rows are returned.

limit

Specifies whether to format the data in the cells. When false, decimal values are formatted based on the value of SAS Option DECIMALCONV. If more accuracy and better precision with more significant digits is desired, then set DECIMALECONV=STDIEEE. This SAS Option can be configured within a context's or a session's environment options. The session's environment options can be specified when the session is created or while the session is running using the updateOptionValue endpoint.

format

Specifies whether the first value in the cell is the index of the requested row. Support for this parameter was added in version 2.

includeIndex

Specifies that a standard SAS WHERE clause has been used to return the rows for this request.

where

Specifies whether the first row that is returned consists of column names.

includeColumnNames

Specifies the character to use as the column separator. If no character is specified, a comma is used as the separator.

columnSeparator

Specifies the characters to use as the row separator. If no characters are specified, a line feed character (\n) is used.

rowSeparator

Specifies whether values that contain special characters are quoted.

enableQuoting

Specifies whether special characters in values are escaped if the value is not quoted.

enableEscaping

If set to true, SAS missing values found in the data will be formatted based on the setting of the SAS Option MISSING.   Otherwise, a NULL value will be returned.

formatMissingValues

If set to true, SAS numeric values found in the data will be returned as strings.

returnNumAsString

Content-Type

No resource exists at the requested path.

Get row information as comma-separated values

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

External Resource

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

Launch Context

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

SAS Environment

Enables the creation of a new Compute context.

Context Creation Request

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

Context

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 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 information about the log for a session or a job.

Log Statistics

Provides information about the output for a session or job.

Listing Statistics

Session Statistics

Session

Provides a Compute session summary object.

Session Summary

Provides a paginated collection of Compute session summaries.

Session Summary Collection

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

Session Request

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

Job Request

Job Statistics

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

Job Collection

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 an individual line from a log or listing resource.

Line

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

Session Log

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

Job Log

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

Job Listing

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

Session Listing

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

Output Stream Request to Files Service

Library Concatenation

Library

Library Summary

Provides a collection of library summaries.

Library Summary Collection

Library Assignment Request

Provides information about a SAS table or data set.

Table

Table Summary

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

Table Summary Collection

Table Column

Provides a request to generate a column collection.

Column Request

Provides a paginated collection of table columns.

Table Column Collection

Provides a paginated collection of table rows.

Row Collection

Provides data from a table in row set formation.

Row Set

Provides summary information about a SAS fileref.

Fileref Summary

Provides a collection of fileref summaries.

Fileref Summary Collection

Provides a description of a SAS fileref object.

Fileref

Enables you to create a new SAS fileref object.

Fileref Creation Request

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

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

Provides a description of a SAS LIBNAME engine.

SAS Engine

Provides a paginated collection of SAS engine objects.

SAS Engine Collection

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

SAS Option

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

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 request that you can use to create a view on a table or data set.

View Request

Provides information about a SAS table view.

View

Provides properties of a file or directory object.

File Properties

File Request Properties

Provides a collection that contains the members of a directory.

File Properties Collection

Provides a summary of a SAS format or informat.

SAS Format Summary

Provides a description of a SAS format or informat.

SAS Format

Provides a collection of format summaries.

Format Summary Collection

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

User Specified Column Formatting

Specifies the format to use for values in a column.

Simple Column Formatting

Contains the formatted and raw row data for prompt content

Prompt Content Data

Provides data from a table for use in building prompts

Prompt Content

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

Prompt Content Request

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

File Resource

Error

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

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

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
404	Not Found	No resource exists at the requested path.

Get row information as comma-separated values

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses

Name	Type	Required	Description
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 or data set to query.

Name	Type	Required	Description
columnSeparator	string	false	Specifies the character to use as the column separator. If no character is specified, a comma is used as the separator.
enableEscaping	boolean	false	Specifies whether special characters in values are escaped if the value is not quoted. Default: true
enableQuoting	boolean	false	Specifies whether values that contain special characters are quoted. Default: true
format	boolean	false	Specifies whether to format the data in the cells. When false, decimal values are formatted based on the value of SAS Option DECIMALCONV. If more accuracy and better precision with more significant digits is desired, then set DECIMALECONV=STDIEEE. This SAS Option can be configured within a context's or a session's environment options. The session's environment options can be specified when the session is created or while the session is running using the updateOptionValue endpoint. Default: true
formatMissingValues	boolean	false	If set to true, SAS missing values found in the data will be formatted based on the setting of the SAS Option MISSING. Otherwise, a NULL value will be returned.
includeColumnNames	boolean	false	Specifies whether the first row that is returned consists of column names.
includeIndex	boolean	false	Specifies whether the first value in the cell is the index of the requested row. Support for this parameter was added in version 2. Default: false
limit	integer	false	(Optional) Specifies the maximum number of rows to return. If not set, all rows are returned.
returnNumAsString	boolean	false	If set to true, SAS numeric values found in the data will be returned as strings. Default: false
rowSeparator	string	false	Specifies the characters to use as the row separator. If no characters are specified, a line feed character (\n) is used.
start	integer	false	Specifies the offset of the first row to return. Default: 0
where	string	false	Specifies that a standard SAS WHERE clause has been used to return the rows for this request.