Logo
MicroStrategy REST API API Documentation

Save a datamart definition to a specific folder, with a specific name, though an instance, by Modelling Service

POST {{baseUrl}}/api/model/datamarts/:datamartId/instances/saveAs

Save a datamart definition to a specific folder, with a specific name, through an in-memory instance. Prompt options can be set to control if filters and template of the datamart will be prompted next time you open the datamart, and if current answers to the prompts will be set as the default ones. If a datamart is saved successfully, an ID is returned in the response body. This ID is an unique identifier of that datamart in metadata. The instance's ID is required to execute this request.

Use promptOptions to determine prompt behaviors when saving a datamart. All options are optional. By default, all options are true, which means filters and template will be both prompted, and current answers to the prompts will be set as the default ones.

* saveAsWithAnswers: Whether current answers to the prompts will be set as the default ones next time you open the datamart.
* saveAsFilterWithPrompts: Whether filters will be prompted next time you open the datamart.
* saveAsTemplateWithPrompts: Whether template will be prompted next time you open the datamart.

 

Body PARAM

Key Datatype Required Description 
overwrite
null Use overwrite to overwrite an existing datamart through an in-memory instance.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
X-MSTR-MS-Instance
string (Required) datamart instance ID




RESPONSES

status





Curl
curl -X POST 'baseUrl/api/model/datamarts/:datamartId/instances/saveAs?overwrite=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Instance: rd_datamartInstanceId' -d '{"name":"New name","destinationFolderId":"destinationFolderId","promptOptions":{"saveAsWithAnswers":true,"saveAsFilterWithPrompts":true,"saveAsTemplateWithPrompts":true}}'

ENDPOINTS