Batch

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

Root

Contains the operations for the root resource of the Batch API.

Get API resource links

Internal-Use OnlyReturns a list of links to the top-level resources in this API.

Check service availability

Internal-Use OnlyChecks the availability of the service.

Contexts

Contains the operations to create SAS Batch Server definitions.

Get a collection of contexts

Internal-Use OnlyReturns a collection of context information based on the specified query parameters.

Check endpoint availability

Internal-Use OnlyDetermines whether an endpoint is currently available.

Create a context

Internal-Use OnlyCreates a context using the context request in the request body.

Get a context

Internal-Use OnlyReturns the specified context's information.

/contexts/{contextId}

Verify that a context exists

Internal-Use OnlyDetermines whether a specific context exists. Returns headers for the specified context.

/contexts/{contextId}

Update a context

Internal-Use OnlyUpdates the specified context with the contents of the request body.

/contexts/{contextId}

Delete a context

Internal-Use OnlyDeletes the specified context.

/contexts/{contextId}

Get a context by name

Internal-Use OnlyReturns the specifically named context's information.

/contexts/@name

Verify that a context exists by name

Internal-Use OnlyDetermines whether a specificly named context exists and return headers for the context.

/contexts/@name

File Sets

Contains the operations to access information for file sets and files.

Check endpoint availability

Internal-Use OnlyDetermines whether an endpoint is currently available.

Get a collection of file sets

Internal-Use OnlyReturns a collection of file-set objects that meet the specified query parameters.

Create a file set

Internal-Use OnlyCreates a file set to hold files to transport to and from the cluster. The file set object that is passed in, requires only the context ID set.

Get a file set object

Internal-Use OnlyReturns the information about the specified file set.

/fileSets/{fileSetId}

Verify that a file set exists

Internal-Use OnlyDetermines whether a specified file set exists. Returns headers for the specified file set.

/fileSets/{fileSetId}

Delete a file set

Internal-Use OnlyDeletes the specified file set and its contents.

/fileSets/{fileSetId}

Check endpoint availability

Internal-Use OnlyDetermines whether an endpoint is currently available.

/fileSets/{fileSetId}/files

Get the contents of a file set

Internal-Use OnlyReturns a collection of file-information objects representing all the files contained in the specified file set.

/fileSets/{fileSetId}/files

Verify that a file in a file set exists

Internal-Use OnlyDetermines whether a specified file in a specified file set exists. Returns headers for the specified file in the file set.

/fileSets/{fileSetId}/files/{fileName}

Get the information about a file in a file set

Internal-Use OnlyGets the metadata attached to a file in a file set. application/octet-stream headers returns the information and content of the specified file from the specified file set. application/vnd.sas.batch.file.set.file+json and application/json returns information about the specified file from the specified file set

/fileSets/{fileSetId}/files/{fileName}

Set the contents of a file in a file set

Internal-Use OnlyCreates or updates the contents of a specified file in the specified file set.

/fileSets/{fileSetId}/files/{fileName}

Jobs

Contains the operations for SAS Batch Server instances.

Check endpoint availability

Internal-Use OnlyDetermines whether an endpoint is currently available.

Get a collection of Jobs

Internal-Use OnlyReturns a collection of job objects in the form of an application/vnd.sas.collection. It is based on the specified query parameters.

Create a SAS job

Internal-Use OnlyCreates a new job to run a SAS program. The type of job is created depending on the Accept header. application/vnd.sas.batch.job.request.sas.batch+json headers creates a Batch job to run a SAS program. application/vnd.sas.batch.job.request.sas.line.mode+json headers creates a new interactive job to run SAS in line mode. application/vnd.sas.batch.job.request.command.batch+json headers creates a Batch job to run an arbitrary command. application/vnd.sas.batch.job.request.command.interactive+json headers creates an interactive job to run an arbitrary command.

Verify that a job exists

Internal-Use OnlyDetermines whether a specific job exists.

Get the job information

Internal-Use OnlyGets the job information or job state information for the specified job.

Delete a job

Internal-Use OnlyDeletes a job with the specified job ID.

Send STDIO input text to a job

Internal-Use OnlySends the specified array of text strings to a running job to use as STDIN.

/jobs/{jobId}/input

Retrieve the STDIO ouput of a job

Internal-Use OnlyRetrieves the STDIO text from STDOUT and STDERR output from a running job.

/jobs/{jobId}/output

Verify that a job state exists

Internal-Use OnlyDetermines whether a specific job state exists.

/jobs/{jobId}/state

Get the state of a job

Internal-Use OnlyGets the plain text version of the specified job's state. The returned text is one of the following values: 'pending', 'running', 'completed', 'failed', 'unknown'.

/jobs/{jobId}/state

Change the state of a job

Internal-Use OnlyChanges the state of a specified job. The only state currently allowed is 'canceled'.

/jobs/{jobId}/state

Servers

Contains the operations for SAS Reusable Batch Server instances.

Check endpoint availability

Internal-Use OnlyDetermines whether an endpoint is currently available.

Get a collection of Servers

Internal-Use OnlyReturn a collection of server objects in the form of an application/vnd.sas.collection. It is based on the specified query parameters.

Verify that a reusable Batch server exists

Internal-Use OnlyDetermines whether a specific reusable Batch server exists.

/servers/{serverId}

Get the reusable Batch server information

Internal-Use OnlyGets the reusable Batch server information for the specified reusable Batch server.

/servers/{serverId}

Delete a reusable Batch server

Internal-Use OnlyDeletes a reusable Batch server with the specified server ID.

/servers/{serverId}