Retrieve column information

post/sessions/{sessionId}/data/{libref}/{tableName}/columns

Internal-Use Only

Returns the column information for a specified data set based on the submitted request body. By default, a collection is returned, and standard paging options are available.

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "accept": "application/vnd.sas.compute.data.table.column",
3  "count": 10,
4  "items": [
5    {
6      "id": "ID",
7      "index": 0,
8      "label": "Districts code",
9      "length": 15,
10      "links": [
11        {
12          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/ID",
13          "method": "GET",
14          "rel": "self",
15          "type": "application/vnd.sas.compute.data.table.column",
16          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/ID"
17        }
18      ],
19      "name": "ID",
20      "type": "CHAR"
21    },
22    {
23      "id": "ID1",
24      "index": 1,
25      "label": "Provinces code",
26      "length": 15,
27      "links": [
28        {
29          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/ID1",
30          "method": "GET",
31          "rel": "self",
32          "type": "application/vnd.sas.compute.data.table.column",
33          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/ID1"
34        }
35      ],
36      "name": "ID1",
37      "type": "CHAR"
38    },
39    {
40      "id": "SEGMENT",
41      "index": 2,
42      "label": "ID segment number",
43      "length": 5,
44      "links": [
45        {
46          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/SEGMENT",
47          "method": "GET",
48          "rel": "self",
49          "type": "application/vnd.sas.compute.data.table.column",
50          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/SEGMENT"
51        }
52      ],
53      "name": "SEGMENT",
54      "type": "FLOAT"
55    },
56    {
57      "format": {
58        "decimals": 12,
59        "length": 16
60      },
61      "id": "X",
62      "index": 3,
63      "label": "Projected Longitude: Albers",
64      "length": 8,
65      "links": [
66        {
67          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/X",
68          "method": "GET",
69          "rel": "self",
70          "type": "application/vnd.sas.compute.data.table.column",
71          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/X"
72        }
73      ],
74      "name": "X",
75      "type": "FLOAT"
76    },
77    {
78      "format": {
79        "decimals": 12,
80        "length": 16
81      },
82      "id": "Y",
83      "index": 4,
84      "label": "Projected Latitude: Albers",
85      "length": 8,
86      "links": [
87        {
88          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/Y",
89          "method": "GET",
90          "rel": "self",
91          "type": "application/vnd.sas.compute.data.table.column",
92          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/Y"
93        }
94      ],
95      "name": "Y",
96      "type": "FLOAT"
97    },
98    {
99      "id": "LONG",
100      "index": 5,
101      "label": "Unprojected degrees longitude (East)",
102      "length": 8,
103      "links": [
104        {
105          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LONG",
106          "method": "GET",
107          "rel": "self",
108          "type": "application/vnd.sas.compute.data.table.column",
109          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LONG"
110        }
111      ],
112      "name": "LONG",
113      "type": "FLOAT"
114    },
115    {
116      "id": "LAT",
117      "index": 6,
118      "label": "Unprojected degrees latitude",
119      "length": 8,
120      "links": [
121        {
122          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LAT",
123          "method": "GET",
124          "rel": "self",
125          "type": "application/vnd.sas.compute.data.table.column",
126          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LAT"
127        }
128      ],
129      "name": "LAT",
130      "type": "FLOAT"
131    },
132    {
133      "id": "RESOLUTION",
134      "index": 7,
135      "label": "Map detail level based on output resolution",
136      "length": 5,
137      "links": [
138        {
139          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/RESOLUTION",
140          "method": "GET",
141          "rel": "self",
142          "type": "application/vnd.sas.compute.data.table.column",
143          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/RESOLUTION"
144        }
145      ],
146      "name": "RESOLUTION",
147      "type": "FLOAT"
148    },
149    {
150      "id": "DENSITY",
151      "index": 8,
152      "label": "Reduce density values",
153      "length": 5,
154      "links": [
155        {
156          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/DENSITY",
157          "method": "GET",
158          "rel": "self",
159          "type": "application/vnd.sas.compute.data.table.column",
160          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/DENSITY"
161        }
162      ],
163      "name": "DENSITY",
164      "type": "FLOAT"
165    },
166    {
167      "id": "LAKE",
168      "index": 9,
169      "label": "Lake Flag:1-water:2-citytype",
170      "length": 5,
171      "links": [
172        {
173          "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LAKE",
174          "method": "GET",
175          "rel": "self",
176          "type": "application/vnd.sas.compute.data.table.column",
177          "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/LAKE"
178        }
179      ],
180      "name": "LAKE",
181      "type": "FLOAT"
182    }
183  ],
184  "limit": 10,
185  "links": [
186    {
187      "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/?start=0&limit=10",
188      "itemType": "application/vnd.sas.compute.data.table.column",
189      "method": "GET",
190      "rel": "self",
191      "type": "application/vnd.sas.collection",
192      "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/?start=0&limit=10"
193    },
194    {
195      "href": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/",
196      "itemType": "application/vnd.sas.compute.data.table.column",
197      "method": "GET",
198      "rel": "collection",
199      "type": "application/vnd.sas.collection",
200      "uri": "/compute/sessions/RKEY-ses0000/data/MAPSGFK/AFGHANISTAN/columns/"
201    }
202  ],
203  "name": "Table Columns",
204  "start": 0,
205  "version": 2
206}

Path Parameters

Name	Type	Required	Description
libref	string<object-id>	true	Specifies the libref for the request.
sessionId	string<object-id>	true	Specifies the ID of the session.
tableName	string<object-id>	true	Specifies the table or data set to query.

Query Parameters

Name	Type	Required	Description
limit	integer	false	Specifies the maximum number of columns to return. Default: 10
start	integer	false	Specifies the offset of the first column entry to return. Default: 0

Request Body

Optional body that is used to refine a request.

Provides a request to generate a column collection.

Example:

{"includeColumns":["Name","Age","Sex"],"version":1}

Name	Type	Required	Description
includeColumns	array [string]	false	Specifies an array of strings that indicate the columns to include in a row set. If you do not specify a value, then all columns are returned. The order of the column names in the list indicates the order of the cells of the row set.
fileProtection	Table Protection Information	false	Specifies information that you use to access data sets or tables that are protected. Provide password values in the format password-type=password. Possible values for password-type are "ALTER", "PW", "READ", or "WRITE". A password value must be a valid eight-character SAS name.
fileProtectionEncoding	string	false	Specifies the encoding for the password values in the fileProtection structure. If the value is "base64", then the password values in the fileProtection structure should be encoded by converting the text to UTF-8 and base64-encoding the result. If no value is provided, then the password values of the fileProtection structure are expected to be clear text.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	No resource exists at the requested path.	Schema