Skip to content

Commit f8c1bfc

Browse files
ziyuhehezhe
ziyuhehe
and
zhe
authored
Update (#73)
* Update * Update --------- Co-authored-by: zhe <zhe@microstrategy.com>
1 parent e0f7c2d commit f8c1bfc

17 files changed

Lines changed: 1175 additions & 26 deletions

‎docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,24 @@ This workflow sample demonstrates how to create and update a mobile subscription
1212

1313
:::tip
1414

15-
This workflow follows the general steps described in [Create and get a subscription](create-and-get-a-subscription.md). You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-da43d1b1-a332-4452-829f-e07a041abc8f?ctx=documentation).
15+
This workflow follows the general steps described in
16+
[Create and get a subscription](create-and-get-a-subscription.md). You can try out this workflow at
17+
[REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-da43d1b1-a332-4452-829f-e07a041abc8f?ctx=documentation).
1618

1719
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1820

1921
:::
2022

2123
## Create a new mobile subscription
2224

23-
Endpoint: [POST /api/subscriptions](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/createSubscription)
25+
Endpoint:
26+
[POST /api/subscriptions](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/createSubscription)
2427

25-
This endpoint allows you to create a new subscription for a given project. Obtain the authorization token needed to execute the request using `POST /api/auth/login`. Obtain the project ID using `GET /api/projects`. Provide the information used to create a subscription in the body parameter of the request. If the call is successful, the resulting HTTP response returns an HTTP status code of 201 and a response body containing all the information on the newly created subscription.
28+
This endpoint allows you to create a new subscription for a given project. Obtain the authorization
29+
token needed to execute the request using `POST /api/auth/login`. Obtain the project ID using
30+
`GET /api/projects`. Provide the information used to create a subscription in the body parameter of
31+
the request. If the call is successful, the resulting HTTP response returns an HTTP status code of
32+
201 and a response body containing all the information on the newly created subscription.
2633

2734
Sample Request
2835

@@ -204,9 +211,15 @@ Sample Response
204211

205212
## Update an existing mobile subscription
206213

207-
Endpoint: [PUT /api/subscriptions/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/updateSubscription)
214+
Endpoint:
215+
[PUT /api/subscriptions/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/updateSubscription)
208216

209-
This endpoint allows you to update all of the information for a specific subscription. Obtain the authorization token needed to execute the request using `POST /api/auth/login`. Obtain the project ID using `GET /api/projects`. Provide the information used to update a subscription in the body parameter of the request and provide the subscription ID in the request path. If the call is successful, the resulting HTTP response returns an HTTP status code of 200 and a response body containing all the information on the updated subscription.
217+
This endpoint allows you to update all of the information for a specific subscription. Obtain the
218+
authorization token needed to execute the request using `POST /api/auth/login`. Obtain the project
219+
ID using `GET /api/projects`. Provide the information used to update a subscription in the body
220+
parameter of the request and provide the subscription ID in the request path. If the call is
221+
successful, the resulting HTTP response returns an HTTP status code of 200 and a response body
222+
containing all the information on the updated subscription.
210223

211224
Sample Request
212225

‎docs/common-workflows/analytics/auto-bot-api/get-question-by-id.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ This workflow sample demonstrates how to get a question's answer by the question
1010

1111
:::info
1212

13-
Obtain the authorization token needed to execute the request using [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
13+
Obtain the authorization token needed to execute the request using
14+
[POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
1415

1516
:::
1617

1718
## Get a question with question ID
1819

19-
Endpoint: [GET /api/questions/\{questionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/queryMessage_1)
20+
Endpoint:
21+
[GET /api/questions/\{questionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/queryMessage_1)
2022

21-
:::note
22-
Replace `{questionId}` in `GET /api/questions/{questionId}` with your question ID from `POST /api/questions`.
23-
:::
23+
:::note Replace `{questionId}` in `GET /api/questions/{questionId}` with your question ID from
24+
`POST /api/questions`. :::
2425

25-
Sample Request Body:
26-
No request body.
26+
Sample Request Body: No request body.
2727

2828
Sample Curl:
2929

@@ -49,7 +49,8 @@ The response is the question and answer with the specific ID.
4949

5050
### Response when the question is still being processed
5151

52-
If the response code is 202, indicating that the question is still being processed, continue calling this API to check the status of the question.
52+
If the response code is 202, indicating that the question is still being processed, continue calling
53+
this API to check the status of the question.
5354

5455
If the question is being processed, the response is:
5556

‎docs/common-workflows/analytics/auto-bot-api/get-questions-by-bot.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,20 @@ description: This workflow sample demonstrates how to get the historical chat me
66

77
<Available since="Strategy ONE (March 2025)" />
88

9-
This API is used to get the historical questions from a specific agent for the current user, which can be used as the `history` parameter in the `Ask a question to a specific agent` API.
9+
This API is used to get the historical questions from a specific agent for the current user, which
10+
can be used as the `history` parameter in the `Ask a question to a specific agent` API.
1011

1112
:::info
1213

13-
Obtain the authorization token needed to execute the request using [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
14+
Obtain the authorization token needed to execute the request using
15+
[POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
1416

1517
:::
1618

1719
## Get Questions by Agent
1820

19-
Endpoint: [GET /api/questions/](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/getChats_1)
21+
Endpoint:
22+
[GET /api/questions/](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/getChats_1)
2023

2124
Sample Request Headers:
2225

@@ -97,6 +100,5 @@ The response is a list of questions and answers from the specific agent.
97100
}
98101
```
99102

100-
:::note
101-
Questions with `type` as `snapshots` should not be used as history in the `Ask a Specific Bot a Question` API.
102-
:::
103+
:::note Questions with `type` as `snapshots` should not be used as history in the
104+
`Ask a Specific Bot a Question` API. :::

‎docs/common-workflows/modeling/manage-scope-filter-objects/update-a-scope-filter-definition.md‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
22
title: Update a scope filter's definition
33
sidebar_label: Update a scope filter's definition
4-
description: This workflow sample demonstrates how to update a scope filter's definition using the Modeling service.
4+
description:
5+
This workflow sample demonstrates how to update a scope filter's definition using the Modeling
6+
service.
57
---
68

79
<Available since="Strategy ONE (November 2025)" />
810

911
:::tip
1012

11-
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/microstrategy-rest-api/collection/5aq5sem/strategy-rest-api-workflows).
13+
You can try out this workflow at
14+
[REST API Playground](https://www.postman.com/microstrategysdk/microstrategy-rest-api/collection/5aq5sem/strategy-rest-api-workflows).
1215

1316
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1417

1518
:::
1619

17-
This workflow sample demonstrates how to update a scope filter's definition through the using service.
20+
This workflow sample demonstrates how to update a scope filter's definition through the using
21+
service.
1822

1923
1. Create a changeset
2024
1. [Update a scope filter definition](#update-a-scope-filter)
@@ -23,19 +27,23 @@ This workflow sample demonstrates how to update a scope filter's definition thro
2327

2428
:::info
2529

26-
Get the authorization token needed to execute the request with [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
30+
Get the authorization token needed to execute the request with
31+
[POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
2732

28-
Get the project ID from [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1).
33+
Get the project ID from
34+
[GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1).
2935

3036
:::
3137

32-
Changesets are used in this workflow. For information on how to create and use changesets, see [Changesets](/docs/common-workflows/modeling/changesets.md).
38+
Changesets are used in this workflow. For information on how to create and use changesets, see
39+
[Changesets](/docs/common-workflows/modeling/changesets.md).
3340

3441
## Update a scope filter
3542

3643
Endpoint:[PUT /api/model/scopeFilters/\{scopeFilterId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Scope%20Filters/putScopeFilter)
3744

38-
You want to update the scope filter to have an attribute elements prompt based on the "Customer" attribute. The attribute elements should be in the "Smith:Laurell" and "Smith:Sarah" lists.
45+
You want to update the scope filter to have an attribute elements prompt based on the "Customer"
46+
attribute. The attribute elements should be in the "Smith:Laurell" and "Smith:Sarah" lists.
3947

4048
Sample Request Header:
4149

‎docs/common-workflows/mosaic/manage-data-model-external-data-models/create-a-data-model-external-data-model.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Create an external data model in a data model
3+
sidebar_label: Create an external data model in a data model
4+
description: This workflow sample demonstrates how to create an external data model in a data model through the Modeling service.
5+
---
6+
7+
<Available since="Strategy ONE (January 2026)" />
8+
9+
:::tip
10+
11+
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/microstrategy-rest-api/collection/5aq5sem/strategy-rest-api-workflows).
12+
13+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
14+
15+
:::
16+
17+
This workflow sample demonstrates how to create an external data model in a data model through the Modeling service.
18+
19+
:::info
20+
21+
Get the authorization token needed to execute the request with [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
22+
23+
Get the project ID from [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1).
24+
25+
:::
26+
27+
:::tip
28+
29+
Changesets are used in this workflow. For information on how to create and use changesets, see [Changesets](/docs/common-workflows/modeling/changesets.md).
30+
31+
:::
32+
33+
You can create an external data model in a data model using the following endpoint: [POST /api/model/dataModels/\{dataModelId}/externalDataModels](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Data%20Models/postExternalDataModel).
34+
35+
Sample Request Header:
36+
37+
```http
38+
"accept": "application/json"
39+
"X-MSTR-AuthToken": "o0ak9privdo27nfo798j40m8aa"
40+
"X-MSTR-MS-Changeset": "805C5F3FB78A436FAE37C943471C24AD"
41+
```
42+
43+
Sample Request Body:
44+
45+
```json
46+
{
47+
"baseDataModel": {
48+
"objectId": "FF2970B298464D88806CCD39F1BA1919",
49+
"subType": "report_emma_cube",
50+
"name": "data model 1"
51+
},
52+
"alias": "external data model 1"
53+
}
54+
```
55+
56+
Sample Curl:
57+
58+
```bash
59+
curl -X POST "https://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/04DCF4F028354FC0AE4B8120CB1983A6/externalDataModels" -H "accept: application/json" -H "X-MSTR-AuthToken: o0ak9privdo27nfo798j40m8aa" -H "X-MSTR-MS-Changeset: 805C5F3FB78A436FAE37C943471C24AD" -H "Content-Type: application/json" -d '{"baseDataModel":{"objectId":"FF2970B298464D88806CCD39F1BA1919","subType":"report_emma_cube","name":"data model 1"},"alias":"external data model 1"}'
60+
```
61+
62+
Sample Response Body:
63+
64+
```json
65+
{
66+
"id": "AE2FC8E446B14162BF2BCAC64981D5A2",
67+
"baseDataModel": {
68+
"objectId": "FF2970B298464D88806CCD39F1BA1919",
69+
"subType": "report_emma_cube",
70+
"name": "data model 1"
71+
},
72+
"alias": "external data model 1",
73+
"objects": [
74+
{
75+
"objectId": "2877DDA7059B4FFE9DE2711F4D7CD29A",
76+
"subType": "attribute",
77+
"name": "Customer",
78+
"hidden": false,
79+
"alias": "Customer (2)"
80+
},
81+
{
82+
"objectId": "B44A2F49F6B6441796FCA511F1BBFDA5",
83+
"subType": "attribute",
84+
"name": "Churn",
85+
"hidden": false,
86+
"alias": ""
87+
},
88+
{
89+
"objectId": "3FDFCCEFB640428E9341D45B68073601",
90+
"subType": "attribute",
91+
"name": "Lifetime Value Score",
92+
"hidden": false,
93+
"alias": ""
94+
}
95+
]
96+
}
97+
```
98+
99+
Response Code: 201 (A new external data model is created successfully in the changeset.)

‎docs/common-workflows/mosaic/manage-data-model-external-data-models/delete-a-data-model-external-data-model.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Delete a data model external data model
3+
sidebar_label: Delete a data model external data model
4+
description: This workflow sample demonstrates how to delete a data model external data model through the Modeling service.
5+
---
6+
7+
<Available since="Strategy ONE (January 2026)" />
8+
9+
:::tip
10+
11+
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/microstrategy-rest-api/collection/5aq5sem/strategy-rest-api-workflows).
12+
13+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
14+
15+
:::
16+
17+
This workflow sample demonstrates how to delete a data model external data model through the Modeling service.
18+
19+
:::info
20+
21+
Get the authorization token needed to execute the request with [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
22+
23+
Get the project ID from [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1).
24+
25+
:::
26+
27+
:::tip
28+
29+
Changesets are used in this workflow. For information on how to create and use changesets, see [Changesets](/docs/common-workflows/modeling/changesets.md).
30+
31+
:::
32+
33+
You can delete an external data model from a data model using the following endpoint: [DELETE /api/model/dataModels/\{dataModelId}/externalDataModels/\{externalDataModelId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Data%20Models/deleteExternalDataModel).
34+
35+
Sample Request Header:
36+
37+
```http
38+
"accept": "application/json"
39+
"X-MSTR-AuthToken": "o0ak9privdo27nfo798j40m8aa"
40+
"X-MSTR-MS-Changeset": "805C5F3FB78A436FAE37C943471C24AD"
41+
```
42+
43+
Sample Request Body: Empty
44+
45+
Sample Curl:
46+
47+
```bash
48+
curl -X DELETE "https://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/04DCF4F028354FC0AE4B8120CB1983A6/externalDataModels/AE2FC8E446B14162BF2BCAC64981D5A2" -H "accept: application/json" -H "X-MSTR-AuthToken: o0ak9privdo27nfo798j40m8aa" -H "X-MSTR-MS-Changeset: 805C5F3FB78A436FAE37C943471C24AD"
49+
```
50+
51+
Sample Response Body: Empty
52+
53+
Sample Response Code: 204 (The external data model is deleted successfully in the changeset.)

‎docs/common-workflows/mosaic/manage-data-model-external-data-models/manage-data-model-external-data-models.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Manage data model external data models
3+
description: You can use REST API requests to manage data model external data models.
4+
---
5+
6+
<Available since="Strategy ONE (January 2026)" />
7+
8+
:::tip
9+
10+
You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/microstrategy-rest-api/collection/5aq5sem/strategy-rest-api-workflows).
11+
12+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
13+
14+
:::
15+
16+
You can use REST API requests to manage data model external data models.
17+
18+
- [Retrieve Data Model External Data Models](retrieve-data-model-external-data-models.md)
19+
- [Create a Data Model External Data Model](create-a-data-model-external-data-model.md)
20+
- [Update a Data Model External Data Model](update-a-data-model-external-data-model.md)
21+
- [Delete a Data Model External Data Model](delete-a-data-model-external-data-model.md)
22+
- [Update a Data Model External Data Model's Object](update-a-data-model-external-data-models-object.md)
23+
- [Refresh a Data Model External Data Models](refresh-a-data-model-external-data-models.md)

0 commit comments

Comments
 (0)