Logo
MicroStrategy REST API API Documentation

Save report through an instance by Modelling Service

POST {{baseUrl}}/api/model/reports/{{reportId}}/instances/save

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

Use promptOptions to determine prompt behaviors when saving a report. 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 report.
* saveAsFilterWithPrompts: Whether filters will be prompted next time you open the report.
* saveAsTemplateWithPrompts: Whether template will be prompted next time you open the report.

 

Body PARAM

Key Datatype Required Description 



HEADERS

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




RESPONSES

status





Curl
curl -X POST 'baseUrl/api/model/reports/reportId/instances/save' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Instance: rd_reportInstanceId' -d '{"promptOptions":{"saveAsWithAnswers":true,"saveAsFilterWithPrompts":true,"saveAsTemplateWithPrompts":true}}'

ENDPOINTS