Get a list of providers

get/providers

Internal-Use Only

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

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/jobExecution/providers",
7      "uri": "/jobExecution/providers",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/jobExecution/providers?start=0&limit=10",
14      "uri": "/jobExecution/providers?start=0&limit=10",
15      "type": "application/vnd.sas.collection",
16      "itemType": "application/vnd.sas.job.execution.provider.summary"
17    },
18    {
19      "method": "GET",
20      "rel": "next",
21      "href": "/jobExecution/providers?start=10&limit=10",
22      "uri": "/jobExecution/providers?start=10&limit=10",
23      "type": "application/vnd.sas.collection"
24    },
25    {
26      "method": "GET",
27      "rel": "last",
28      "href": "/jobExecution/providers?start=10&limit=10",
29      "uri": "/jobExecution/providers?start=10&limit=10",
30      "type": "application/vnd.sas.collection"
31    },
32    {
33      "method": "GET",
34      "rel": "up",
35      "href": "/jobExecution/",
36      "uri": "/jobExecution/",
37      "type": "application/vnd.sas.api"
38    }
39  ],
40  "name": "providers",
41  "accept": "application/vnd.sas.job.execution.provider.summary application/vnd.sas.job.execution.provider",
42  "start": 0,
43  "count": 2,
44  "items": [
45    {
46      "id": "AnalyticsFlow",
47      "links": [
48        {
49          "method": "GET",
50          "rel": "self",
51          "href": "/jobExecution/providers/AnalyticsFlow",
52          "uri": "/jobExecution/providers/AnalyticsFlow",
53          "type": "application/vnd.sas.job.execution.provider"
54        },
55        {
56          "method": "GET",
57          "rel": "alternate",
58          "href": "/jobExecution/providers/AnalyticsFlow",
59          "uri": "/jobExecution/providers/AnalyticsFlow",
60          "type": "application/vnd.sas.job.execution.provider.summary"
61        },
62        {
63          "method": "GET",
64          "rel": "up",
65          "href": "/jobExecution/providers",
66          "uri": "/jobExecution/providers",
67          "type": "application/vnd.sas.collection",
68          "itemType": "application/vnd.sas.job.execution.provider.summary"
69        }
70      ],
71      "version": 1
72    },
73    {
74      "id": "Compute",
75      "links": [
76        {
77          "method": "GET",
78          "rel": "self",
79          "href": "/jobExecution/providers/Compute",
80          "uri": "/jobExecution/providers/Compute",
81          "type": "application/vnd.sas.job.execution.provider"
82        },
83        {
84          "method": "GET",
85          "rel": "alternate",
86          "href": "/jobExecution/providers/Compute",
87          "uri": "/jobExecution/providers/Compute",
88          "type": "application/vnd.sas.job.execution.provider.summary"
89        },
90        {
91          "method": "GET",
92          "rel": "up",
93          "href": "/jobExecution/providers",
94          "uri": "/jobExecution/providers",
95          "type": "application/vnd.sas.collection",
96          "itemType": "application/vnd.sas.job.execution.provider.summary"
97        }
98      ],
99      "version": 1
100    }
101  ],
102  "limit": 10,
103  "version": 2
104}

Query Parameters

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

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	The desired column representation. The Accept-Item options are: application/vnd.sas.job.execution.provider.summary+json application/vnd.sas.job.execution.provider+json blank The providers are returned as the summary representation provider objects in either of the following situations: The Accept-Item header is set to application/vnd.sas.job.execution.provider.summary+json There is no Accept-Item header. In this case, the provider contains only the following properties: ID, version, and links. If application/vnd.sas.job.execution.provider.summary+json is specified, the provider resource contains all of the following properties: ID, heartbeatInterval, expiresAfter, version, and links. Allowed values: application/vnd.sas.job.execution.provider.summary+jsonapplication/vnd.sas.job.execution.provider+json

Responses

Status	Meaning	Description
200	OK	The request succeeded. The providers (if any) are returned in a resource collection.		Schema
400	Bad Request	The request was not valid. An invalid request occurs in the following scenarios: <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