Perform CAS Management, Jobs, and Compute server tasks

compute_and_jobs

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

The Compute API defines the replacement for the application servers that were used for SAS 9. The Compute API enables clients to perform the following tasks: <UL> <LI>Submit and execute SAS code. <LI>Obtain the SAS log or listing information from executed SAS code. <LI>View output that is generated by a SAS code submission. <LI>Access SAS data sets that are created by a SAS code submission. <LI>Access SAS filerefs that are created by a SAS code submission. <LI>Access SAS variables that are defined and used in a SAS code submission. <LI>Retrieve information about engines that are available in a session. </UL>

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.

>

Deletes a job and all job access points into a session from this job. The log, listing, and results that were created by the job are also deleted. Actual job resources are still available via the session, until the session is destroyed.

sessionId

jobId

Error

application/vnd.sas.error

No resource exists at the requested path.

Delete a job

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

This is an example of an error response for a bad request.

This is an example of an error response for a resource update conflict.

Here is the response for file resource version 4

Log File for Job b9fe292d-2a4e-434c-8154-5f490b4b9257

2022-03-31T20:00:03Z-results.log

This is an example of an error response for a request without an acceptable response type.

This is an example of an error response for a resource that is not found.

This is an example of an error response for a conditional request with an invalid precondition.

This is an example of an error response for a conditional request with a missing precondition.

This is an example of an error response for a request with payload of an unsupported type.

Specifies the request to stream output to the Files service.

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

The version number of the API representation. This is version 1.

application/vnd.sas.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)

A space-delimited list of media types from which an `Accept` header may be constructed.

If populated indicates the number of items in the collection.

The number of items that were requested for the collection.

The zero-based index of the first item in the collection.

The version number of the collection representation. This representation is version 2.

Base Collection

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.

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.

Specifies the identifier for this column.

Specifies the numerical index for this column. This is a zero-based index.

Specifies the label for this column. The label is optional.

Specifies the length of the data in this column.

Specifies the version number of this representation schema. This is version 2.

Table Column

Specifies an array that contains column resources.

Provides a paginated collection of table columns.

SEGMENT

LONG

RESOLUTION

DENSITY

LAKE

Table Columns

Table Column Collection

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

Specifies the format to use when retrieving data from a column.

User Specified Column Formatting

Specifies the format to use for values in a column.

DOLLAR10.2

Specifies the number of digits to the right of the decimal point.

Specifies the length of a formatted value.

Specifies the qualified name of the format or informat in the form of: <$>name<w>.<d>

Simple Column Formatting

Provides a request to generate a column collection.

Specifies the encoding for the password values in the fileProtection structure. If the value is "base64", then the password values in the fileProtection structure should be encoded by converting the text to UTF-8 and base64-encoding the result. If no value is provided, then the password values of the fileProtection structure are expected to be clear text.

Specifies an array of strings that indicate the columns to include in a row set. If you do not specify a value, then all columns are returned. The order of the column names in the list indicates the order of the cells of the row set.

Column Request

Specifies the name of the engine that is used for this member of the concatenation.

Specifies the name of the file format that is used for this member of the concatenation.

Specifies the physical name that is used for this member of the concatenation.

Library Concatenation

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

MyApp

file1

Specifies the service-defined attributes that were set when this context was created.

Specifies the user-ID that created the context definition.

Specifies the timestamp when the context was created.

Specifies the Compute context definition ID.

Specifies the type of launcher to use when launching SAS Compute Servers. The only value currently supported is service, which refers to the Launcher service.

Specifies links that apply to the context.

Specifies optional information that overrides mappings of file extensions to media types in the sessions that was launched for this context. The session attempts to use file extensions to determine the media type of the files that are returned. Standard IANA type mappings are used. To override the default behavior of the server, specify a mapping from a file extension to a media type name. That media type is then used for that file extension.

Specifies the user ID that last updated the context definition.

Specifies the timestamp when the context was last updated.

Specifies the name of the workload queue where Compute servers configured from this context should run. If workload queues are not supported, this specification will be ignored. The value of the queue name is limited to 250 characters.

Specifies the resources that have been configured for this context.

Specifies the version number of this representation schema. This is version 4.

Context

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

Specifies the command that launches the server for this context. If this value is not set, the service uses the default command that is determined at runtime.

Specifies the context ID from the launcher context. If the launchType is service, then contextId or contextName is required.

Specifies the context name from the launcher context. If the launchType is service, then contextId or contextName is required.

Launch Context

Enables the creation of a new Compute context.

Specifies the attributes that control the behavior of sessions, based on this context. See the example for details.

Specifies whether all authenticated users are allowed to request sessions using the specified context. If true, then authorizedUsers and authorizedGroups are ignored.

Specifies the list of groups whose memes are allowed to request sessions using the specified context.

Specifies the list of users who are allowed to request sessions using the specified context.

Specifies a localized description. The value of description is limited to 1000 characters.

Specifies whether the guest user is allowed to request sessions using the specified context.

Specifies optional information that overrides mappings of file extensions to media types in sessions that are launched for this context. The session attempts to use file extensions to determine the media type of files that are returned. Standard IANA type mappings are used. To override the default behavior of the server, specify a mapping from a file extension to a media type name. That media type is then used for that file extension.

Specifies the context name. The value of the name is limited to 100 characters. The value must be unique.

Specifies the resources that have been requested to be added to this context.

Specifies the version number of this representation schema. This is version 3.

Context Creation Request

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

Specifies the definition ID of the Compute context summary.

Specifies the links that apply to the context.

Context Summary

Specifies the array that contains context summaries.

Provides a paginated collection of context summaries.

items

Context Summary Collection

Describes a member of a directory-based fileref object.

myfile.txt

Specifies a Compute context definition id.

Links that apply to this directory member

Directory Member

Specifies an array that contains a listing of members of a directory fileref.

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

Fileref Members

Directory Collection

Provides a description of a SAS LIBNAME engine.

sase7

Specifies the identifier of the data source that provides the engine. In a Compute session, this is the context id.

Specifies the engine description. In the Compute session, this is the short legal name of the engine.

Specifies the label for this engine. This value maps to the nickname for the engine in the Compute session.

Specifies whether the engine is licensed.

Specifies links that apply to this engine.

Specifies the unique name of this engine.

Specifies the providerId for this service. In a Compute session, this value is compute.

Specifies the version number of this representation schema. This is version 1.

SAS Engine

Specifies an array that contains engine resources.

Provides a paginated collection of SAS engine objects.

Engine Collection

SAS Engine Collection

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

Specifies the SAS code to execute during session initialization.

Specifies the SAS options to apply to a context.

SAS Environment

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

Provides properties of a file or directory object.

hello.txt

Specifies the creation timestamp for this file or directory. This information is returned only if the file or directory is available.

Specifies whether the object references a directory on the system.

Specifies links that apply to this file or directory object.

Specifies the modification timestamp for this file or directory.

Specifies the name of the file or directory.

Specifies the path of the file or directory.

Specifies whether the file or directory is Read Only.

Specifies the size of the file or directory.

File Properties

Specifies an array that contains a listing of members of a directory.

Provides a collection that contains the members of a directory.

dir1.txt

Directory listing

File Properties 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.

Specifies the password that grants Alter access to the file that represents the data set.

Specifies the password that grants Read access to the file that represents the data set.

Specifies the password that grants Write access to the file that represents the data set.

Table Protection Information

File Request Properties

Value for Content Disposition header which will be set in response while downloading the file

Links that apply to this object.  Includes "self", "content", "patch", "update" and "delete"

URI of the object which is either associated or linked with file resource

Properties specific to this file. Each property uses a "key" : "value" format and a comma is used as the separator between properties.

File Resource

application/vnd.sas.file

Provides a description of a SAS fileref object.

myref

Specifies the access method that is used for this fileref. Common values are "DISK" and "TEMP", but other values  be supported.

Specifies the resolved path of the file. Support for this value was added in version 2.

Specifies the identifier for this fileref.

Specifies whether the fileref references a directory on the system.

Specifies links that apply to this fileref.

Specifies the modification timestamp for this fileref.

Fileref

Enables you to create a new SAS fileref object.

myfref

Specifies the access method that is used for this fileref. Common values are "DISK" and "TEMP", but other values can be supported.

Specifies an options string for the creation of the fileref.

Specifies the path to the file or directory that is referenced by this fileref.

Fileref Creation Request

Provides summary information about a SAS fileref.

mydir

Fileref Summary

Array containing list of fileref summary resources.

Provides a collection of fileref summaries.

Current Filerefs

Fileref Summary Collection

Provides a description of a SAS format or informat.

$VARYING

Specifies the decimal precision that a format defaults to.

Specifies the default modifier that is applied to a format.

Specifies the default width of this format.

Specifies the format type, which is either 'format' or 'informat'.

Specifies whether a format is left-justified or right-justified.

Specifies the links that apply to a format.

Specifies the maximum decimal precision that you can set for a format.

Specifies the maximum width that you can set for a format.

Status	Meaning	Description
204	No Content	The job was deleted.
404	Not Found	No resource exists at the requested path.		Schema

Delete a job

Request Samples

Response Samples

Path Parameters

Responses

Name	Type	Required	Description
jobId	string	true	Specifies the ID of the job.
sessionId	string	true	Specifies the ID of the session.