Read the prompt of the table
GET {{baseUrl}}/api/model/tables/:tableId/prompts/:promptId
This API returns the definition of a single prompt. The prompt should exist in the prompt list of the table. You may use GET The project ID is required to return a prompt's definition in metadata. The changeset ID is required to return a prompt's definition within a specific changeset. To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used. The changeset ID is for returning a prompt's definition within a specific changeset. It can be obtained using the changeset creation API. An authorization token is for executing the request and can be obtained using Authentication endpoints./api/model/tables/{tableId} API and check the sapHanaParameters field to view the list of existing prompts. It should be noted that currently this API only suits SAP HANA tables with input parameters, because only these tables have prompts, and one input parameter corresponds to one very prompt. Meanwhile, user should have read access to the table.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"information": {
"dateCreated": "2022-04-19T06:25:44.000Z",
"dateModified": "2022-06-09T08:09:15.457Z",
"versionId": "0706204A4063A2DAE7A7F3B37713BD45",
"primaryLocale": "en-US",
"objectId": "AA1E3898B82D47329BC6BFB44379362D",
"subType": "prompt_string",
"name": "new_name",
"description": "hierarchical value help"
},
"title": "new title",
"instruction": "new instruction",
"restriction": {
"required": true,
"allowPersonalAnswers": "none"
}
} |
ENDPOINTS