Manage all aspects of data quality, data sources, and tables

data_management

Viya_35

2023.03

2023.10

2024.07

2024.03

2024.08

2024.10

2024.09

2022.09

The Data Sources API works in concert with the Data Tables and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Sources API enables retrieval of metadata for data sources and linking to their respective tables. All GET operations have a corresponding HEAD with identical signature and semantics except the resource body is not returned. Terminology: data source: represents a node in the data source hierarchy that can
 represent a server, library, or collection of tables. 
provider: represents a vnd.sas.data.provider that the Data Sources service is responsible
 for managing and retrieving rather than the Data Sources
 providers (such as CAS). These are retrieved from the service registry.
 data source definition: represents the metadata needed to construct a data source node in
 the hierarchy. This is only available on a per provider
basis.
 Compute is the only supported provider. 
engine: represents the means to connect to the next level down in the data
 source hierarchy. An engine's definition contains all of the
 available attributes that must be specified to create a data source
 definition.

Data Sources

Returns the definition of the engine as application or schema+json. This definition includes all available engine options.

providerId

sourceId

The unique name of this engine within its data source.

engineName

The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.

sessionId

This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

preserveSession

Engine Definition

This is an example of an error that could be returned for resource not found

Error

application/vnd.sas.error

No provider, data source, or engine exists at the requested path.


Get an engine definition

Provider

Provider Summary

A pageable collection of provider resources.

Provider Summary Collection

Data Source

Data Source Collection

Data Source Children Collection

Engine Collection

Information about a data source definition.

Source Definition

Create Source Definition Request

Update Source Definition Request

A pageable collection of source definition resources.

Data Source Definition Collection

Session

Engine

Transfer Object

Information about a data source definition transfer.

Transfer Resource Summary Object

A list of links to top level resources available from the root of the API.

A link to a related operation or resource.

Link

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)

Status	Meaning	Description
200	OK	The request succeeded.		Schema
404	Not Found	No provider, data source, or engine exists at the requested path.		Schema

Get an engine definition

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses

Name	Type	Required	Description
engineName	string	true	The unique name of this engine within its data source.
providerId	string	true	The ID for the provider.
sourceId	string	true	The ID for the source.

Name	Type	Required	Description
preserveSession	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.
sessionId	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.