Get list of available execution contexts

get/environments/{environmentName}/contexts

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

Request Samples

Response Samples


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

Path Parameters


environmentName	string	true	Specifies the name of the execution environment.

Query Parameters


filter	string<filter-criteria>	false	Specifies filter criteria for the returned execution environments. Filtering is supported on the name, type, description, host, port, and restPort fields. 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 execution environments to return in one page of results. The actual number of returned execution environments can be less if the collection has been exhausted. Defaults to 10.
sortBy	string<sort-criteria>	false	Specifies sort criteria for the list of returned execution environments. Sorting is supported on the name, type, description, host, port, and restPort fields. 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	Specifies a 0-based index of the first execution environment to return. Defaults to 0.

Responses

Status	Meaning	Description
200	OK	The request succeeded. A sorted list of available execution environments was returned.		Schema
404	Not Found	The requested environment does not exist.		Schema