Get a list of data source definitions

get/providers/{providerId}/sourceDefinitions

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

Request Samples

Response Samples


1{
2  "name": "sourceDefinitions",
3  "accept": "application/vnd.sas.data.source.definition",
4  "start": 0,
5  "count": 3,
6  "limit": 10,
7  "version": 2,
8  "items": [
9    {
10      "creationTimeStamp": "0001-01-01T00:00:00Z",
11      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
12      "createdBy": "sasjoe",
13      "modifiedBy": "sasjoe",
14      "id": "84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
15      "name": "pathdnfs",
16      "providerId": "Compute",
17      "description": "description for source definition for base pathdnfs",
18      "dataSourceId": "SAS Studio compute context",
19      "defaultLibref": "pathdnfs",
20      "attributes": {
21        "engineName": "sase7",
22        "options": {
23          "ENABLEDIRECTION": "NO",
24          "NOSETPERM": "NO",
25          "USEDIRECTIO": "NO"
26        },
27        "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
28      },
29      "version": 2,
30      "links": [
31        {
32          "method": "GET",
33          "rel": "self",
34          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
35          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
36          "type": "application/vnd.sas.data.source.definition"
37        },
38        {
39          "method": "PUT",
40          "rel": "update",
41          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
42          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
43          "type": "application/vnd.sas.data.source.definition"
44        },
45        {
46          "method": "DELETE",
47          "rel": "delete",
48          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
49          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3"
50        },
51        {
52          "method": "PUT",
53          "rel": "export",
54          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
55          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
56          "type": "application/vnd.sas.transfer.object"
57        },
58        {
59          "method": "PUT",
60          "rel": "import",
61          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
62          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
63          "type": "application/vnd.sas.transfer.object",
64          "responseType": "application/vnd.sas.summary"
65        },
66        {
67          "method": "GET",
68          "rel": "up",
69          "href": "/dataSources/providers/Compute/sourceDefinitions",
70          "uri": "/dataSources/providers/Compute/sourceDefinitions",
71          "type": "application/vnd.sas.collection",
72          "itemType": "application/vnd.sas.data.source.definition"
73        },
74        {
75          "method": "GET",
76          "rel": "provider",
77          "href": "/dataSources/providers/Compute",
78          "uri": "/dataSources/providers/Compute",
79          "type": "application/vnd.sas.data.provider"
80        }
81      ]
82    },
83    {
84      "creationTimeStamp": "0001-01-01T00:00:00Z",
85      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
86      "createdBy": "sasjoe",
87      "modifiedBy": "sasjoe",
88      "id": "e7042058-2849-4c38-b068-10d10af6c6c0",
89      "name": "mypgdb",
90      "providerId": "Compute",
91      "description": "description for source definition for PostgreSQL database",
92      "dataSourceId": "SAS Studio compute context",
93      "defaultLibref": "mypgdb",
94      "attributes": {
95        "engineName": "sasioptg",
96        "options": {
97          "SERVER": "example.sas.com",
98          "DATABASE": "everest",
99          "PORT": 5432,
100          "UID": "james",
101          "PWD": "bond"
102        }
103      },
104      "version": 2,
105      "links": [
106        {
107          "method": "GET",
108          "rel": "self",
109          "href": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
110          "uri": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
111          "type": "application/vnd.sas.data.source.definition"
112        },
113        {
114          "method": "PUT",
115          "rel": "update",
116          "href": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
117          "uri": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
118          "type": "application/vnd.sas.data.source.definition"
119        },
120        {
121          "method": "DELETE",
122          "rel": "delete",
123          "href": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
124          "uri": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0"
125        },
126        {
127          "method": "PUT",
128          "rel": "export",
129          "href": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
130          "uri": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
131          "type": "application/vnd.sas.transfer.object"
132        },
133        {
134          "method": "PUT",
135          "rel": "import",
136          "href": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
137          "uri": "/dataSources/providers/Compute/sourceDefinitions/e7042058-2849-4c38-b068-10d10af6c6c0",
138          "type": "application/vnd.sas.transfer.object",
139          "responseType": "application/vnd.sas.summary"
140        },
141        {
142          "method": "GET",
143          "rel": "up",
144          "href": "/dataSources/providers/Compute/sourceDefinitions",
145          "uri": "/dataSources/providers/Compute/sourceDefinitions",
146          "type": "application/vnd.sas.collection",
147          "itemType": "application/vnd.sas.data.source.definition"
148        },
149        {
150          "method": "GET",
151          "rel": "provider",
152          "href": "/dataSources/providers/Compute",
153          "uri": "/dataSources/providers/Compute",
154          "type": "application/vnd.sas.data.provider"
155        }
156      ]
157    },
158    {
159      "creationTimeStamp": "0001-01-01T00:00:00Z",
160      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
161      "createdBy": "sasjoe",
162      "modifiedBy": "sasjoe",
163      "id": "3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
164      "name": "oradb",
165      "providerId": "Compute",
166      "description": "description for source definition for Oracle database",
167      "dataSourceId": "SAS Studio compute context",
168      "defaultLibref": "oradb",
169      "attributes": {
170        "engineName": "sasioora",
171        "options": {
172          "DBCLIENT_ENCODING_FIXED": false,
173          "DBSERVER_ENCODING_FIXED": false,
174          "PRESERVE_COL_NAMES": true,
175          "PRESERVE_TAB_NAMES": true,
176          "PATH": "dsn",
177          "SCHEMA": "DMTEST",
178          "UID": "DMTEST",
179          "PWD": "dmtest"
180        }
181      },
182      "version": 2,
183      "links": [
184        {
185          "method": "GET",
186          "rel": "self",
187          "href": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
188          "uri": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
189          "type": "application/vnd.sas.data.source.definition"
190        },
191        {
192          "method": "PUT",
193          "rel": "update",
194          "href": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
195          "uri": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
196          "type": "application/vnd.sas.data.source.definition"
197        },
198        {
199          "method": "DELETE",
200          "rel": "delete",
201          "href": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
202          "uri": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3"
203        },
204        {
205          "method": "PUT",
206          "rel": "export",
207          "href": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
208          "uri": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
209          "type": "application/vnd.sas.transfer.object"
210        },
211        {
212          "method": "PUT",
213          "rel": "import",
214          "href": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
215          "uri": "/dataSources/providers/Compute/sourceDefinitions/3dec2f57-4ad8-498a-a29d-deaa4d211ed3",
216          "type": "application/vnd.sas.transfer.object",
217          "responseType": "application/vnd.sas.summary"
218        },
219        {
220          "method": "GET",
221          "rel": "up",
222          "href": "/dataSources/providers/Compute/sourceDefinitions",
223          "uri": "/dataSources/providers/Compute/sourceDefinitions",
224          "type": "application/vnd.sas.collection",
225          "itemType": "application/vnd.sas.data.source.definition"
226        },
227        {
228          "method": "GET",
229          "rel": "provider",
230          "href": "/dataSources/providers/Compute",
231          "uri": "/dataSources/providers/Compute",
232          "type": "application/vnd.sas.data.provider"
233        }
234      ]
235    }
236  ],
237  "links": [
238    {
239      "method": "GET",
240      "rel": "collection",
241      "href": "/dataSources/providers/myProvider/sourceDefinitions",
242      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
243      "type": "application/vnd.sas.collection",
244      "itemType": "application/vnd.sas.data.source.definition"
245    },
246    {
247      "method": "GET",
248      "rel": "self",
249      "href": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
250      "uri": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
251      "type": "application/vnd.sas.collection",
252      "itemType": "application/vnd.sas.data.source.definition"
253    },
254    {
255      "method": "GET",
256      "rel": "up",
257      "href": "/dataSources/providers/myProvider",
258      "uri": "/dataSources/providers/myProvider",
259      "type": "application/vnd.sas.data.provider"
260    },
261    {
262      "method": "POST",
263      "rel": "createSourceDefinition",
264      "href": "/dataSources/providers/myProvider/sourceDefinitions",
265      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
266      "type": "application/vnd.sas.data.source.definition",
267      "responseType": "application/vnd.sas.data.source.definition"
268    }
269  ]
270}

Path Parameters

Name	Type	Required	Description
providerId	string	true	The ID for the provider.

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Filter criteria for returned data source definitions. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sourceDefinitions?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sourceDefinitions?filter=eq(name, 'source1') Search for multiple source definitions: /dataSources/providers/{providerId}/sourceDefinitions?filter=in(name, 'source1', 'source2', 'source3')
limit	integer	false	Maximum number of objects to return. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort returned data source definitions. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Some sample sorts include the following: Sort ascending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:ascending Sort descending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:descending The default sort is by name in ascending order.
start	integer	false	0-based Offset of first object to return. Defaults to 0.

Responses

Status	Meaning	Description
200	OK	The request succeeded. Any data source definitions are returned in a resource collection.	Schema
400	Bad Request	The request was invalid. Invalid requests occur in the following scenarios: A negative start value is provided. A negative limit value is provided. An unsupported field is specified in the sortBy parameter.	Schema
404	Not Found	No provider exists at the requested path.	Schema