Get a data source

get/providers/{providerId}/sources/{sourceId}
Internal-Use Only

Returns information about a single source based on its unique ID.

Request Samples

1

Response Samples

1{
2  "id": "cas",
3  "name": "cas",
4  "type": "casServer",
5  "providerId": "cas",
6  "description": "controller",
7  "hasTables": true,
8  "hasEngines": false,
9  "attributes": {
10    "port": "8850",
11    "host": "server.example.com"
12  },
13  "version": 1,
14  "links": [
15    {
16      "method": "GET",
17      "rel": "self",
18      "href": "/dataSources/providers/cas/sources/cas",
19      "uri": "/dataSources/providers/cas/sources/cas",
20      "type": "application/vnd.sas.data.source"
21    },
22    {
23      "method": "GET",
24      "rel": "alternate",
25      "href": "/dataSources/providers/cas/sources/cas",
26      "uri": "/dataSources/providers/cas/sources/cas",
27      "type": "application/vnd.sas.data.source.summary"
28    },
29    {
30      "method": "GET",
31      "rel": "status",
32      "href": "/casManagement/servers/cas/status",
33      "uri": "/casManagement/servers/cas/status",
34      "responseType": "application/json"
35    },
36    {
37      "method": "GET",
38      "rel": "tables",
39      "href": "/dataTables/dataSources/cas~fs~cas/tables",
40      "uri": "/dataTables/dataSources/cas~fs~cas/tables",
41      "type": "application/vnd.sas.collection",
42      "itemType": "application/vnd.sas.data.table"
43    },
44    {
45      "method": "GET",
46      "rel": "up",
47      "href": "/dataSources/providers/cas/sources",
48      "uri": "/dataSources/providers/cas/sources",
49      "type": "application/vnd.sas.collection",
50      "itemType": "application/vnd.sas.data.source"
51    },
52    {
53      "method": "GET",
54      "rel": "children",
55      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
56      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
57      "type": "application/vnd.sas.collection",
58      "itemType": "application/vnd.sas.data.source"
59    }
60  ]
61}

Path Parameters

NameTypeRequiredDescription
providerId
string
true

The ID for the provider.

sourceId
string
true

The ID for the source.

Query Parameters

NameTypeRequiredDescription
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 be 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 identifier 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.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
404Not FoundNo provider or data source definition exists at the requested path. Schema