Get an engine list for a session

get/sessions/{sessionId}/engines

Internal-Use Only

Returns engine information for a session. An engine enables you to access data from different storage locations. Each engine might have different requirements for usage. This endpoint returns a collection of engine information that enables you to determine what engines can be used in a session. A collection of application/vnd.sas.data.engine items is returned. Standard pagination rules apply, and simple filtering is allowed.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "accept": "application/vnd.sas.data.engine",
3  "count": 39,
4  "items": [
5    {
6      "hasDefinition": true,
7      "legalName": "SAS Base Engine",
8      "licensed": true,
9      "links": [
10        {
11          "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines/sase7",
12          "method": "GET",
13          "rel": "self",
14          "type": "application/vnd.sas.data.engine",
15          "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines/sase7"
16        },
17        {
18          "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines",
19          "itemType": "application/vnd.sas.data.engine",
20          "method": "GET",
21          "rel": "up",
22          "type": "application/vnd.sas.collection",
23          "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines"
24        },
25        {
26          "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines/sase7/definition",
27          "method": "GET",
28          "rel": "definition",
29          "type": "application/schema",
30          "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines/sase7/definition"
31        }
32      ],
33      "name": "sase7",
34      "nickname": "BASE",
35      "providerId": "compute",
36      "version": 1
37    }
38  ],
39  "limit": 1,
40  "links": [
41    {
42      "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=0",
43      "itemType": "application/vnd.sas.data.engine",
44      "method": "GET",
45      "rel": "self",
46      "type": "application/vnd.sas.collection",
47      "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=0"
48    },
49    {
50      "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines",
51      "itemType": "application/vnd.sas.data.engine",
52      "method": "GET",
53      "rel": "collection",
54      "type": "application/vnd.sas.collection",
55      "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines"
56    },
57    {
58      "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=1",
59      "itemType": "application/vnd.sas.data.engine",
60      "method": "GET",
61      "rel": "next",
62      "type": "application/vnd.sas.collection",
63      "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=1"
64    },
65    {
66      "href": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=38",
67      "itemType": "application/vnd.sas.data.engine",
68      "method": "GET",
69      "rel": "last",
70      "type": "application/vnd.sas.collection",
71      "uri": "/compute/sessions/24457a5d-68b6-432c-a463-c6dfb8bd0526-ses0000/engines?limit=1&start=38"
72    }
73  ],
74  "name": "Engine Collection",
75  "start": 0,
76  "version": 2
77}

Path Parameters

Name	Type	Required	Description
sessionId	string<object-id>	true	Specifies the ID of the session.

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Specifies filter criteria for returned context definitions.
limit	integer	false	Specifies the maximum number of engines to return on a page. The default value is 10.
start	integer	false	Specifies the offset of the first engine to return. The default value is 0.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema