Get a list of providers

get/providers

Internal-Use Only

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

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "providers",
3  "accept": "application/vnd.sas.data.provider.summary application/vnd.sas.data.provider",
4  "start": 0,
5  "count": 1,
6  "limit": 10,
7  "version": 2,
8  "items": [
9    {
10      "id": "cas",
11      "links": [
12        {
13          "method": "GET",
14          "rel": "self",
15          "href": "/dataSources/providers/cas",
16          "uri": "/dataSources/providers/cas",
17          "type": "application/vnd.sas.data.provider"
18        },
19        {
20          "method": "GET",
21          "rel": "alternate",
22          "href": "/dataSources/providers/cas",
23          "uri": "/dataSources/providers/cas",
24          "type": "application/vnd.sas.data.provider.summary"
25        },
26        {
27          "method": "GET",
28          "rel": "up",
29          "href": "/dataSources/providers",
30          "uri": "/dataSources/providers",
31          "type": "application/vnd.sas.collection",
32          "itemType": "application/vnd.sas.data.provider"
33        },
34        {
35          "method": "GET",
36          "rel": "dataSources",
37          "href": "/dataSources/providers/cas/sources",
38          "uri": "/dataSources/providers/cas/sources",
39          "type": "application/vnd.sas.collection",
40          "itemType": "application/vnd.sas.data.source"
41        }
42      ],
43      "version": 2
44    }
45  ],
46  "links": [
47    {
48      "method": "GET",
49      "rel": "collection",
50      "href": "/dataSources/providers",
51      "uri": "/dataSources/providers",
52      "type": "application/vnd.sas.collection"
53    },
54    {
55      "method": "GET",
56      "rel": "self",
57      "href": "/dataSources/providers?start=0&limit=10",
58      "uri": "/dataSources/providers?start=0&limit=10",
59      "type": "application/vnd.sas.collection"
60    }
61  ]
62}

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Filter criteria for returned providers. The only valid filter field is id. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by id starting with: /dataSources/providers?filter=startsWith(id, 'prov') Search by id: /dataSources/providers?filter=eq(id, 'provider1') Search for multiple providers: /dataSources/providers?filter=in(id, 'provider1', 'provider2', 'provider3')
limit	integer	false	Maximum number of providers to return in this page of results. The actual number of returned providers can be fewer if the collection has been exhausted. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort returned providers. The only valid sorting option is the id field. The default sort order is ascending on the id field. Some sample sorts include the following: Sort ascending by id: /dataSources/providers?sortBy=id:ascending Sort descending by id: /dataSources/providers?sortBy=id:descending
start	integer	false	0-based index of first provider to return. Defaults to 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	The desired provider representation. The Accept-Item options are: application/vnd.sas.data.provider.summary+json application/vnd.sas.data.provider+json If the application/vnd.sas.data.provider.summary type is specified or no Accept-Item header is present, the providers are returned as the summary representation provider objects. In this case, the provider contains the following properties: id, version, and links. Allowed values: application/vnd.sas.data.provider.summary+jsonapplication/vnd.sas.data.provider+json

Responses

Status	Meaning	Description
200	OK	The request succeeded. Any providers are returned in a resource collection.		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> </ul>		Schema