Skip to main content

Update a prompt of an SAP HANA table with input parameters

Available since 2021 Update 6
tip

You can try out this workflow at REST API Playground.

Learn more about MicroStrategy REST API Playground here.

Starting in MicroStrategy 2021 Update 6, you can use REST APIs to update a prompt of a table through the Modeling service.

info

This workflow applies only to SAP HANA tables with input parameters because only these tables have prompts, and one input parameters corresponds to one prompt. For more information, see KB48437: Support for SAP HANA calculation views with input parameters.

tip

You should at least have read access to the table to successfully complete this workflow. If the prompt you want to update is a managed object, write access to the table is also required. The managed prompts of an SAP HANA table with input parameters are automatically created by MicroStrategy by default. However, you can choose to replace these managed prompts with standalone ones by following the steps in Update SAP HANA parameters for an SAP HANA table with input parameters. For more information on managed objects, see About Managed Objects.

You want to update the prompt of a table. The object ID of the table is 84AF2517E662417D9924FD678B44591A. The table is in the MicroStrategy Tutorial Advanced project and its ID is 6AB8DFFE4B99B7F6FB0E94AD176C4A28. The object ID of the current prompt is 339585B03F354D11AE8760C4489160F1 and you want to update fields of the prompt, for example, the name and default answers.

info

Changesets are used in this workflow. For information on how to create and use changesets, see Changesets.

schemaEdit is required to be true if this changeset ID is used to create or update schema objects through the corresponding APIs (tables, facts, attributes, hierarchies, transformation, partitions, and functions).

Workflow​

Update a table prompt with PUT /api/model/tables/{tableId}/prompts/{promptId}​

The prompt you are updating must already be in the prompt list of the current table.

You must use GET /api/model/tables/{tableId} and check the sapHanaParameters field to view the list of existing prompts.

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "sidv53fj5kagqnl544j8krdl05"
"X-MSTR-MS-Changeset": "6AB8DFFE4B99B7F6FB0E94AD176C4A28"

Sample Request Body:

{
  "information": {
    "subType": "prompt_string",
    "name": "newName",
    "description": "a new prompt definition"
  },
  "title": "a new static list",
  "instruction": "a new static list",
  "defaultAnswer": {
    "value": "111,222"
  },
  "restriction": {
    "required": true,
    "allowPersonalAnswers": "none"
  }
}

Sample Curl:

curl -X PUT "http://10.23.38.62:8080/MicroStrategyLibrary/api/model/tables/84AF2517E662417D9924FD678B44591A/prompts/339585B03F354D11AE8760C4489160F1" \
-H "X-MSTR-MS-Changeset: 6AB8DFFE4B99B7F6FB0E94AD176C4A28" \
-H "Content-Type: application/json" \
-H "X-MSTR-AuthToken: sidv53fj5kagqnl544j8krdl05" \
-H "Cookie: JSESSIONID=3374D7CF489BEAC87C495CE5BB0BD7ED; iSession=62i31bvfoctesonlukpo8r83th" \
--data-raw '{"information": {"subType": "prompt_string", "name": "newName", "description": "a new prompt definition"}, "title": "a new static list", "instruction": "a new static list", "defaultAnswer": {"value": "111,222"}, "restriction": {"required": true, "allowPersonalAnswers": "none"}}'

Sample Response Body:

You can view the new prompt definition in the body of the response.

{
  "information": {
    "dateCreated": "2022-04-19T06:25:44.000Z",
    "dateModified": "2022-06-08T09:29:08.875Z",
    "versionId": "5821E67A4847D914ABA627BB4F9DBB08",
    "primaryLocale": "en-US",
    "objectId": "339585B03F354D11AE8760C4489160F1",
    "subType": "prompt_string",
    "name": "newName",
    "description": "a new prompt definition"
  },
  "title": "a new static list",
  "instruction": "a new static list",
  "defaultAnswer": {
    "value": "111,222"
  },
  "restriction": {
    "required": true,
    "allowPersonalAnswers": "none"
  }
}

Response Code: 201 (The prompt of the table is updated successfully in the changeset.)