Get a row set from a data set

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

Internal-Use Only

Returns a row set that is based on the specified request body.

Request Samples

application/vnd.sas.compute.data.table.row.set.request+json
1

Response Samples

200
application/vnd.sas.compute.data.table.row.set+json
1{
2  "columnDetail": "names",
3  "columns": [
4    "Make",
5    "Model",
6    "Type",
7    "Origin",
8    "DriveTrain",
9    "MSRP",
10    "Invoice",
11    "EngineSize",
12    "Cylinders",
13    "Horsepower",
14    "MPG_City",
15    "MPG_Highway",
16    "Weight",
17    "Wheelbase",
18    "Length"
19  ],
20  "links": [
21    {
22      "href": "/compute/sessions/RKEY-ses0000/data/MYCA/MYCARS/rowSet",
23      "method": "GET",
24      "rel": "self",
25      "type": "application/vnd.sas.compute.data.table.row.set",
26      "uri": "/compute/sessions/RKEY-ses0000/data/MYCA/MYCARS/rowSet"
27    }
28  ],
29  "rows": [
30    [
31      "Toyota       ",
32      " Corolla CE 4dr                         ",
33      "Sedan   ",
34      "Asia  ",
35      "Front",
36      " $14,085",
37      " $13,065",
38      1.8,
39      4,
40      130,
41      32,
42      40,
43      2502,
44      102,
45      178
46    ],
47    [
48      "Toyota       ",
49      " Corolla S 4dr                          ",
50      "Sedan   ",
51      "Asia  ",
52      "Front",
53      " $15,030",
54      " $13,650",
55      1.8,
56      4,
57      130,
58      32,
59      40,
60      2524,
61      102,
62      178
63    ],
64    [
65      "Toyota       ",
66      " Corolla LE 4dr                         ",
67      "Sedan   ",
68      "Asia  ",
69      "Front",
70      " $15,295",
71      " $13,889",
72      1.8,
73      4,
74      130,
75      32,
76      40,
77      2524,
78      102,
79      178
80    ],
81    [
82      "Toyota       ",
83      " Echo 2dr manual                        ",
84      "Sedan   ",
85      "Asia  ",
86      "Front",
87      " $10,760",
88      " $10,144",
89      1.5,
90      4,
91      108,
92      35,
93      43,
94      2035,
95      93,
96      163
97    ],
98    [
99      "Toyota       ",
100      " Echo 2dr auto                          ",
101      "Sedan   ",
102      "Asia  ",
103      "Front",
104      " $11,560",
105      " $10,896",
106      1.5,
107      4,
108      108,
109      33,
110      39,
111      2085,
112      93,
113      163
114    ],
115    [
116      "Toyota       ",
117      " Echo 4dr                               ",
118      "Sedan   ",
119      "Asia  ",
120      "Front",
121      " $11,290",
122      " $10,642",
123      1.5,
124      4,
125      108,
126      35,
127      43,
128      2055,
129      93,
130      163
131    ],
132    [
133      "Toyota       ",
134      " Camry LE 4dr                           ",
135      "Sedan   ",
136      "Asia  ",
137      "Front",
138      " $19,560",
139      " $17,558",
140      2.4,
141      4,
142      157,
143      24,
144      33,
145      3086,
146      107,
147      189
148    ],
149    [
150      "Toyota       ",
151      " Camry LE V6 4dr                        ",
152      "Sedan   ",
153      "Asia  ",
154      "Front",
155      " $22,775",
156      " $20,325",
157      3,
158      6,
159      210,
160      21,
161      29,
162      3296,
163      107,
164      189
165    ],
166    [
167      "Toyota       ",
168      " Camry Solara SE 2dr                    ",
169      "Sedan   ",
170      "Asia  ",
171      "Front",
172      " $19,635",
173      " $17,722",
174      2.4,
175      4,
176      157,
177      24,
178      33,
179      3175,
180      107,
181      193
182    ],
183    [
184      "Toyota       ",
185      " Camry Solara SE V6 2dr                 ",
186      "Sedan   ",
187      "Asia  ",
188      "Front",
189      " $21,965",
190      " $19,819",
191      3.3,
192      6,
193      225,
194      20,
195      29,
196      3417,
197      107,
198      193
199    ],
200    [
201      "Toyota       ",
202      " Avalon XL 4dr                          ",
203      "Sedan   ",
204      "Asia  ",
205      "Front",
206      " $26,560",
207      " $23,693",
208      3,
209      6,
210      210,
211      21,
212      29,
213      3417,
214      107,
215      192
216    ],
217    [
218      "Toyota       ",
219      " Camry XLE V6 4dr                       ",
220      "Sedan   ",
221      "Asia  ",
222      "Front",
223      " $25,920",
224      " $23,125",
225      3,
226      6,
227      210,
228      21,
229      29,
230      3362,
231      107,
232      189
233    ],
234    [
235      "Toyota       ",
236      " Camry Solara SLE V6 2dr                ",
237      "Sedan   ",
238      "Asia  ",
239      "Front",
240      " $26,510",
241      " $23,908",
242      3.3,
243      6,
244      225,
245      20,
246      29,
247      3439,
248      107,
249      193
250    ],
251    [
252      "Toyota       ",
253      " Avalon XLS 4dr                         ",
254      "Sedan   ",
255      "Asia  ",
256      "Front",
257      " $30,920",
258      " $27,271",
259      3,
260      6,
261      210,
262      21,
263      29,
264      3439,
265      107,
266      192
267    ],
268    [
269      "Toyota       ",
270      " Sienna CE                              ",
271      "Sedan   ",
272      "Asia  ",
273      "Front",
274      " $23,495",
275      " $21,198",
276      3.3,
277      6,
278      230,
279      19,
280      27,
281      4120,
282      119,
283      200
284    ],
285    [
286      "Toyota       ",
287      " Sienna XLE Limited                     ",
288      "Sedan   ",
289      "Asia  ",
290      "Front",
291      " $28,800",
292      " $25,690",
293      3.3,
294      6,
295      230,
296      19,
297      27,
298      4165,
299      119,
300      200
301    ]
302  ],
303  "start": 1,
304  "version": 1
305}

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
format	boolean	false	Specifies whether to format the data in the cells. Default: true
formatMissingValues	boolean	false	If set to true, SAS missing values found in the data will be formatted based on the setting of the SAS Option MISSING. Otherwise, a NULL value will be returned.
limit	integer	false	Specifies the maximum number of rows to return. Default: 10
returnNumAsString	boolean	false	If set to true, SAS numeric values found in the data will be returned as strings. Default: false
start	integer	false	Specifies the offset of the first row to return. Default: 0

Request Body

Specifies a row set creation request.

Provides a request that you can use to generate a row set.

Example:

{"where":"name='Fred'","fileProtection":{"read":"cmVhZFBX","alter":"YWx0ZXJQVw","write":"d3JpdGVQVw"},"fileProtectionEncoding":"base64","columnDetail":"names","includeColumns":["name","sex"],"columnNaturalOrder":false,"columnFormatting":[[{"name":"sex"},{"format":"$GENDER6."}]]}

Name	Type	Required	Description
where	string	false	Specifies that a standard SAS WHERE clause was used to build the row set for this request.
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.
columnDetail	string	false	Specifies the level of column information to return. Allowed values: namesdetailsummary Default: names
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 for the cells of the row set.
columnNaturalOrder	boolean	false	When includeColumns is specified, a value of true for columnNaturalOrder specifies that the cells of the row set are returned in the order in which they occur in the data set instead of in the order that is specified by includeColumns.
columnFormatting	array [User Specified Column Formatting]	false	Specifies the format to apply to a column when retrieving data from a cell.

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