Get a list of columns in a table

get/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns

Internal-Use Only

Returns a collection of column info available for a table. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.column+json.

Request Samples

Response Samples

200
application/json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "up",
6      "href": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/",
7      "uri": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/",
8      "type": "application/vnd.sas.cas.table"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=0&limit=10",
14      "uri": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=0&limit=10",
15      "type": "application/vnd.sas.collection",
16      "itemType": "application/vnd.sas.cas.column"
17    },
18    {
19      "method": "GET",
20      "rel": "collection",
21      "href": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns",
22      "uri": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns",
23      "type": "application/vnd.sas.collection",
24      "itemType": "application/vnd.sas.cas.column"
25    },
26    {
27      "method": "GET",
28      "rel": "next",
29      "href": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=10&limit=10",
30      "uri": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=10&limit=10",
31      "type": "application/vnd.sas.collection"
32    },
33    {
34      "method": "GET",
35      "rel": "last",
36      "href": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=10&limit=10",
37      "uri": "/casManagement/servers/cas-shared-default/caslibs/Public/tables/CONTACTS/columns?excludeItemLinks=true&sessionId&start=10&limit=10",
38      "type": "application/vnd.sas.collection"
39    }
40  ],
41  "name": "columns",
42  "accept": "application/vnd.sas.cas.column",
43  "count": 12,
44  "items": [
45    {
46      "version": 1,
47      "name": "ID",
48      "type": "double",
49      "rawLength": 8,
50      "formattedLength": 12,
51      "numberFormatLength": 0,
52      "numberFormatDecimals": 0,
53      "indexed": true
54    },
55    {
56      "version": 1,
57      "name": "COMPANY",
58      "type": "char",
59      "rawLength": 34,
60      "formattedLength": 34,
61      "numberFormatLength": 0,
62      "numberFormatDecimals": 0,
63      "indexed": false
64    },
65    {
66      "version": 1,
67      "name": "CONTACT",
68      "type": "char",
69      "rawLength": 20,
70      "formattedLength": 20,
71      "numberFormatLength": 0,
72      "numberFormatDecimals": 0,
73      "indexed": false
74    },
75    {
76      "version": 1,
77      "name": "ADDRESS",
78      "type": "char",
79      "rawLength": 30,
80      "formattedLength": 30,
81      "numberFormatLength": 0,
82      "numberFormatDecimals": 0,
83      "indexed": false
84    },
85    {
86      "version": 1,
87      "name": "CITY",
88      "type": "char",
89      "rawLength": 28,
90      "formattedLength": 28,
91      "numberFormatLength": 0,
92      "numberFormatDecimals": 0,
93      "indexed": false
94    },
95    {
96      "version": 1,
97      "name": "STATE",
98      "type": "char",
99      "rawLength": 14,
100      "formattedLength": 14,
101      "numberFormatLength": 0,
102      "numberFormatDecimals": 0,
103      "indexed": false
104    },
105    {
106      "version": 1,
107      "name": "PHONE",
108      "type": "char",
109      "rawLength": 12,
110      "formattedLength": 12,
111      "numberFormatLength": 0,
112      "numberFormatDecimals": 0,
113      "indexed": false
114    },
115    {
116      "version": 1,
117      "name": "OS",
118      "type": "char",
119      "rawLength": 16,
120      "formattedLength": 16,
121      "numberFormatLength": 0,
122      "numberFormatDecimals": 0,
123      "indexed": false
124    },
125    {
126      "version": 1,
127      "name": "DATABASE",
128      "type": "char",
129      "rawLength": 24,
130      "formattedLength": 24,
131      "numberFormatLength": 0,
132      "numberFormatDecimals": 0,
133      "indexed": false
134    },
135    {
136      "version": 1,
137      "name": "DATE",
138      "type": "char",
139      "rawLength": 15,
140      "formattedLength": 15,
141      "numberFormatLength": 0,
142      "numberFormatDecimals": 0,
143      "indexed": false
144    }
145  ],
146  "version": 2
147}

Path Parameters

Name	Type	Required	Description
caslibName	string	true	The name of the Caslib containing the table.
serverName	string	true	The name of the server containing the Caslib.
tableName	string	true	The name of table for which column info is requested.

Query Parameters

Name	Type	Required	Description
sessionId	string	false	The optional ID of the session containing the Caslib. If unspecified, only tables in global caslibs will be accessible.
excludeItemLinks	boolean	false	Determines whether item links are excluded from results. Defaults to true.
filter	string<filter-criteria>	false	Filter criteria for returned items. The valid filter fields are the first-level fields in each item. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by name starting with: filter=startsWith(name, 'CAS') Search by name: filter=eq(name, 'CASUSER') Search for multiple items: filter=in(name, 'CASUSER', 'Public')
limit	integer	false	Maximum number of items to return in this page of results. The actual number of returned items can be less if the collection has been exhausted. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort returned items. The sort criteria supports the first-level fields in each item. Some sample sorts: Sort by ascending name: sortBy=name:ascending Sort by descending name: sortBy=name:descending Sorting is not performed if this query parameter is omitted.
start	integer	false	The starting index of the first item in a page. Defaults to 0.

Responses

Status	Meaning	Description
200	OK	The requested table's column information was returned.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	The requested CAS server or Caslib does not exist.
409	Conflict	The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.