Get a list of child data sources

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

Internal-Use Only

Returns 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.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "sources",
3  "accept": "application/vnd.sas.data.source application/vnd.sas.data.source.summary",
4  "version": 2,
5  "items": [
6    {
7      "id": "MYCASLIB",
8      "name": "MYCASLIB",
9      "type": "caslib",
10      "providerId": "cas",
11      "description": "castest test files.",
12      "hasTables": true,
13      "hasEngines": false,
14      "attributes": {
15        "active\"": "false",
16        "personal\"": "false",
17        "subDirs\"": "true"
18      },
19      "version": 1,
20      "links": [
21        {
22          "method": "GET",
23          "rel": "self",
24          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
25          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
26          "type": "application/vnd.sas.data.source"
27        },
28        {
29          "method": "GET",
30          "rel": "alternate",
31          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
32          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
33          "type": "application/vnd.sas.data.source.summary"
34        },
35        {
36          "method": "GET",
37          "rel": "up",
38          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
39          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
40          "type": "application/vnd.sas.collection",
41          "itemType": "application/vnd.sas.data.source"
42        },
43        {
44          "method": "GET",
45          "rel": "parent",
46          "href": "/dataSources/providers/cas/sources/cas",
47          "uri": "/dataSources/providers/cas/sources/cas",
48          "type": "application/vnd.sas.data.source"
49        },
50        {
51          "method": "GET",
52          "rel": "tables",
53          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
54          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
55          "type": "application/vnd.sas.collection",
56          "itemType": "application/vnd.sas.data.table"
57        }
58      ]
59    },
60    {
61      "id": "EngTest",
62      "name": "EngTest",
63      "type": "caslib",
64      "providerId": "cas",
65      "description": "engtest HDAT files.",
66      "hasTables": true,
67      "attributes": {
68        "active": "false",
69        "personal": "false",
70        "subDirs": "true"
71      },
72      "version": 1,
73      "links": [
74        {
75          "method": "GET",
76          "rel": "self",
77          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
78          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
79          "type": "application/vnd.sas.data.source"
80        },
81        {
82          "method": "GET",
83          "rel": "alternate",
84          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
85          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
86          "type": "application/vnd.sas.data.source.summary"
87        },
88        {
89          "method": "GET",
90          "rel": "up",
91          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
92          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
93          "type": "application/vnd.sas.collection",
94          "itemType": "application/vnd.sas.data.source"
95        },
96        {
97          "method": "GET",
98          "rel": "parent",
99          "href": "/dataSources/providers/cas/sources/cas",
100          "uri": "/dataSources/providers/cas/sources/cas",
101          "type": "application/vnd.sas.data.source"
102        },
103        {
104          "method": "GET",
105          "rel": "tables",
106          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~EngTest/tables",
107          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~EngTest/tables",
108          "type": "application/vnd.sas.collection",
109          "itemType": "application/vnd.sas.data.table"
110        }
111      ]
112    },
113    {
114      "id": "Formats",
115      "name": "Formats",
116      "type": "caslib",
117      "providerId": "cas",
118      "description": "Format Caslib",
119      "hasTables": true,
120      "hasEngines": false,
121      "attributes": {
122        "active": "false",
123        "personal": "false",
124        "subDirs": "true"
125      },
126      "version": 1,
127      "links": [
128        {
129          "method": "GET",
130          "rel": "self",
131          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
132          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
133          "type": "application/vnd.sas.data.source"
134        },
135        {
136          "method": "GET",
137          "rel": "alternate",
138          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
139          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
140          "type": "application/vnd.sas.data.source.summary"
141        },
142        {
143          "method": "GET",
144          "rel": "up",
145          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
146          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
147          "type": "application/vnd.sas.collection",
148          "itemType": "application/vnd.sas.data.source"
149        },
150        {
151          "method": "GET",
152          "rel": "parent",
153          "href": "/dataSources/providers/cas/sources/cas",
154          "uri": "/dataSources/providers/cas/sources/cas",
155          "type": "application/vnd.sas.data.source"
156        },
157        {
158          "method": "GET",
159          "rel": "tables",
160          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Formats/tables",
161          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Formats/tables",
162          "type": "application/vnd.sas.collection",
163          "itemType": "application/vnd.sas.data.table"
164        }
165      ]
166    },
167    {
168      "id": "HPS",
169      "name": "HPS",
170      "type": "caslib",
171      "providerId": "cas",
172      "description": "HDAT files on /hps",
173      "hasTables": true,
174      "hasEngines": false,
175      "attributes": {
176        "active": "false",
177        "personal": "false",
178        "subDirs": "true"
179      },
180      "version": 1,
181      "links": [
182        {
183          "method": "GET",
184          "rel": "self",
185          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
186          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
187          "type": "application/vnd.sas.data.source"
188        },
189        {
190          "method": "GET",
191          "rel": "alternate",
192          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
193          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
194          "type": "application/vnd.sas.data.source.summary"
195        },
196        {
197          "method": "GET",
198          "rel": "up",
199          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
200          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
201          "type": "application/vnd.sas.collection",
202          "itemType": "application/vnd.sas.data.source"
203        },
204        {
205          "method": "GET",
206          "rel": "parent",
207          "href": "/dataSources/providers/cas/sources/cas",
208          "uri": "/dataSources/providers/cas/sources/cas",
209          "type": "application/vnd.sas.data.source"
210        },
211        {
212          "method": "GET",
213          "rel": "tables",
214          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~HPS/tables",
215          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~HPS/tables",
216          "type": "application/vnd.sas.collection",
217          "itemType": "application/vnd.sas.data.table"
218        }
219      ]
220    }
221  ],
222  "links": [
223    {
224      "method": "GET",
225      "rel": "collection",
226      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
227      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
228      "type": "application/vnd.sas.collection",
229      "itemType": "application/vnd.sas.data.source"
230    },
231    {
232      "method": "GET",
233      "rel": "self",
234      "href": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
235      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
236      "type": "application/vnd.sas.collection",
237      "itemType": "application/vnd.sas.data.source"
238    },
239    {
240      "method": "GET",
241      "rel": "up",
242      "href": "/dataSources/providers/cas/sources/cas",
243      "uri": "/dataSources/providers/cas/sources/cas",
244      "type": "application/vnd.sas.data.source"
245    }
246  ]
247}

Path Parameters

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

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Filter criteria for returned sources. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=eq(name, 'source1') Search for multiple sources: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=in(name, 'source1', 'source2', 'source3')
limit	integer	false	Maximum number of sources to return in this page of results. The actual number of returned sources might be less if the collection has been exhausted. Defaults to 10.
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 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.
sortBy	string<sort-criteria>	false	Sort returned sources. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Sample sorts include the following: Sort ascending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:ascending Sort descending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:descending The default sort is by name in ascending order.
start	integer	false	The starting index of the first source in a page. Defaults to 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	The desired data source representation. The Accept-Item options are: application/vnd.sas.data.source+json application/vnd.sas.data.source.summary+json If the application/vnd.sas.data.column+json type is specified or no Accept-Item header is present, the data sources are returned as full representation column objects. Allowed values: application/vnd.sas.data.source+jsonapplication/vnd.sas.data.source.summary+json

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	The request was invalid. An invalid filter or combination of request parameters was provided.	Schema
404	Not Found	No provider or data source exists at the requested path.	Schema