Get list of available execution environments

get/environments

Internal-Use Only

Returns a list of all of the execution environments that are available to the user.

Request Samples

Response Samples

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

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Specifies filter criteria for the returned execution environments. Filtering is supported on the name field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter based on names starting with 'env': /dataQuality/environments/{environmentName}/contexts?filter=startsWith(name, 'env') Filter by name: /dataQuality/environments/{environmentName}/contexts?filter=eq(id, 'context1') Filter for multiple names: /dataQuality/environments/{environmentName}/contexts?filter=in(name, 'context1', 'context2', 'context3')
limit	integer	false	Specifies the maximum number of environments to return in one page of results. The actual number of returned contexts can be less if the collection has been exhausted. Defaults to 10.
sortBy	string<sort-criteria>	false	Specifies sort criteria for the returned execution environments. Sorting is supported on the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:descending
start	integer	false	Provides 0-based index of the first execution environment to return. Defaults to 0.

Responses

Status	Meaning	Description
200	OK	The request succeeded. A list of available execution environments was returned.		Schema