Update a Prompt of the SAP HANA Table

PUT {{baseUrl}}/api/model/tables/:tableId/prompts/:promptId

This API updates a specific prompt in the changeset, based on the definition provided in the request body. It returns the prompt's updated definition in the changeset. It should be noted that 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. In addition, the prompt should exist in the prompt list of the table. You may use GET /api/model/tables/{tableId} API and check the sapHanaParameters field to view the list of existing prompts. Basically, read access to the table will be checked. If the prompt is a managed object, write access to the table is also required. The Modeling server performs a full validation for each part of the body. If something is wrong, an error will be reported.

The changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.

To save the change in the metadata, commit using the changeset commit API.

Request Body

{"information"=>{"subType"=>"prompt_string", "name"=>"new_name"}, "title"=>"new title", "instruction"=>"new instruction", "restriction"=>{"required"=>true, "allowPersonalAnswers"=>"none"}}

HEADERS

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization Token
X-MSTR-ProjectIDstringProject ID
X-MSTR-MS-ChangesetstringChangeset ID