Skip to content

Commit 23b5160

Browse files
author
zhe_mstr
committed
fix comments
1 parent 4bb5e0f commit 23b5160

File tree

124 files changed

+231
-231
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+231
-231
lines changed

docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This workflow sample demonstrates how to add a datasource to a project. To see h
88
1. [Get list of datasources based on project.](#get-list-of-datasources-based-on-project) `GET /api/projects/{projectId}/datasources`
99
1. [Add a datasource to a project.](#add-datasource-to-project) `PATCH /api/projects/{projectId}/datasources`
1010

11-
A detailed description of each step of this request is listed down below. For this sample we are using the Strategy Tutorial project with project ID B7CA92F04B9FAE8D941C3E9B7E0CD754. You can obtain the project ID from `GET /api/projects`.
11+
A detailed description of each step of this request is listed down below. For this sample we are using the MicroStrategy Tutorial project with project ID B7CA92F04B9FAE8D941C3E9B7E0CD754. You can obtain the project ID from `GET /api/projects`.
1212

1313
## Get list of datasources based on project
1414

@@ -120,7 +120,7 @@ Learn more about Strategy REST API Playground [here](/docs/getting-started/playg
120120

121121
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
122122

123-
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will add a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be adding the Act! Essentials datasource to the Strategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
123+
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will add a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be adding the Act! Essentials datasource to the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
124124

125125
Sample Request
126126

@@ -248,7 +248,7 @@ Learn more about Strategy REST API Playground [here](/docs/getting-started/playg
248248

249249
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
250250

251-
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will remove a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be removing the Act! Essentials datasource from the Strategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
251+
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will remove a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be removing the Act! Essentials datasource from the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
252252

253253
Sample Request
254254

docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Sample Response
141141
After conversion, you should be able to see the DSN-less format connection string in the response by calling the API to get the datasource definition.
142142

143143
```json
144-
"connectionString": "DRIVER={Strategy ODBC Driver for PostgreSQL Wire Protocol};APPLICATIONUSINGTHREADS=1;DATABASE=test;DEFAULTLONGDATABUFFLEN=1024;DESCRIPTION=Strategy ODBC Driver for PostgreSQL Wire Protocol;ENABLEDESCRIBEPARAM=1;ENCRYPTIONMETHOD=1;FETCHTSWTZASTIMESTAMP=1;FETCHTWFSASTIME=1;HOSTNAME=xx.xx.xx.xx;HOSTNAMEINCERTIFICATE=xx.xx.xx.xx;PORTNUMBER=5432;TRANSACTIONERRORBEHAVIOR=0;UID=uid;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;"
144+
"connectionString": "DRIVER={MicroStrategy ODBC Driver for PostgreSQL Wire Protocol};APPLICATIONUSINGTHREADS=1;DATABASE=test;DEFAULTLONGDATABUFFLEN=1024;DESCRIPTION=MicroStrategy ODBC Driver for PostgreSQL Wire Protocol;ENABLEDESCRIBEPARAM=1;ENCRYPTIONMETHOD=1;FETCHTSWTZASTIMESTAMP=1;FETCHTWFSASTIME=1;HOSTNAME=xx.xx.xx.xx;HOSTNAMEINCERTIFICATE=xx.xx.xx.xx;PORTNUMBER=5432;TRANSACTIONERRORBEHAVIOR=0;UID=uid;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;"
145145
```
146146

147147
Sample Request
@@ -188,7 +188,7 @@ Sample Response
188188
"charEncodingWindows": "multibyte",
189189
"charEncodingUnix": "utf8",
190190
"tablePrefix": "",
191-
"connectionString": "DRIVER={Strategy ODBC Driver for PostgreSQL Wire Protocol};APPLICATIONUSINGTHREADS=1;DATABASE=test;DEFAULTLONGDATABUFFLEN=1024;DESCRIPTION=Strategy ODBC Driver for PostgreSQL Wire Protocol;ENABLEDESCRIBEPARAM=1;ENCRYPTIONMETHOD=1;FETCHTSWTZASTIMESTAMP=1;FETCHTWFSASTIME=1;HOSTNAME=xx.xx.xx.xx;HOSTNAMEINCERTIFICATE=xx.xx.xx.xx;PORTNUMBER=5432;TRANSACTIONERRORBEHAVIOR=0;UID=uid;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;",
191+
"connectionString": "DRIVER={MicroStrategy ODBC Driver for PostgreSQL Wire Protocol};APPLICATIONUSINGTHREADS=1;DATABASE=test;DEFAULTLONGDATABUFFLEN=1024;DESCRIPTION=MicroStrategy ODBC Driver for PostgreSQL Wire Protocol;ENABLEDESCRIBEPARAM=1;ENCRYPTIONMETHOD=1;FETCHTSWTZASTIMESTAMP=1;FETCHTWFSASTIME=1;HOSTNAME=xx.xx.xx.xx;HOSTNAMEINCERTIFICATE=xx.xx.xx.xx;PORTNUMBER=5432;TRANSACTIONERRORBEHAVIOR=0;UID=uid;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;",
192192
"parameterizedQueries": false,
193193
"extendedFetch": false,
194194
"login": {
@@ -315,7 +315,7 @@ Sample Response
315315
After conversion, you should be able to see the DSN-less format connection string in the response by calling the API to get the datasource connection definition.
316316

317317
```json
318-
"connectionString": "DRIVER={Strategy ODBC Driver for SQL Server Wire Protocol};DATABASE=tpch;HOSTNAME=10.27.69.102;KEEPALIVE=0;KEEPCONNECTIONACTIVE=0;LOADBALANCETIMEOUT=0;LOADBALANCING=0;LOGINTIMEOUT=15;MAXPOOLSIZE=100;MINPOOLSIZE=0;MULTISUBNETFAILOVER=0 - FALSE;PORTNUMBER=1433;PROXYMODE=0;QUERYTIMEOUT=0;REPORTCODEPAGECONVERSIONERRORS=0;SNAPSHOTSERIALIZABLE=0;SOCKETIDLETIMECHECKINTERVAL=1500;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;"
318+
"connectionString": "DRIVER={MicroStrategy ODBC Driver for SQL Server Wire Protocol};DATABASE=tpch;HOSTNAME=10.27.69.102;KEEPALIVE=0;KEEPCONNECTIONACTIVE=0;LOADBALANCETIMEOUT=0;LOADBALANCING=0;LOGINTIMEOUT=15;MAXPOOLSIZE=100;MINPOOLSIZE=0;MULTISUBNETFAILOVER=0 - FALSE;PORTNUMBER=1433;PROXYMODE=0;QUERYTIMEOUT=0;REPORTCODEPAGECONVERSIONERRORS=0;SNAPSHOTSERIALIZABLE=0;SOCKETIDLETIMECHECKINTERVAL=1500;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;"
319319
```
320320

321321
Sample Request
@@ -346,7 +346,7 @@ Sample Response
346346
"charEncodingWindows": "multibyte",
347347
"charEncodingUnix": "utf8",
348348
"tablePrefix": "",
349-
"connectionString": "DRIVER={Strategy ODBC Driver for SQL Server Wire Protocol};DATABASE=tpch;HOSTNAME=10.27.69.102;KEEPALIVE=0;KEEPCONNECTIONACTIVE=0;LOADBALANCETIMEOUT=0;LOADBALANCING=0;LOGINTIMEOUT=15;MAXPOOLSIZE=100;MINPOOLSIZE=0;MULTISUBNETFAILOVER=0 - FALSE;PORTNUMBER=1433;PROXYMODE=0;QUERYTIMEOUT=0;REPORTCODEPAGECONVERSIONERRORS=0;SNAPSHOTSERIALIZABLE=0;SOCKETIDLETIMECHECKINTERVAL=1500;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;",
349+
"connectionString": "DRIVER={MicroStrategy ODBC Driver for SQL Server Wire Protocol};DATABASE=tpch;HOSTNAME=10.27.69.102;KEEPALIVE=0;KEEPCONNECTIONACTIVE=0;LOADBALANCETIMEOUT=0;LOADBALANCING=0;LOGINTIMEOUT=15;MAXPOOLSIZE=100;MINPOOLSIZE=0;MULTISUBNETFAILOVER=0 - FALSE;PORTNUMBER=1433;PROXYMODE=0;QUERYTIMEOUT=0;REPORTCODEPAGECONVERSIONERRORS=0;SNAPSHOTSERIALIZABLE=0;SOCKETIDLETIMECHECKINTERVAL=1500;VALIDATESERVERCERTIFICATE=1;XMLDESCRIBETYPE=-10;",
350350
"parameterizedQueries": true,
351351
"extendedFetch": false,
352352
"database": {

docs/common-workflows/administration/distribution-services/manage-subscriptions/create-and-get-a-subscription.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The authorization token "`x-mstr-authtoken`" is returned in the response header.
8888

8989
Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1)
9090

91-
This endpoint allows the caller to get the list of projects with the Strategy REST Server. In this example, you get the list of projects in the Strategy Tutorial metadata. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a list of the active projects that the user session has access to.
91+
This endpoint allows the caller to get the list of projects with the Strategy REST Server. In this example, you get the list of projects in the MicroStrategy Tutorial metadata. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a list of the active projects that the user session has access to.
9292

9393
Sample Request
9494

@@ -115,9 +115,9 @@ Sample Response
115115
[
116116
{
117117
"id": "B19DEDCC11D4E0EFC000EB9495D0F44F",
118-
"name": "Strategy Tutorial",
118+
"name": "MicroStrategy Tutorial",
119119
"alias": "",
120-
"description": "Strategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed.",
120+
"description": "MicroStrategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed.",
121121
"status": 0
122122
},
123123
{

docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-for-multi-content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Sample Response
147147
"name": "Shared Drive",
148148
"deliveryMode": "EMAIL",
149149
"deviceId": "18F9613B681E4E4FA671D1AED6B7B375",
150-
"value": "C:\\Program Files\\Strategy\\Analytics Modules",
150+
"value": "C:\\Program Files\\MicroStrategy\\Analytics Modules",
151151
"isDefault": true
152152
}
153153
]

docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-with-prompted-content.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The authorization token "`x-mstr-authtoken`" is returned in the response header.
8686

8787
Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1)
8888

89-
This endpoint allows the caller to get the list of projects with the Strategy REST Server. In this example, you get the list of projects in the Strategy Tutorial metadata. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a list of the active projects that the user session has access to.
89+
This endpoint allows the caller to get the list of projects with the Strategy REST Server. In this example, you get the list of projects in the MicroStrategy Tutorial metadata. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a list of the active projects that the user session has access to.
9090

9191
Sample Request
9292

@@ -113,9 +113,9 @@ Sample Response
113113
[
114114
{
115115
"id": "B19DEDCC11D4E0EFC000EB9495D0F44F",
116-
"name": "Strategy Tutorial",
116+
"name": "MicroStrategy Tutorial",
117117
"alias": "",
118-
"description": "Strategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed.",
118+
"description": "MicroStrategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed.",
119119
"status": 0
120120
},
121121
{
@@ -236,7 +236,7 @@ Sample Response
236236
"name": "Shared Drive",
237237
"deliveryMode": "EMAIL",
238238
"deviceId": "18F9613B681E4E4FA671D1AED6B7B375",
239-
"value": "C:\\Program Files\\Strategy\\Analytics Modules",
239+
"value": "C:\\Program Files\\MicroStrategy\\Analytics Modules",
240240
"isDefault": true
241241
}
242242
]

docs/common-workflows/administration/manage-drivers/retrieve-drivers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ You can get all the driver objects in the body of the response.
5757
"enabled": true,
5858
"id": "43A6758EF9CE9BBB12AD13C2636B162D",
5959
"isODBC": true,
60-
"name": "Strategy ODBC Driver for SQL Server Wire Protocol"
60+
"name": "MicroStrategy ODBC Driver for SQL Server Wire Protocol"
6161
}
6262
}
6363
}

docs/common-workflows/administration/manage-history-lists/get-history-list/get-history-list.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
7272
"status": "reserved",
7373
"sequenceNumber": 10,
7474
"parentId": "00000000000000000000000000000000",
75-
"clientType": "StrategyWeb",
75+
"clientType": "MicroStrategyWeb",
7676
"requestType": "document",
7777
"requestStatus": "job_running",
7878
"startTime": "2022-06-30T06:10:50Z",
@@ -88,7 +88,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
8888
"folderName": "HLCodeCoverage"
8989
},
9090
"projectId": "9DE876B611E7C33BF65B0080EF45D3E8",
91-
"projectName": "Strategy Tutorial",
91+
"projectName": "MicroStrategy Tutorial",
9292
"resultFlags": 0,
9393
"cacheId": null,
9494
"messageText": "User request is completed.",
@@ -108,7 +108,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
108108
"status": "new_message",
109109
"sequenceNumber": 11,
110110
"parentId": "0A6B683C4AF5FECC365F4CA18C11710A",
111-
"clientType": "StrategyWeb",
111+
"clientType": "MicroStrategyWeb",
112112
"requestType": "report",
113113
"requestStatus": 1,
114114
"startTime": "2022-06-30T06:10:51Z",
@@ -123,7 +123,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
123123
"folderId": "D6253070472AA691A4E9C88E72B7AC64",
124124
"folderName": "HLCodeCoverage"
125125
},
126-
"projectName": "Strategy Tutorial",
126+
"projectName": "MicroStrategy Tutorial",
127127
"resultFlags": "dtls_expr_nothing",
128128
"messageText": "User request is completed.",
129129
"displayName": "1.NormalReport",
@@ -143,7 +143,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
143143
"status": "new_message",
144144
"sequenceNumber": 9,
145145
"parentId": "00000000000000000000000000000000",
146-
"clientType": "StrategyWeb",
146+
"clientType": "MicroStrategyWeb",
147147
"requestType": "report",
148148
"requestStatus": "loading_prompt",
149149
"startTime": "2022-07-30T06:10:51Z",
@@ -159,7 +159,7 @@ If successful, this API call returns a `200 OK` status code and the list of docu
159159
"folderName": "_Chun"
160160
},
161161
"projectId": "9DE876B611E7C33BF65B0080EF45D3E8",
162-
"projectName": "Strategy Tutorial",
162+
"projectName": "MicroStrategy Tutorial",
163163
"resultFlags": "dtls_expr_nothing",
164164
"messageText": "User request is completed.",
165165
"displayName": "3Ms",

docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-a-migration-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This workflow sample demonstrates how to create a migration package using REST A
2424

2525
## Creating a project package
2626

27-
In this workflow sample, you want to create a project package that contains a `"Year"` object with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4` and all its dependents in the Strategy Tutorial project. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. Use `"replace"` as a conflict rule for all these objects.
27+
In this workflow sample, you want to create a project package that contains a `"Year"` object with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4` and all its dependents in the MicroStrategy Tutorial project. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. Use `"replace"` as a conflict rule for all these objects.
2828

2929
:::info
3030

docs/common-workflows/administration/migrations/create-and-import-migration-packages/import-a-migration-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This workflow sample demonstrates how to import a migration package using REST A
2727

2828
## Import a project package
2929

30-
You want to import a project package that contains a `"Year"` object, with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4`, and all its dependents in the Strategy Tutorial project. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. You are using the `"Demo Project"`, which has a project ID of `B19DEDCC11D4E0EFC000EB9495D0F44F`.
30+
You want to import a project package that contains a `"Year"` object, with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4`, and all its dependents in the MicroStrategy Tutorial project. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. You are using the `"Demo Project"`, which has a project ID of `B19DEDCC11D4E0EFC000EB9495D0F44F`.
3131

3232
:::info
3333

docs/common-workflows/administration/migrations/create-and-import-migration-packages/view-newly-created-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This workflow sample demonstrates how to view a newly created migration package
1515
1. [Download the package and save it as a binary file](#download-the-package-and-save-it-as-a-binary-file)
1616
1. [Delete the package](#delete-the-package)
1717

18-
In this workflow sample, you want to create a project package that contains a `"Year"` object with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4` and all its dependents in the Strategy Tutorial project. You also want to view the detailed definition of the `"Year"` object. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. Use `"replace"` as a conflict rule for all these objects.
18+
In this workflow sample, you want to create a project package that contains a `"Year"` object with an attribute object ID of `8D679D5111D3E4981000E787EC6DE8A4` and all its dependents in the MicroStrategy Tutorial project. You also want to view the detailed definition of the `"Year"` object. The project ID is `B7CA92F04B9FAE8D941C3E9B7E0CD754`. Use `"replace"` as a conflict rule for all these objects.
1919

2020
:::info
2121

0 commit comments

Comments
 (0)