Get context definitions

get/contexts

Internal-Use Only

Returns a list of Compute context definitions. Standard paging, filtering, and sorting options are provided. By default, this endpoint returns a summary of the available information about the contexts. Specify an Accept-Item header with the value application/vnd.sas.compute.context+json to get all available information for each context.

Request Samples

Response Samples

200
application/json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/compute/contexts",
7      "uri": "/compute/contexts",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/compute/contexts?start=0&limit=10",
14      "uri": "/compute/contexts?start=0&limit=10",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "PUT",
19      "rel": "createContext",
20      "href": "/compute/contexts",
21      "uri": "/compute/contexts",
22      "type": "application/vnd.sas.compute.context",
23      "responseType": "application/vnd.sas.compute.context"
24    }
25  ],
26  "name": "items",
27  "accept": "application/vnd.sas.compute.context",
28  "start": 0,
29  "count": 1,
30  "items": [
31    {
32      "description": "My Application Context",
33      "links": [
34        {
35          "method": "GET",
36          "rel": "self",
37          "href": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12",
38          "uri": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12",
39          "type": "application/vnd.sas.compute.context"
40        },
41        {
42          "method": "GET",
43          "rel": "alternate",
44          "href": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12",
45          "uri": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12",
46          "type": "application/vnd.sas.compute.context.summary"
47        },
48        {
49          "method": "DELETE",
50          "rel": "delete",
51          "href": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12",
52          "uri": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12"
53        },
54        {
55          "method": "POST",
56          "rel": "createSession",
57          "href": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12/sessions",
58          "uri": "/compute/contexts/309b3f0b-cda8-4c2b-9089-82a07a4fff12/sessions",
59          "type": "application/vnd.sas.compute.session.request",
60          "responseType": "application/vnd.sas.compute.session"
61        }
62      ],
63      "id": "MyApp",
64      "version": 1,
65      "name": "MyApp"
66    }
67  ],
68  "limit": 10,
69  "version": 2
70}

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Specifies the filter criteria for returned context definitions.
limit	integer	false	Specifies the maximum number of context definitions to return. The default value is "10".
sortBy	string<sort-criteria>	false	Sorts returned context definitions.
start	integer	false	Specifies the offset of the first context definition to return. The default value is "0".

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	Specifies the desired context representation. The Accept-Item options are: application/vnd.sas.compute.context+json application/vnd.sas.compute.context.summary+json blank If the application/vnd.sas.compute.context.summary+json type is specified or no Accept-Item header is specified, then the contexts are returned as summary representation context objects. Allowed values: application/vnd.sas.compute.context+jsonapplication/vnd.sas.compute.context.summary+json

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema