Get prompt content from a data set

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

Internal-Use Only

Returns content useful for populating prompts more effectively.

Request Samples

application/vnd.sas.compute.data.table.prompt.content.request+json
1

Response Samples

200
application/vnd.sas.compute.data.table.prompt.content+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/{sessionId}/data/SASHELP/CARS/promptContent?_dpt={dptId}&viewId={viewId}",
23      "method": "GET",
24      "rel": "self",
25      "type": "application/vnd.sas.compute.data.table.prompt.content",
26      "uri": "/compute/sessions/{sessionId}/data/SASHELP/CARS/promptContent?_dpt={dptId}&viewId={viewId}"
27    },
28    {
29      "href": "/compute/sessions/{sessionId}/data/%24VIEWS/{viewId}",
30      "method": "DELETE",
31      "rel": "deleteView",
32      "uri": "/compute/sessions/{sessionId}/data/%24VIEWS/{viewId}"
33    },
34    {
35      "href": "/compute/sessions/{sessionId}/data/SASHELP/CARS/promptContent?_dpt={dptId}&limit=10&start=10&viewId=TCBE3DBC1_A8DD_D448_777AA73AAF04",
36      "method": "GET",
37      "rel": "next",
38      "type": "application/vnd.sas.compute.data.table.prompt.content",
39      "uri": "/compute/sessions/{sessionId}/data/SASHELP/CARS/promptContent?_dpt={dptId}&limit=10&start=10&viewId=TCBE3DBC1_A8DD_D448_777AA73AAF04"
40    }
41  ],
42  "rows": [
43    {
44      "formatted": [
45        "Volvo",
46        " C70 HPT convertible 2dr",
47        "Sedan",
48        "Europe",
49        "Front",
50        " $42,565",
51        " $40,083",
52        2.3,
53        5,
54        242,
55        20,
56        26,
57        3450,
58        105,
59        186
60      ],
61      "raw": [
62        "Volvo",
63        " C70 HPT convertible 2dr",
64        "Sedan",
65        "Europe",
66        "Front",
67        42565,
68        40083,
69        2.3,
70        5,
71        242,
72        20,
73        26,
74        3450,
75        105,
76        186,
77        180
78      ]
79    }
80  ],
81  "version": 1
82}

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 rows to return. Default: 10
start	integer	false	Specifies the offset of the first row to return. Default: 0

Request Body

Specifies a prompt content creation request.

Provides a request that you can use to build prompt content based on a given dataset.

Example:

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

Name	Type	Required	Description
where	string	false	Specifies that a standard SAS WHERE clause was used to build the content 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 the returned content. 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 prompt content.
columnNaturalOrder	boolean	false	When includeColumns is specified, a value of true for columnNaturalOrder specifies that the cells of the prompt content are returned in the order in which they occur in the data set instead of in the order that is specified by includeColumns.
sortBy	array [Table Sorting Request]	false	Specifies an array of objects that describe the sort definitions to use in the prompt content.
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