List formats in a session

get/sessions/{sessionId}/formats

Returns a list of all the formats that are defined for a session. Please note that while user defined formats are included in the response, there is currently no way to obtain information about user defined formats through the API. Furthermore, the response does not currently differentiate between built-in formats and user defined formats. Requests to retrieve a specific user defined format through /sessions/{sessionId}/formats/{formatName} are not supported and return 404 Not Found.

Request Samples

Response Samples

1{
2 "accept": "application/vnd.sas.format.summary",
3 "items": [
4 {
5 "id": "$",
6 "links": [
7 {
8 "href": "/compute/sessions/{sessionId}/formats/%24",
9 "method": "GET",
10 "rel": "self",
11 "type": "application/vnd.sas.format",
12 "uri": "/compute/sessions/{sessionId}/formats/%24"
13 }
14 ],
15 "name": "$",
16 "version": 1
17 }
18 ],
19 "limit": 1,
20 "links": [
21 {
22 "href": "/compute/sessions/{sessionId}/formats?limit=1&start=0",
23 "itemType": "application/vnd.sas.format.summary",
24 "method": "GET",
25 "rel": "self",
26 "type": "application/vnd.sas.collection",
27 "uri": "/compute/sessions/{sessionId}/formats?limit=1&start=0"
28 },
29 {
30 "href": "/compute/sessions/{sessionId}/formats",
31 "itemType": "application/vnd.sas.format.summary",
32 "method": "GET",
33 "rel": "collection",
34 "type": "application/vnd.sas.collection",
35 "uri": "/compute/sessions/{sessionId}/formats"
36 },
37 {
38 "href": "/compute/sessions/{sessionId}/formats?limit=1&start=1",
39 "itemType": "application/vnd.sas.format.summary",
40 "method": "GET",
41 "rel": "next",
42 "type": "application/vnd.sas.collection",
43 "uri": "/compute/sessions/{sessionId}/formats?limit=1&start=1"
44 }
45 ],
46 "name": "Formats",
47 "start": 0,
48 "version": 2
49}

Path Parameters

NameTypeRequiredDescription
sessionId
string<object-id>
true

Specifies the ID of the session.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Specifies filter criteria for returned formats.

limit
integer
false

Specifies the maximum number of formats to return.

Default:
10
start
integer
false

Specifies the offset of the first format to return.

Default:
0

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

Specifies the desired format representation. The Accept-Item options are: application/vnd.sas.format+json application/vnd.sas.format.summary+json blank If the application/vnd.sas.format.summary+json type is specified or no Accept-Item header is specified, then the formats are returned as summary representation format objects.

Allowed values:
application/vnd.sas.format.summary+jsonapplication/vnd.sas.format+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema