Get a list of data sources

get/providers/{providerId}/sources

Internal-Use Only

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

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "sources",
3  "accept": "application/vnd.sas.data.source",
4  "count": 1,
5  "version": 1,
6  "items": [
7    {
8      "id": "cas",
9      "name": "cas",
10      "type": "casServer",
11      "providerId": "cas",
12      "description": "controller",
13      "hasTables": true,
14      "hasEngines": false,
15      "attributes": {
16        "port": "8850",
17        "host": "server.example.com"
18      },
19      "version": 1,
20      "links": [
21        {
22          "method": "GET",
23          "rel": "self",
24          "href": "/dataSources/providers/cas/sources/cas",
25          "uri": "/dataSources/providers/cas/sources/cas",
26          "type": "application/vnd.sas.data.source"
27        },
28        {
29          "method": "GET",
30          "rel": "alternate",
31          "href": "/dataSources/providers/cas/sources/cas",
32          "uri": "/dataSources/providers/cas/sources/cas",
33          "type": "application/vnd.sas.data.source.summary"
34        },
35        {
36          "method": "GET",
37          "rel": "status",
38          "href": "/casManagement/servers/cas/status",
39          "uri": "/casManagement/servers/cas/status",
40          "responseType": "application/json"
41        },
42        {
43          "method": "GET",
44          "rel": "tables",
45          "href": "/dataTables/dataSources/cas~fs~cas/tables",
46          "uri": "/dataTables/dataSources/cas~fs~cas/tables",
47          "type": "application/vnd.sas.collection",
48          "itemType": "application/vnd.sas.data.table"
49        },
50        {
51          "method": "GET",
52          "rel": "up",
53          "href": "/dataSources/providers/cas/sources",
54          "uri": "/dataSources/providers/cas/sources",
55          "type": "application/vnd.sas.collection",
56          "itemType": "application/vnd.sas.data.source"
57        },
58        {
59          "method": "GET",
60          "rel": "children",
61          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
62          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
63          "type": "application/vnd.sas.collection",
64          "itemType": "application/vnd.sas.data.source"
65        }
66      ]
67    }
68  ],
69  "links": [
70    {
71      "method": "GET",
72      "rel": "collection",
73      "href": "/dataSources/providers/cas/sources",
74      "uri": "/dataSources/providers/cas/sources",
75      "type": "application/vnd.sas.collection"
76    },
77    {
78      "method": "GET",
79      "rel": "self",
80      "href": "/dataSources/providers/cas/sources?start=0&limit=10",
81      "uri": "/dataSources/providers/cas/sources?start=0&limit=10",
82      "type": "application/vnd.sas.collection",
83      "itemType": "application/vnd.sas.data.source"
84    },
85    {
86      "method": "GET",
87      "rel": "up",
88      "href": "/dataSources/providers/cas",
89      "uri": "/dataSources/providers/cas",
90      "type": "application/vnd.sas.data.provider"
91    }
92  ]
93}

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 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?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sources?filter=eq(name, 'source1') Search for multiple sources: /dataSources/providers/{providerId}/sources?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 can be fewer if the collection has been exhausted. Defaults to 10.
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?sortBy=name:ascending Sort descending by source name: /dataSources/providers/{providerId}/sources?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.source+json type is specified or no Accept-Item header is present, the data sources are returned as full representation source 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. Invalid requests occur in the following scenarios: <br> <ul> <li>A negative start value is provided.</li> <li>A negative limit value is provided.</li> <li>An unsupported field is specified in the sortBy parameter.</li> <li>An unsupported field is specified in the filter parameter.</li> <li>An invalid filter parameter is provided.</li> </ul>	Schema
404	Not Found	No provider exists at the requested path.	Schema