Data Sources

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.

Providers

Contains data source operations for the providers resource.

Get a list of providers

Internal-Use OnlyReturns a collection of application/vnd.sas.data.provider.summary resources. Standard paging, filtering, and sorting options are specified in the Parameters section below.

Gets the provider

Internal-Use OnlyReturns information about a single provider based on its unique ID.

/providers/{providerId}

Sources

Contains operations for data sources resource.

Get a list of data sources

Internal-Use OnlyReturns a collection of sources. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.source media type representation.

/providers/{providerId}/sources

Get a data source

Internal-Use OnlyReturns information about a single source based on its unique ID.

/providers/{providerId}/sources/{sourceId}

Get a list of child data sources

Internal-Use OnlyReturns a collection of sources that are children of the specified source. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.source media type representation.

/providers/{providerId}/sources/{sourceId}/children

SourceDefinitions

Contains operations for the data source definitions resource.

Get a list of data source definitions

Internal-Use OnlyReturns a collection of application/vnd.sas.source.definition resources. Standard paging, filtering, and sorting options are specified in the Parameters section below.

/providers/{providerId}/sourceDefinitions

Create a data source definition

Internal-Use OnlyCreates a date source definition from the provided request.

/providers/{providerId}/sourceDefinitions

Get a data source definition

Internal-Use OnlyReturns information about a single source based on its unique ID.

/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Update a data source definition

Internal-Use OnlyUpdates an existing data source definition through a full replacement of the resource. The ID field might not be modified by this operation.

/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Delete a data source definition

Internal-Use OnlyDeletes the specified data source definition.

/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Sessions

Contains operations to access data sources using the sessions resource.

Get a session

Internal-Use OnlyReturns information about a single session based on its unique ID.

/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}

Terminate a session

Internal-Use OnlyTerminates a session if the user has permissions to terminate the sessions, as determined by the provider service.

/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}

Root

Contains operations for the root resource of the Data Sources API.

Get a collection of top-level links

Internal-Use OnlyReturns a list of links to the top-level collections surfaced through this API.

Engines

Contains operations for engines of the Data Sources API.

Get a list of engines for a data source

Internal-Use OnlyReturns a collection of engines for the respective data source. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.engine media type representation.

/providers/{providerId}/sources/{sourceId}/engines

Get an engine name

Internal-Use OnlyReturns information about a single engine based on its unique name.

/providers/{providerId}/sources/{sourceId}/engines/{engineName}

Get an engine definition

Internal-Use OnlyReturns the definition of the engine as application or schema+json. This definition includes all available engine options.

/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition

Transfer

Contains operations to transfer object resources.

Create source definition from transfer object

Internal-Use OnlyCreate a new source definition from transfer object. Other than the old source definition ID, all other source definition properties are preserved.

/providers/{providerId}/sourceDefinitions

Check transfer object availability

Internal-Use OnlyReturn the transfer object of the specified source definition.

/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Update source definition with transfer object

Internal-Use OnlyUpdates a source definition using the transfer object. If no existing source definition is found, a new source definition is created. Either way, all other source definition properties are preserved.

/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}