Get format information

get/sessions/{sessionId}/formats/{formatName}

Gets format information from a session. Currently, this endpoint only supports retrieval of built-in format information. User defined formats are not supported. Attempting to retrieve information about a user defined format results in a 404 response.

Request Samples

Response Samples

1{
2 "category": "char",
3 "defaultDecimals": 0,
4 "defaultModifier": 272,
5 "defaultWidth": 8,
6 "formatType": "format",
7 "id": "$VARYING",
8 "justification": "right",
9 "links": [
10 {
11 "href": "/compute/sessions/0001-ses0000/formats/%24VARYING",
12 "method": "GET",
13 "rel": "self",
14 "type": "application/vnd.sas.format",
15 "uri": "/compute/sessions/0001-ses0000/formats/%24VARYING"
16 }
17 ],
18 "maximumDecimals": 0,
19 "maximumWidth": 32767,
20 "minimumDecimals": 0,
21 "minimumWidth": 1,
22 "name": "$VARYING",
23 "version": 1
24}

Path Parameters

NameTypeRequiredDescription
sessionId
string<object-id>
true

Specifies the ID of the session.

formatName
string
true

Specifies the format name.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
404Not Found

No resource exists at the requested path.

Schema