diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4ff2fe4c..f7162a727 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ - [Open a pull request](#open-a-pull-request) - [Submit your PR & get it reviewed](#submit-your-pr--get-it-reviewed) - [Your PR is merged](#your-pr-is-merged) - - [Keep contributing as you use MicroStrategy Docs](#keep-contributing-as-you-use-microstrategy-docs) + - [Keep contributing as you use Strategy Docs](#keep-contributing-as-you-use-strategy-docs) ## Getting started @@ -44,7 +44,7 @@ Fork using GitHub Desktop: ### Make your update -Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-microstrategyrest-api-docs-repository). +Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-strategyrest-api-docs-repository). - Are you making changes to the application code? You'll need **Node.js v16** to run the site locally. See [contributing/development.md](contributing/development.md). - Are you contributing to markdown? We use [Markdown](https://www.markdownguide.org/basic-syntax/). @@ -60,13 +60,13 @@ When you're done making changes and you'd like to propose them for review, use t ### Your PR is merged -Congratulations! The whole MicroStrategy community thanks you. :sparkles: +Congratulations! The whole Strategy community thanks you. :sparkles: Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/MicroStrategy/rest-api-docs/graphs/contributors) and at the bottom of the page you contributed to. -### Keep contributing as you use MicroStrategy Docs +### Keep contributing as you use Strategy Docs -Now that you're a part of the MicroStrategy Docs community, you can keep participating in many ways. +Now that you're a part of the Strategy Docs community, you can keep participating in many ways. **Learn more about contributing:** @@ -77,7 +77,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici - [:earth_asia: Translations](#earth_asia-translations) - [Starting with an issue](#starting-with-an-issue) - [Opening a pull request](#opening-a-pull-request) -- [Working in the MicroStrategy/rest-api-docs repository](#working-in-the-microstrategyrest-api-docs-repository) +- [Working in the Strategy/rest-api-docs repository](#working-in-the-strategyrest-api-docs-repository) - [Reviewing](#reviewing) - [Self review](#self-review) - [Test it locally](#test-it-locally) @@ -87,7 +87,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici ## :memo: Types of contributions -You can contribute to the REST API Docs content and site in several ways. This repo is a place to discuss and collaborate on MicroStrategy REST API Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed. +You can contribute to the REST API Docs content and site in several ways. This repo is a place to discuss and collaborate on Strategy REST API Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed. ### :beetle: Issues @@ -101,7 +101,7 @@ When we merge those changes, they should be deployed to the live site within 24 ### :question: Support -We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with MicroStrategy, unrelated to our documentation, please [contact MicroStrategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact MicroStrategy Support, then closed and locked. +We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with Strategy, unrelated to our documentation, please [contact Strategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact Strategy Support, then closed and locked. ### :earth_asia: Translations @@ -117,7 +117,7 @@ You can browse existing issues to find something that needs help! You can use the GitHub user interface :pencil2: for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine. -## Working in the MicroStrategy/rest-api-docs repository +## Working in the Strategy/rest-api-docs repository Here's some information that might be helpful while working on a Docs PR: @@ -126,7 +126,7 @@ Here's some information that might be helpful while working on a Docs PR: ## Reviewing -We (usually the docs team, but sometimes MicroStrategy product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use MicroStrategy. +We (usually the docs team, but sometimes product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use Strategy. :yellow_heart: Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time. diff --git a/README.md b/README.md index 978e0655a..1d0ce72e8 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ pull request. For more details about this process, please check out #### And that's it -That's how you can get started easily as a member of the MicroStrategy Embedding SDK Documentation +That's how you can get started easily as a member of the Strategy Embedding SDK Documentation community. :sparkles: If you want to know more, or you're making a more complex contribution, check out diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 48bb9197d..ebad5abc5 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -135,7 +135,7 @@ The list below shows the usage of emojis in our Docs site: - Titles, sidebar labels, and headers - - These should use **sentence case**. For example, prefer "This is the title from MicroStrategy" over "This Is The Title From MicroStrategy". + - These should use **sentence case**. For example, prefer "This is the title from Strategy" over "This Is The Title From Strategy". - `sidebar_label` should only be used if you want a different title in the sidebar than the `title` in front matter. (Note: For folders, `label` in sidebars.js takes priority over `sidebar_label`) ## Tables @@ -209,7 +209,7 @@ For the root of a collection of workflows, please use the template below: You can try these workflows with [REST API Playground](). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: ``` @@ -221,7 +221,7 @@ For the workflow page, please use the template below: You can try out this workflow at [REST API Playground](). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: ``` diff --git a/docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md b/docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md index 7c6a133e7..5c4de973f 100644 --- a/docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md +++ b/docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md @@ -14,7 +14,7 @@ A detailed description of each step of this request is listed down below. For th Endpoint: [GET /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getProjectDatasources) -This endpoint allows the caller to get the datasources associated with a specific project with the MicroStrategy REST Server. 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 the datasources for a project. +This endpoint allows the caller to get the datasources associated with a specific project with the Strategy REST Server. 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 the datasources for a project. Sample Request @@ -114,13 +114,13 @@ Sample Response You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2d0b3eac-9704-42a7-9481-fec12557b752?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources) -This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy 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. +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. Sample Request @@ -242,13 +242,13 @@ Sample Response Code: 200 (Add datasource to project.) You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-577baae8-f1b6-4ed2-8819-bc3aed5ec5c7?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources) -This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy 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. +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. Sample Request diff --git a/docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md b/docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md index 818439a24..4737913b4 100644 --- a/docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md +++ b/docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to convert connection string You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-737e03ad-a41a-46d5-bf7a-00e68963b08b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/datasource-management.md b/docs/common-workflows/administration/datasource-management/datasource-management.md index 3aaf68dca..1ed91b91c 100644 --- a/docs/common-workflows/administration/datasource-management/datasource-management.md +++ b/docs/common-workflows/administration/datasource-management/datasource-management.md @@ -7,7 +7,7 @@ description: You can use REST API requests to manage datasources. You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-fe63e329-ca17-40e6-9263-8f451b95e06e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/delete-a-datasource.md b/docs/common-workflows/administration/datasource-management/delete-a-datasource.md index 977584933..111d431ae 100644 --- a/docs/common-workflows/administration/datasource-management/delete-a-datasource.md +++ b/docs/common-workflows/administration/datasource-management/delete-a-datasource.md @@ -13,7 +13,7 @@ The workflow for deleting and cleaning up a datasource includes the following se You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2da893be-a6e9-449a-95ae-749b5906bb27?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/get-datasource-applicable-advanced-properties.md b/docs/common-workflows/administration/datasource-management/get-datasource-applicable-advanced-properties.md index c26b305f2..71cd7906a 100644 --- a/docs/common-workflows/administration/datasource-management/get-datasource-applicable-advanced-properties.md +++ b/docs/common-workflows/administration/datasource-management/get-datasource-applicable-advanced-properties.md @@ -10,7 +10,7 @@ description: Get applicable properties for a datasource. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-585d42d1-fbdc-4d1d-afbb-c4e872753709?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/get-datasource-with-advanced-properties.md b/docs/common-workflows/administration/datasource-management/get-datasource-with-advanced-properties.md index 913ba4c15..ffb415774 100644 --- a/docs/common-workflows/administration/datasource-management/get-datasource-with-advanced-properties.md +++ b/docs/common-workflows/administration/datasource-management/get-datasource-with-advanced-properties.md @@ -9,7 +9,7 @@ description: The workflow involves getting datasource definition along with its You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c8ec1165-e5d3-4b9a-bc68-df3d71d493f7?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/update-a-datasource.md b/docs/common-workflows/administration/datasource-management/update-a-datasource.md index e9dde0ebf..bab29a98b 100644 --- a/docs/common-workflows/administration/datasource-management/update-a-datasource.md +++ b/docs/common-workflows/administration/datasource-management/update-a-datasource.md @@ -15,7 +15,7 @@ A detailed description of each step of this request is listed down below. Endpoint: [PATCH /api/datasources/\{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasource) -This endpoint allows the caller to update a database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a info for the updated database source. +This endpoint allows the caller to update a database source with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a info for the updated database source. Sample Request @@ -100,7 +100,7 @@ Sample Response Endpoint: [PATCH /api/datasources/connections/\{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceConnection) -This endpoint allows the caller to update a datasource connection with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the connectionId using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource connection. +This endpoint allows the caller to update a datasource connection with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the connectionId using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource connection. Sample Request @@ -183,7 +183,7 @@ Sample Response Endpoint: [PATCH /api/datasources/logins/\{loginId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceLogin) -This endpoint allows the caller to update a datasource login with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the loginId using the endpoint `GET /api/datasources/logins`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource login. +This endpoint allows the caller to update a datasource login with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the loginId using the endpoint `GET /api/datasources/logins`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource login. Sample Request diff --git a/docs/common-workflows/administration/datasource-management/update-datasource-advanced-property.md b/docs/common-workflows/administration/datasource-management/update-datasource-advanced-property.md index 3b6342b76..19035aeec 100644 --- a/docs/common-workflows/administration/datasource-management/update-datasource-advanced-property.md +++ b/docs/common-workflows/administration/datasource-management/update-datasource-advanced-property.md @@ -9,7 +9,7 @@ description: The workflow involves modifying datasource's advanced properties va You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-689ad52e-2dee-4582-92a1-679dc0fda692?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/datasource-management/update-job-priorities-for-datasource.md b/docs/common-workflows/administration/datasource-management/update-job-priorities-for-datasource.md index 8a84cdd63..e7da69462 100644 --- a/docs/common-workflows/administration/datasource-management/update-job-priorities-for-datasource.md +++ b/docs/common-workflows/administration/datasource-management/update-job-priorities-for-datasource.md @@ -14,7 +14,7 @@ A detailed description of each step of this request is listed down below. Endpoint: [GET /api/datasources/\{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getJobPrioritization) -This endpoint allows the caller to get job prioritization info for a specific database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info regarding the job priorities for the datasource. +This endpoint allows the caller to get job prioritization info for a specific database source with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info regarding the job priorities for the datasource. Sample Request @@ -99,7 +99,7 @@ Sample Response Endpoint: [PATCH /api/datasources/\{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateJobPrioritization) -This endpoint allows the caller to update job prioritization info for a specific database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a empty response body. +This endpoint allows the caller to update job prioritization info for a specific database source with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a empty response body. Sample Request diff --git a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-and-get-a-subscription.md b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-and-get-a-subscription.md index 502c6bee0..c7e752f8a 100644 --- a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-and-get-a-subscription.md +++ b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-and-get-a-subscription.md @@ -7,7 +7,7 @@ description: This workflow sample demonstrates how to retrieve a subscription, a 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). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -32,7 +32,7 @@ A detailed description of each step of this workflow is listed down below. Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. Sample Request @@ -88,7 +88,7 @@ The authorization token "`x-mstr-authtoken`" is returned in the response header. Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1) -This endpoint allows the caller to get the list of projects with the MicroStrategy 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. +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. Sample Request diff --git a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-for-multi-content.md b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-for-multi-content.md index 1722fe212..f637001df 100644 --- a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-for-multi-content.md +++ b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-for-multi-content.md @@ -7,7 +7,7 @@ description: This workflow sample demonstrates how to create email subscriptions You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b83f6f30-6232-4e88-9d90-aee4837da5e7?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -18,7 +18,7 @@ This workflow sample demonstrates how to create email subscriptions with multipl 1. [Create multi-content subscription.](#create-a-multi-content-subscription) 1. [Delete subscription.](#delete-the-subscription) -A detailed description of the critical steps in this workflow are listed down below. For a full list of API calls in the workflow, you can look at the workflow in the MicroStrategy POSTMAN collection. +A detailed description of the critical steps in this workflow are listed down below. For a full list of API calls in the workflow, you can look at the workflow in the Strategy POSTMAN collection. ## Get a list of available schedules diff --git a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-with-prompted-content.md b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-with-prompted-content.md index f580739bb..514f9faa6 100644 --- a/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-with-prompted-content.md +++ b/docs/common-workflows/administration/distribution-services/manage-subscriptions/create-subscription-with-prompted-content.md @@ -7,7 +7,7 @@ description: This workflow sample demonstrates how to create a prompted subscrip You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-4fce986e-f37b-4fb8-94ff-b0978d1ef849?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -30,7 +30,7 @@ A detailed description of each step of this workflow is listed down below. Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. Sample Request @@ -86,7 +86,7 @@ The authorization token "`x-mstr-authtoken`" is returned in the response header. Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1) -This endpoint allows the caller to get the list of projects with the MicroStrategy 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. +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. Sample Request diff --git a/docs/common-workflows/administration/distribution-services/manage-subscriptions/manage-subscriptions.md b/docs/common-workflows/administration/distribution-services/manage-subscriptions/manage-subscriptions.md index 4c85d3adc..94d144d57 100644 --- a/docs/common-workflows/administration/distribution-services/manage-subscriptions/manage-subscriptions.md +++ b/docs/common-workflows/administration/distribution-services/manage-subscriptions/manage-subscriptions.md @@ -7,7 +7,7 @@ description: You can use REST API requests to retrieve and create different type You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-73ce0581-5c01-4d8f-8e4b-a1c53c6e59b1?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md b/docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md index 793b6ba79..007909384 100644 --- a/docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md +++ b/docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md @@ -14,7 +14,7 @@ This workflow sample demonstrates how to create and update a mobile subscription 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). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/manage-application-objects/manage-application-general-settings.md b/docs/common-workflows/administration/manage-application-objects/manage-application-general-settings.md index b4c3b8893..e29187231 100644 --- a/docs/common-workflows/administration/manage-application-objects/manage-application-general-settings.md +++ b/docs/common-workflows/administration/manage-application-objects/manage-application-general-settings.md @@ -891,7 +891,7 @@ Sample Response Body: "showMobileButton": true, "showReminder": true, "showSentBy": true, - "sentByText": "MicroStrategy Inc.", + "sentByText": "Strategy Inc.", "showSocialMedia": true } } diff --git a/docs/common-workflows/administration/manage-bookmarks/manage-bookmarks.md b/docs/common-workflows/administration/manage-bookmarks/manage-bookmarks.md index 0418b3a4e..9a958629c 100644 --- a/docs/common-workflows/administration/manage-bookmarks/manage-bookmarks.md +++ b/docs/common-workflows/administration/manage-bookmarks/manage-bookmarks.md @@ -1,6 +1,6 @@ --- title: Manage Bookmarks -Description: Manage bookmarks using the MicroStrategy REST API. +Description: Manage bookmarks using the Strategy REST API. --- You can use REST API requests to manage bookmarks: diff --git a/docs/common-workflows/administration/manage-history-lists/get-history-list/get-history-list.md b/docs/common-workflows/administration/manage-history-lists/get-history-list/get-history-list.md index 05185fde6..1d5ca4789 100644 --- a/docs/common-workflows/administration/manage-history-lists/get-history-list/get-history-list.md +++ b/docs/common-workflows/administration/manage-history-lists/get-history-list/get-history-list.md @@ -1,11 +1,11 @@ --- title: Retrieve history lists -Description: Retrieve history lists using the MicroStrategy REST API. +Description: Retrieve history lists using the Strategy REST API. --- -This workflow sample demonstrates how to retrieve messages from the history list using the MicroStrategy REST API. +This workflow sample demonstrates how to retrieve messages from the history list using the Strategy REST API. :::info diff --git a/docs/common-workflows/administration/manage-history-lists/manage-history-lists.md b/docs/common-workflows/administration/manage-history-lists/manage-history-lists.md index 2e7477b4e..ccb94d1ac 100644 --- a/docs/common-workflows/administration/manage-history-lists/manage-history-lists.md +++ b/docs/common-workflows/administration/manage-history-lists/manage-history-lists.md @@ -1,6 +1,6 @@ --- title: Manage History Lists -Description: Manage History Lists using the MicroStrategy REST API. +Description: Manage History Lists using the Strategy REST API. --- diff --git a/docs/common-workflows/administration/manage-licensing/license-audit-compliance.md b/docs/common-workflows/administration/manage-licensing/license-audit-compliance.md index 93473bb8e..f4da43b52 100644 --- a/docs/common-workflows/administration/manage-licensing/license-audit-compliance.md +++ b/docs/common-workflows/administration/manage-licensing/license-audit-compliance.md @@ -267,7 +267,7 @@ Sample Response Body: "privilege": { "id": "266", "name": "Use Application", - "description": "Provide the ability for organizations to connect to the MicroStrategy Intelligence Server through custom applications.", + "description": "Provide the ability for organizations to connect to the Intelligence Server through custom applications.", "level": "project" }, "sources": [ diff --git a/docs/common-workflows/administration/manage-licensing/license-manipulation.md b/docs/common-workflows/administration/manage-licensing/license-manipulation.md index 697155ecc..e61c88ecb 100644 --- a/docs/common-workflows/administration/manage-licensing/license-manipulation.md +++ b/docs/common-workflows/administration/manage-licensing/license-manipulation.md @@ -264,7 +264,7 @@ Sample request body "installationUse": "production", "contact": { "customer": { - "company": "MicroStrategy", + "company": "Strategy", "department": "TEC", "firstName": "John", "lastName": "Doe", @@ -279,7 +279,7 @@ Sample request body "usePersonalInfo": true }, "installer": { - "company": "NotMicroStrategy", + "company": "NotStrategy", "department": "NotTEC", "firstName": "John", "lastName": "Doe", @@ -316,7 +316,7 @@ curl --location --request PATCH 'https://demo.microstrategy.com/MicroStrategyLib "installationUse": "production", "contact": { "customer": { - "company": "MicroStrategy", + "company": "Strategy", "department": "TEC", "firstName": "John", "lastName": "Doe", @@ -331,7 +331,7 @@ curl --location --request PATCH 'https://demo.microstrategy.com/MicroStrategyLib "usePersonalInfo": true }, "installer": { - "company": "NotMicroStrategy", + "company": "NotStrategy", "department": "NotTEC", "firstName": "John", "lastName": "Doe", @@ -421,24 +421,24 @@ Sample Response Body: 9\n \n \n - MicroStrategy Intelligence Server Universal\n + Strategy Intelligence Server Universal\n Unknown\n 2\n \n \n - MicroStrategy OLAP Services Universal\n + Strategy OLAP Services Universal\n 1.1.111.111\n \n \n - MicroStrategy Transaction Services Universal\n + Strategy Transaction Services Universal\n 1.1.111.111\n \n \n - MicroStrategy Report Services Universal\n + Strategy Report Services Universal\n 1.1.111.111\n \n \n - MicroStrategy Distribution Services\n + Strategy Distribution Services\n 1.1.111.111\n \n \n @@ -484,7 +484,7 @@ Sample Response Body: Doe\n johndoe@microstrategy.com\n 9998889999\n -NotMicroStrategy\n +NotStrategy\n NotTEC\n Not Software Engineer\n 1851 Towers Crescent Plaza\n diff --git a/docs/common-workflows/administration/manage-runtime-objects/retrieve-all-runtimes.md b/docs/common-workflows/administration/manage-runtime-objects/retrieve-all-runtimes.md index 9ff2db03d..54910f3bb 100644 --- a/docs/common-workflows/administration/manage-runtime-objects/retrieve-all-runtimes.md +++ b/docs/common-workflows/administration/manage-runtime-objects/retrieve-all-runtimes.md @@ -44,7 +44,7 @@ You can get al the runtime objects in the body of the response. { "runtimes": [ { - "name": "(Default) MicroStrategy", + "name": "(Default) Strategy", "id": "0F35652CA7D041978BF0CBCB67531203", "type": 80, "description": "A default server configuration used to execute Python scripts on IServer. It includes the latest versions of both Python and mstrio packages, as well as a default network access configuration. Allows for network access customization.", diff --git a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-a-migration-package.md b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-a-migration-package.md index 9633dae81..92ef8a050 100644 --- a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-a-migration-package.md +++ b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-a-migration-package.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a migration package You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c4f8860a-cb20-4e14-a7c8-16d450c167c5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-and-import-migration-packages.md b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-and-import-migration-packages.md index c1e097fff..cca828db2 100644 --- a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-and-import-migration-packages.md +++ b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/create-and-import-migration-packages.md @@ -9,7 +9,7 @@ description: You can use REST API requests to create and import migration packag You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-e4a2caff-1aef-4724-be48-4635fff1133f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/import-a-migration-package.md b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/import-a-migration-package.md index edfb78f88..d2a50e706 100644 --- a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/import-a-migration-package.md +++ b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/import-a-migration-package.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to import a migration package You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7a6ff268-6e87-449b-a51f-30f134ab54d4?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md index 22f5460a1..8adbc708a 100644 --- a/docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md +++ b/docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md @@ -14,7 +14,7 @@ Create a content group package using REST APIs: 1. In the source metadata, create a configuration package where the input is the content group object. This package includes the content group object and recipient list. 1. In the source metadata, create a project package, where the input is the content group object, for each project. This project package includes the configuration content bundle object as well as its contents (dashboards, documents, and reports that are included in the content group in this project). 1. In the destination metadata, first import the configuration package and then the project package, one by one. -1. In MicroStrategy Workstation, enable the content bundle feature. If the user in the destination metadata has the same GUID with the source metadata, then the recipient (user or user group) link will migrate over. However, if the user has the same name with a different GUID, then the recipient link will not migrate anymore. +1. In Workstation, enable the content bundle feature. If the user in the destination metadata has the same GUID with the source metadata, then the recipient (user or user group) link will migrate over. However, if the user has the same name with a different GUID, then the recipient link will not migrate anymore. ## Object package requirements diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/edit-migrations-and-migration-groups.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/edit-migrations-and-migration-groups.md index 705001cda..11d60afa8 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/edit-migrations-and-migration-groups.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/edit-migrations-and-migration-groups.md @@ -1134,7 +1134,7 @@ When the API call is successful, it returns response code `204` with no response ## Performance -To improve performance, MicroStrategy suggests you edit one migration or migration group per session and time. +To improve performance, Strategy suggests you edit one migration or migration group per session and time. ## Compatibility @@ -1150,7 +1150,7 @@ A migration or migration group created in an earlier platform version can be edi ## Troubleshooting - If the Library server cannot connect to the database, you may receive the following error: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database is not running - Database version is lower than required diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md index 5c99a97dc..f169388ea 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md @@ -1,11 +1,11 @@ --- title: Migrations in Workstation -description: You can use REST API requests to create and import migration packages just as the Workstations does. This way all packages are managed by the MicroStrategy Storage Service and the migration processes can be monitored in Workstation. +description: You can use REST API requests to create and import migration packages just as the Workstations does. This way all packages are managed by the Storage Service and the migration processes can be monitored in Workstation. --- -You can use REST API requests to create and import migration packages just as the Workstations does. This way all packages are managed by the [MicroStrategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm) and the migration processes can be monitored in Workstation. +You can use REST API requests to create and import migration packages just as the Workstations does. This way all packages are managed by the [Strategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm) and the migration processes can be monitored in Workstation. - [Object migration between environments](object-migration-between-environments.md) - [Project merge between environments](project-merge-between-environments.md) diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-between-environments.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-between-environments.md index 4aefe3ceb..663636ad9 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-between-environments.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-between-environments.md @@ -5,7 +5,7 @@ description: You can move packages of objects between environments within Workst -Starting in MicroStrategy 2021 Update 6, you can move packages of objects between environments within Workstation. These packages are all maintained by the [MicroStrategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), instead of you having to manage the packages yourself. +Starting in MicroStrategy 2021 Update 6, you can move packages of objects between environments within Workstation. These packages are all maintained by the [Strategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), instead of you having to manage the packages yourself. You must [configure the package storage location in Workstation](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service_config_workstation.htm) to use this feature. @@ -545,7 +545,7 @@ Sample Request Header ## Performance -For performance concerns, MicroStrategy suggests you create or import one package per session and time. +For performance concerns, Strategy suggests you create or import one package per session and time. ## Compatibility @@ -586,7 +586,7 @@ A package created in an earlier platform version can be imported to a newer plat ## Troubleshooting - If the Library Server cannot connect to the database, you may receive the following error response: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database not running - Database version is lower than required diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-groups-between-environments.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-groups-between-environments.md index c1bb1125d..8c056b8f8 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-groups-between-environments.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/object-migration-groups-between-environments.md @@ -5,7 +5,7 @@ description: You can move a group of object packages between environments within -Starting in MicroStrategy 2021 Update 7, you can move a group of object packages between environments within Workstation. These groups of packages are all maintained by the [MicroStrategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), instead of you having to manage the packages yourself. +Starting in MicroStrategy 2021 Update 7, you can move a group of object packages between environments within Workstation. These groups of packages are all maintained by the [Strategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), instead of you having to manage the packages yourself. You must [configure the package storage location in Workstation](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service_config_workstation.htm) to use this feature. @@ -1267,7 +1267,7 @@ Sample Request Header ## Performance -For performance concerns, MicroStrategy suggests you create or import one package group per session and time. +For performance concerns, Strategy suggests you create or import one package group per session and time. ## Compatibility @@ -1312,7 +1312,7 @@ A package group created in an earlier platform version can be imported to a newe ## Troubleshooting - If the Library Server cannot connect to the database, you may receive the following error response: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database not running - Database version is lower than required diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/project-merge-between-environments.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/project-merge-between-environments.md index fc9054d15..c059cc203 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/project-merge-between-environments.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/project-merge-between-environments.md @@ -749,7 +749,7 @@ Sample Request Header: ## Performance -For performance concerns, MicroStrategy suggests you create or import one package per session and time. +For performance concerns, Strategy suggests you create or import one package per session and time. ## Compatibility @@ -776,7 +776,7 @@ A package created in an earlier platform version can be imported to a newer plat ## Troubleshooting - If the Library Server cannot connect to the database, you may receive the following error response: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database not running - Database version is lower than required diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/upload-and-download-migration-packages.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/upload-and-download-migration-packages.md index 40fd3dd7f..2909671b2 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/upload-and-download-migration-packages.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/upload-and-download-migration-packages.md @@ -5,7 +5,7 @@ description: You can upload and download migration packages in Workstation. -Starting in MicroStrategy 2021 Update 7, you can upload and download migration packages in Workstation. These packages are all maintained by the [MicroStrategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), users can download these packages from one storage service and then upload to another the storage service. +Starting in MicroStrategy 2021 Update 7, you can upload and download migration packages in Workstation. These packages are all maintained by the [Strategy Storage Service](https://www2.microstrategy.com/producthelp/Current/Workstation/WebHelp/Lang_1033/Content/storage_service.htm), users can download these packages from one storage service and then upload to another the storage service. This feature is usually used in the following two scenarios: @@ -353,7 +353,7 @@ A package created in an earlier platform version can be downloaded, uploaded and ## Troubleshooting - If the Library Server cannot connect to the database, you may receive the following error responses: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database version is lower than required - Database configuration is missing or invalid in `configOverride.properties` file diff --git a/docs/common-workflows/administration/migrations/migrations-in-workstation/validate-migrations.md b/docs/common-workflows/administration/migrations/migrations-in-workstation/validate-migrations.md index 65447a34c..d641150ec 100644 --- a/docs/common-workflows/administration/migrations/migrations-in-workstation/validate-migrations.md +++ b/docs/common-workflows/administration/migrations/migrations-in-workstation/validate-migrations.md @@ -352,7 +352,7 @@ Sample Response Body: ## Performance -For performance concerns, MicroStrategy suggests you validate one package per session and time. +For performance concerns, Strategy suggests you validate one package per session and time. ## Compatibility @@ -368,7 +368,7 @@ A package validated in an earlier platform version can be validated to a newer p ## Troubleshooting - If the Library Server cannot connect to the database, you may receive the following error response: - - The API requires MicroStrategy Storage Service. Please contact your administrator. + - The API requires Storage Service. Please contact your administrator. - This can occur due to the following reasons: - Database not running - Database version is lower than required @@ -381,6 +381,6 @@ A package validated in an earlier platform version can be validated to a newer p - Cannot create or modify the shared file. It may be temporarily unavailable for accessing the storage location. - The shared file cannot be accessed. It may be deleted or the storage location cannot be accessed. -- MicroStrategy advises setting the **Maximum tolerance for computer clock synchronization** to a value of five minutes. See [Maximum tolerance for computer clock synchronization](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/maximum-tolerance-for-computer-clock-synchronization) on the [Microsoft technical documentation](https://docs.microsoft.com/en-us/) site for more information about modifying this setting. After making this change, if your environment times differ by more than five minutes, you receive the following message: +- Strategy advises setting the **Maximum tolerance for computer clock synchronization** to a value of five minutes. See [Maximum tolerance for computer clock synchronization](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/maximum-tolerance-for-computer-clock-synchronization) on the [Microsoft technical documentation](https://docs.microsoft.com/en-us/) site for more information about modifying this setting. After making this change, if your environment times differ by more than five minutes, you receive the following message: The time difference between the source and target environments should be five minutes or less. Please modify the environment system time and try again. diff --git a/docs/common-workflows/administration/monitors/manage-an-intelligence-server-cluster.md b/docs/common-workflows/administration/monitors/manage-an-intelligence-server-cluster.md index 54c1f9c41..7a084f5b4 100644 --- a/docs/common-workflows/administration/monitors/manage-an-intelligence-server-cluster.md +++ b/docs/common-workflows/administration/monitors/manage-an-intelligence-server-cluster.md @@ -7,11 +7,11 @@ description: Intelligence Server provides you the functionality to cluster a gro You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7f67e2a1-9eb5-45b1-8e4c-4fcec18a998a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -Intelligence Server provides you the functionality to cluster a group of Intelligence Server machines to take advantage of the many benefits available in a clustered environment. MicroStrategy REST exposes a set of APIs for viewing and editing members of connected Intelligence Server cluster: +Intelligence Server provides you the functionality to cluster a group of Intelligence Server machines to take advantage of the many benefits available in a clustered environment. Strategy REST exposes a set of APIs for viewing and editing members of connected Intelligence Server cluster: - View member nodes and projects of the connected cluster - Adding a node to the connected cluster diff --git a/docs/common-workflows/administration/monitors/manage-caches.md b/docs/common-workflows/administration/monitors/manage-caches.md index 29464b708..8e840d984 100644 --- a/docs/common-workflows/administration/monitors/manage-caches.md +++ b/docs/common-workflows/administration/monitors/manage-caches.md @@ -10,11 +10,11 @@ sidebar_label: Purge object and element caches You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7238f434-a209-45b1-a227-cba9887c20b4?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -When a user works with MicroStrategy, cache data is created. The data stored in the cache allows to increase system performance and improve user’s experience. Instead of loading the data required by system from some database, i.e., meta-data database, the data is retrieved from a cache memory. However, Platform Administrator or Analytics Architect may decide to purge the caches periodically. Currently, the REST API allows to delete cache data for objects and elements using a following endpoint: +When a user works with Strategy, cache data is created. The data stored in the cache allows to increase system performance and improve user’s experience. Instead of loading the data required by system from some database, i.e., meta-data database, the data is retrieved from a cache memory. However, Platform Administrator or Analytics Architect may decide to purge the caches periodically. Currently, the REST API allows to delete cache data for objects and elements using a following endpoint: - `DELETE /api/monitors/projects/{projectId}/cache/{cacheType}` @@ -31,7 +31,7 @@ The sections below present Cache Management REST API usage. ### Header - `X-MSTR-AuthToken` - - (Required) MicroStrategy authorization token. + - (Required) authorization token. - Data Type: `string` - Allowable Values: valid authorization token. diff --git a/docs/common-workflows/administration/monitors/monitor-and-manage-cube-caches.md b/docs/common-workflows/administration/monitors/monitor-and-manage-cube-caches.md index be652918f..c8f8ae5b9 100644 --- a/docs/common-workflows/administration/monitors/monitor-and-manage-cube-caches.md +++ b/docs/common-workflows/administration/monitors/monitor-and-manage-cube-caches.md @@ -10,7 +10,7 @@ description: The status of a cube tells you how the cube is currently being used You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-736d23cb-1247-49fc-99dc-83365a1502e6?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/monitors/project-administration.md b/docs/common-workflows/administration/monitors/project-administration.md index b910b5220..deb4bb882 100644 --- a/docs/common-workflows/administration/monitors/project-administration.md +++ b/docs/common-workflows/administration/monitors/project-administration.md @@ -7,7 +7,7 @@ description: The workflow below allows an administrator to manage project distri You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b8adf359-7841-499a-8197-bcbe15c06add?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -23,7 +23,7 @@ The following sequence of REST API requests allows an administrator to manage pr Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. Provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used by subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. Provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used by subsequent requests. ### Sample request @@ -335,7 +335,7 @@ The project status can be changed using the `PATCH /api/monitors/iServer/nodes/{ Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated by `POST /api/auth/login`. If the call is successful, the resulting response returns the status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated by `POST /api/auth/login`. If the call is successful, the resulting response returns the status code 204. - Curl: diff --git a/docs/common-workflows/administration/server-management/manage-fences/create-fence.md b/docs/common-workflows/administration/server-management/manage-fences/create-fence.md index cda684dfe..a08838256 100644 --- a/docs/common-workflows/administration/server-management/manage-fences/create-fence.md +++ b/docs/common-workflows/administration/server-management/manage-fences/create-fence.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to create a new user or workl You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5aef5846-6a6a-4d65-a91d-b3ebf5d96520?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/manage-fences/delete-specific-fence.md b/docs/common-workflows/administration/server-management/manage-fences/delete-specific-fence.md index 18214f65b..cab25f730 100644 --- a/docs/common-workflows/administration/server-management/manage-fences/delete-specific-fence.md +++ b/docs/common-workflows/administration/server-management/manage-fences/delete-specific-fence.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to delete a specific user or You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-977138df-2f06-40ae-87f3-8af880b7a336?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/manage-fences/manage-fences.md b/docs/common-workflows/administration/server-management/manage-fences/manage-fences.md index eacf8d8b0..2c9a888fc 100644 --- a/docs/common-workflows/administration/server-management/manage-fences/manage-fences.md +++ b/docs/common-workflows/administration/server-management/manage-fences/manage-fences.md @@ -9,7 +9,7 @@ description: Within a cluster, fences allows an administrator or a user with Dss You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2564e447-4b77-42c9-99a4-97d7979b348c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -31,7 +31,7 @@ Manage User and Workload Fences REST APIs were released in 2021 Update 6 ::: -You can use REST API requests to retrieve, create, update, and delete the user and workload fences with [DssXmlPrivilegesConfigureServerBasic](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesConfigureServerBasic) and [DssXmlPrivilegesUseClusterMonitor](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseClusterMonitor) privileges across all nodes without restarting the clustered MicroStrategy Intelligence Servers. +You can use REST API requests to retrieve, create, update, and delete the user and workload fences with [DssXmlPrivilegesConfigureServerBasic](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesConfigureServerBasic) and [DssXmlPrivilegesUseClusterMonitor](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseClusterMonitor) privileges across all nodes without restarting the clustered Intelligence Servers. - [Create a new fence](create-fence.md) - [Retrieve the list of fences](retrieve-list-of-fences.md) diff --git a/docs/common-workflows/administration/server-management/manage-fences/update-specific-fence.md b/docs/common-workflows/administration/server-management/manage-fences/update-specific-fence.md index 668c845ea..ae29304d9 100644 --- a/docs/common-workflows/administration/server-management/manage-fences/update-specific-fence.md +++ b/docs/common-workflows/administration/server-management/manage-fences/update-specific-fence.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to update a specific fence. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2b48c198-0938-4578-ae8c-9ab957f046f2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/manage-languages.md b/docs/common-workflows/administration/server-management/manage-languages.md index bf1cb65bf..c43bd779c 100644 --- a/docs/common-workflows/administration/server-management/manage-languages.md +++ b/docs/common-workflows/administration/server-management/manage-languages.md @@ -9,7 +9,7 @@ description: This section covers creating, updating and deleting language object You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d97007d2-a5be-4748-913d-c243b1b21663?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/manage-quick-search-indices.md b/docs/common-workflows/administration/server-management/manage-quick-search-indices.md index dd343ddff..4274a0bc9 100644 --- a/docs/common-workflows/administration/server-management/manage-quick-search-indices.md +++ b/docs/common-workflows/administration/server-management/manage-quick-search-indices.md @@ -9,7 +9,7 @@ description: The Manage Quick Search Indices API family allows you to view the s You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-75d970f5-31b8-4fda-93cc-1aabe3f7441d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/manage-server-settings.md b/docs/common-workflows/administration/server-management/manage-server-settings.md index dbea0bc15..9a1389e54 100644 --- a/docs/common-workflows/administration/server-management/manage-server-settings.md +++ b/docs/common-workflows/administration/server-management/manage-server-settings.md @@ -9,7 +9,7 @@ description: A high-level workflow sample for managing server settings is shown You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-f79f1c3f-2313-4f26-8c5c-7b38a686c921?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -27,7 +27,7 @@ A detailed explanation of each step is provided below. Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the user to authenticate with the MicroStrategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username and password. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. +This endpoint allows the user to authenticate with the Strategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username and password. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. In the following example, standard authentication uses a username of administrator and a blank password. @@ -66,7 +66,7 @@ Response Code: 204 (Success: No Content) Endpoint: [GET /api/v2/iserver/settings/config](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration/getIserverSettingsProperties) -This endpoint allows the user to retrieve information on all Intelligence Server settings that are available in MicroStrategy REST API. The information includes the setting description, type, options, unit, minimum value, maximum value, and reboot rule. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows the user to retrieve information on all Intelligence Server settings that are available in Strategy REST API. The information includes the setting description, type, options, unit, minimum value, maximum value, and reboot rule. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). :::tip @@ -137,7 +137,7 @@ Response Code: 200 (Success: OK) Endpoint: [GET /api/v2/iserver/settings](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration/getIserverSettings) -This endpoint allows you to retrieve all Intelligence Server setting values that are available in MicroStrategy REST API. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows you to retrieve all Intelligence Server setting values that are available in Strategy REST API. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). ### Sample request @@ -255,7 +255,7 @@ Response Code: 200 (Success: OK) Endpoint: [PUT /api/v2/iserver/settings](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration/setAllIserverSettings) -This endpoint allows you to access all of the Intelligence Server setting values that are available in MicroStrategy REST API. In this endpoint, you must provide a complete list of Intelligence Server settings, which is the different from the `PATCH /api/v2/iserver/settings` endpoint. You can find a list of Intelligence Server settings exposed in REST API via `GET /api/v2/iserver/settings/config`. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows you to access all of the Intelligence Server setting values that are available in Strategy REST API. In this endpoint, you must provide a complete list of Intelligence Server settings, which is the different from the `PATCH /api/v2/iserver/settings` endpoint. You can find a list of Intelligence Server settings exposed in REST API via `GET /api/v2/iserver/settings/config`. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). :::tip @@ -347,7 +347,7 @@ Response Code: 200 (Success: OK) Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out the authenticated user from the MicroStrategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting response returns a status code of 204. +This endpoint allows the caller to log out the authenticated user from the Strategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting response returns a status code of 204. ### Sample request diff --git a/docs/common-workflows/administration/server-management/server-level-privileges/manage-server-level-privileges.md b/docs/common-workflows/administration/server-management/server-level-privileges/manage-server-level-privileges.md index 0308176c7..8a594feff 100644 --- a/docs/common-workflows/administration/server-management/server-level-privileges/manage-server-level-privileges.md +++ b/docs/common-workflows/administration/server-management/server-level-privileges/manage-server-level-privileges.md @@ -7,7 +7,7 @@ description: A high-level workflow sample for managing server-level privileges i You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-27dd7275-e91a-4fe8-900b-0590e0de37b6?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -25,7 +25,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication, so you need to provide the username, password, and loginMode. The loginMode specifies the authentication mode to use. If you omit an optional field, the REST server uses the default value. If the call is successful, the resulting HTTP response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication, so you need to provide the username, password, and loginMode. The loginMode specifies the authentication mode to use. If you omit an optional field, the REST server uses the default value. If the call is successful, the resulting HTTP response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. In the following example, standard authentication uses a username of administrator and a blank password. @@ -383,7 +383,7 @@ The response is irrelevant to the privilege update. This is expected behavior. R Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out the authenticated user from the MicroStrategy REST server. In this example, you close the active user session by providing the X-MSTR-AuthToken authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code of 204. +This endpoint allows the caller to log out the authenticated user from the Strategy REST server. In this example, you close the active user session by providing the X-MSTR-AuthToken authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code of 204. ### Sample request diff --git a/docs/common-workflows/administration/server-management/server-level-privileges/server-level-privileges.md b/docs/common-workflows/administration/server-management/server-level-privileges/server-level-privileges.md index c51fb5a82..1f355f694 100644 --- a/docs/common-workflows/administration/server-management/server-level-privileges/server-level-privileges.md +++ b/docs/common-workflows/administration/server-management/server-level-privileges/server-level-privileges.md @@ -7,7 +7,7 @@ description: Privileges are assigned to users and user groups to authorize what You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-27dd7275-e91a-4fe8-900b-0590e0de37b6?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/server-management/server-level-privileges/watch-kpi-insight-service-privileges.md b/docs/common-workflows/administration/server-management/server-level-privileges/watch-kpi-insight-service-privileges.md index 8fc696608..51f736f31 100644 --- a/docs/common-workflows/administration/server-management/server-level-privileges/watch-kpi-insight-service-privileges.md +++ b/docs/common-workflows/administration/server-management/server-level-privileges/watch-kpi-insight-service-privileges.md @@ -7,7 +7,7 @@ description: A high-level workflow sample for managing Watch KPI and Insight ser A high-level workflow sample for managing Watch KPI and Insight service privileges is shown below. The sequence of REST API requests in the following procedure allows an administrative user to assign server-level privilege for a specific user or user group to use Watch KPI and Insight service. -For the privileges to use Watch KPI and Insight service, please refer to [Assign privileges to MicroStrategy Insight](https://www2.microstrategy.com/producthelp/2021/Library/en-us/Content/insights_privileges.htm). +For the privileges to use Watch KPI and Insight service, please refer to [Assign privileges to Strategy Insight](https://www2.microstrategy.com/producthelp/2021/Library/en-us/Content/insights_privileges.htm). A detailed explanation of each step is provided below: diff --git a/docs/common-workflows/administration/user-management/create-and-update-user-groups.md b/docs/common-workflows/administration/user-management/create-and-update-user-groups.md index 530deb77e..76ed1755e 100644 --- a/docs/common-workflows/administration/user-management/create-and-update-user-groups.md +++ b/docs/common-workflows/administration/user-management/create-and-update-user-groups.md @@ -8,7 +8,7 @@ description: A workflow sample for managing user groups in the metadata is provi You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-19b75da6-a5cf-47a0-a202-a4248e893d7c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -34,7 +34,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. In this example, you will use Standard authentication and log in as "administrator" with no password. @@ -360,7 +360,7 @@ Sample Response Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout_940x208](../../../images/swagger_POST_auth_logout_940x208.png) diff --git a/docs/common-workflows/administration/user-management/create-new-users.md b/docs/common-workflows/administration/user-management/create-new-users.md index ef3a1172d..d66e7570e 100644 --- a/docs/common-workflows/administration/user-management/create-new-users.md +++ b/docs/common-workflows/administration/user-management/create-new-users.md @@ -8,7 +8,7 @@ description: A workflow sample for creating a new user, a process often called o You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-be8db67e-6743-49ef-beb5-9efb96e01e4b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -29,7 +29,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used by subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used by subsequent requests. ![swagger_POST_auth_login_1003x508](../../../images/swagger_POST_auth_login_1003x508.png) @@ -408,7 +408,7 @@ Sample Response Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout_1010x223](../../../images/swagger_POST_auth_logout_1010x223.png) diff --git a/docs/common-workflows/administration/user-management/create-security-roles.md b/docs/common-workflows/administration/user-management/create-security-roles.md index 6ea66db9a..b65a922e7 100644 --- a/docs/common-workflows/administration/user-management/create-security-roles.md +++ b/docs/common-workflows/administration/user-management/create-security-roles.md @@ -8,7 +8,7 @@ description: A security role is a set of privileges that can be assigned to user You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ff1b1eae-77f6-461b-85cd-d63709d4b747?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -68,7 +68,7 @@ To make it easy for you to test this workflow in your environment, [download the Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication, so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication, so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. In this example, standard authentication and log in credentials "administrator" with `` password is used. @@ -758,7 +758,7 @@ This API endpoint is used to get information for all security roles. A security Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ### Sample request diff --git a/docs/common-workflows/administration/user-management/manage-user-and-user-groups.md b/docs/common-workflows/administration/user-management/manage-user-and-user-groups.md index 10759a566..f0161593b 100644 --- a/docs/common-workflows/administration/user-management/manage-user-and-user-groups.md +++ b/docs/common-workflows/administration/user-management/manage-user-and-user-groups.md @@ -7,7 +7,7 @@ description: Administrators can make REST API calls to manage users and user gro You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-dc9e5266-db8c-4842-9c44-16b5dd614f47). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/administration/user-management/manage-users.md b/docs/common-workflows/administration/user-management/manage-users.md index e72b14ee1..24b4e7207 100644 --- a/docs/common-workflows/administration/user-management/manage-users.md +++ b/docs/common-workflows/administration/user-management/manage-users.md @@ -8,7 +8,7 @@ description: A workflow sample for managing users in the metadata is provided be You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-be8db67e-6743-49ef-beb5-9efb96e01e4b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -28,7 +28,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide `username`, `password`, and `loginMode` (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns a status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used by subsequent requests. ![swagger_POST_auth_login](../../../images/swagger_POST_auth_login.png) @@ -308,7 +308,7 @@ Sample Response Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated by `POST /api/auth/login`. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout](../../../images/swagger_POST_auth_logout.png) diff --git a/docs/common-workflows/analytics/export-to-pdf.md b/docs/common-workflows/analytics/export-to-pdf.md index 0fb461acf..79c98beec 100644 --- a/docs/common-workflows/analytics/export-to-pdf.md +++ b/docs/common-workflows/analytics/export-to-pdf.md @@ -7,7 +7,7 @@ description: The workflow for exporting a document to PDF includes the following You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3835f147-fc3e-4e94-bc73-af51f57f7e83?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -25,7 +25,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. ![swagger_POST_auth_login](../../images/swagger_POST_auth_login.png) @@ -85,7 +85,7 @@ Sample Response Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1) -This endpoint allows the caller to get the list of projects with the MicroStrategy 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. +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. ![swagger_GET_projects](../../images/swagger_GET_projects.png) @@ -137,7 +137,7 @@ Sample Response Endpoint: [POST /api/documents/\{id}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Dossiers%20and%20Documents/createDocumentInstance) -This endpoint allows the caller to execute a specific document in a specific project and create an instance of that document. In this example, you execute a document called "Casino Analysis" (located in MicroStrategy Tutorial>Shared Reports>MicroStrategy Platform Capabilities>MicroStrategy Report Services>Visual Insight). You use the authorization token returned in step 1 as the value for `X-MSTR-AuthToken` and provide the project ID and the document ID. In this example, you leave the request body empty. The resulting HTTP response returns an HTTP status 201 and a JSON object containing the instance ID ("mid") of the document. +This endpoint allows the caller to execute a specific document in a specific project and create an instance of that document. In this example, you execute a document called "Casino Analysis" (located in MicroStrategy Tutorial>Shared Reports>Strategy Platform Capabilities>Strategy Report Services>Visual Insight). You use the authorization token returned in step 1 as the value for `X-MSTR-AuthToken` and provide the project ID and the document ID. In this example, you leave the request body empty. The resulting HTTP response returns an HTTP status 201 and a JSON object containing the instance ID ("mid") of the document. ![swagger_POST_documents](../../images/swagger_POST_documents.png) @@ -259,7 +259,7 @@ Sample Response Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout](../../images/swagger_POST_auth_logout.png) diff --git a/docs/common-workflows/analytics/filter-data/filter-data.md b/docs/common-workflows/analytics/filter-data/filter-data.md index 7c71d4b5a..31cbc9120 100644 --- a/docs/common-workflows/analytics/filter-data/filter-data.md +++ b/docs/common-workflows/analytics/filter-data/filter-data.md @@ -7,7 +7,7 @@ description: You can use REST API requests to filter data that is returned and t You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b0a16367-8997-447d-8731-2d6281d4f9bc?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -39,7 +39,7 @@ You can use the following REST APIs to [filter the data that is returned when yo We have provided a [workflow sample](filter-dossier-instances/apply-filters-to-a-dossier.md) that illustrates how to create an instance of a dashboard with an existing filter applied, and then re-execute the same dashboard instance with updated selections for the same filter. -For detailed information about filtering data in dashboards, see the [MicroStrategy product help](https://www2.microstrategy.com/producthelp/Current/MSTRWeb/WebHelp/Lang_1033/Content/filter_data.htm). +For detailed information about filtering data in dashboards, see the [Strategy product help](https://www2.microstrategy.com/producthelp/Current/MSTRWeb/WebHelp/Lang_1033/Content/filter_data.htm). ### Retrieve filters applied in dashboard chapters diff --git a/docs/common-workflows/analytics/filter-data/filter-dossier-instances/apply-filters-to-a-dossier.md b/docs/common-workflows/analytics/filter-data/filter-dossier-instances/apply-filters-to-a-dossier.md index 85f94ccef..d13ac0701 100644 --- a/docs/common-workflows/analytics/filter-data/filter-dossier-instances/apply-filters-to-a-dossier.md +++ b/docs/common-workflows/analytics/filter-data/filter-dossier-instances/apply-filters-to-a-dossier.md @@ -8,7 +8,7 @@ description: In this workflow, you create an instance of a dashboard using the f You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d6462995-9003-4187-b121-47a5fb31436a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -28,7 +28,7 @@ Call `POST /api/auth/login` to authenticate into the environment with standard a Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. Sample Request @@ -544,7 +544,7 @@ Call `POST /api/logout` to close the session. Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. Sample Request diff --git a/docs/common-workflows/analytics/filter-data/filter-dossier-instances/filter-dossier-instances.md b/docs/common-workflows/analytics/filter-data/filter-dossier-instances/filter-dossier-instances.md index b3bf8ee24..04858fe1e 100644 --- a/docs/common-workflows/analytics/filter-data/filter-dossier-instances/filter-dossier-instances.md +++ b/docs/common-workflows/analytics/filter-data/filter-dossier-instances/filter-dossier-instances.md @@ -10,4 +10,4 @@ You can use the following REST APIs to filter the data that is returned when you We have provided a [workflow sample](apply-filters-to-a-dossier.md) that illustrates how to create an instance of a dashboard with an existing filter applied, and then re-execute the same dashboard instance with updated selections for the same filter. -For detailed information about filtering data in dashboards, see the [MicroStrategy product help](https://www2.microstrategy.com/producthelp/current/MSTRWeb/WebHelp/Lang_1033/Content/filter_data.htm). +For detailed information about filtering data in dashboards, see the [Strategy product help](https://www2.microstrategy.com/producthelp/current/MSTRWeb/WebHelp/Lang_1033/Content/filter_data.htm). diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/filter-report-and-cube-instances-using-metric-limits.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/filter-report-and-cube-instances-using-metric-limits.md index 8276e804d..327959acd 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/filter-report-and-cube-instances-using-metric-limits.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/filter-report-and-cube-instances-using-metric-limits.md @@ -7,11 +7,11 @@ description: How to filter report and cube instances using metric limits. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-621fc29f-e7e3-4065-9084-5bbdb0d81267?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -When you create a MicroStrategy report or cube instance using the following REST API endpoints, you can use a parameter called `metricLimits` in the body parameter of the request to filter the data that is returned: +When you create a report or cube instance using the following REST API endpoints, you can use a parameter called `metricLimits` in the body parameter of the request to filter the data that is returned: - `POST /api/cubes/{cubeId}/instances` - `POST /api/reports/{reportId}/instances` diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/supported-operators.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/supported-operators.md index dd8052a27..83f24b19d 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/supported-operators.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-metric-limits/supported-operators.md @@ -5,19 +5,19 @@ description: The supported operators for metric limits. The table below lists the operators/functions that can be used to define metric limits when you are creating reports and cube instances with REST APIs (sometimes referred to as JSON Data API). -| MicroStrategy Web Functions | REST API Operators | Function | Operands Count | -| --------------------------- | ------------------ | -------- | -------------- | -| Equals | Equals | = | 2 | -| Does not equal | NotEqual | != | 2 | -| Greater than | Greater | > | 2 | -| Less than | Less | \< | 2 | -| Greater than or equal to | GreaterEqual | >= | 2 | -| Less than or equal to | LessEqual | \<= | 2 | -| Between | Between | | 3 | -| Not between | NotBetween | | 3 | -| Is null | IsNull | null | 1 | -| Is not null | IsNotNull | notnull | 1 | -| Highest | Rant.Top | | 2 | -| Lowest | Rank.Bottom | | 2 | -| Highest (%) | Percent.Top | | 2 | -| Lowest (%) | Percent.Bottom | | 2 | +| Web Functions | REST API Operators | Function | Operands Count | +| ------------------------ | ------------------ | -------- | -------------- | +| Equals | Equals | = | 2 | +| Does not equal | NotEqual | != | 2 | +| Greater than | Greater | > | 2 | +| Less than | Less | \< | 2 | +| Greater than or equal to | GreaterEqual | >= | 2 | +| Less than or equal to | LessEqual | \<= | 2 | +| Between | Between | | 3 | +| Not between | NotBetween | | 3 | +| Is null | IsNull | null | 1 | +| Is not null | IsNotNull | notnull | 1 | +| Highest | Rant.Top | | 2 | +| Lowest | Rank.Bottom | | 2 | +| Highest (%) | Percent.Top | | 2 | +| Lowest (%) | Percent.Bottom | | 2 | diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-requested-objects/filter-report-and-cube-instances-using-requested-objects.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-requested-objects/filter-report-and-cube-instances-using-requested-objects.md index 5714b0913..2eb3e5697 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-requested-objects/filter-report-and-cube-instances-using-requested-objects.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-requested-objects/filter-report-and-cube-instances-using-requested-objects.md @@ -7,11 +7,11 @@ description: How to filter report and cube instances using requestedObjects. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2650c93b-4797-4fa7-86cc-f38d0c43971e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -When you create a MicroStrategy report or cube instance using the following REST API endpoints, you can use a parameter called `requestedObjects` in the body parameter of the request to specify the data that should be returned: +When you create a report or cube instance using the following REST API endpoints, you can use a parameter called `requestedObjects` in the body parameter of the request to specify the data that should be returned: - `POST /api/cubes/{cubeId}/instances` - `POST /api/reports/{reportId}/instances` diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/filter-report-and-cube-instances-using-view-filters.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/filter-report-and-cube-instances-using-view-filters.md index 5aae154be..f9dd4d862 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/filter-report-and-cube-instances-using-view-filters.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/filter-report-and-cube-instances-using-view-filters.md @@ -7,11 +7,11 @@ description: How to filter report and cube instances using view filters. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-eb1fcb00-e3b5-4a0c-bef9-4639e04c675c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -When you create a MicroStrategy report or cube instance using the following REST API endpoints, you can use a parameter called viewFilter in the body parameter of the request to filter the data that is returned: +When you create a report or cube instance using the following REST API endpoints, you can use a parameter called viewFilter in the body parameter of the request to filter the data that is returned: - `POST /api/cubes/{cubeId}/instances` - `POST /api/reports/{reportId}/instances` diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/general-guidelines.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/general-guidelines.md index 8090f5697..e04cd7c77 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/general-guidelines.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances-using-view-filters/general-guidelines.md @@ -51,7 +51,7 @@ When you use a view filter to refine the data returned in a report or cube insta - Page by - Prompt - Features that may not work well with view filters include: - - Derived elements and other objects that cannot be qualified on in MicroStrategy Web + - Derived elements and other objects that cannot be qualified on in Web - Other REST API unsupported features - Attribute / element / form / metric IDs must be valid, which means: diff --git a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances.md b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances.md index 3ce5fdfb0..e460cc60b 100644 --- a/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances.md +++ b/docs/common-workflows/analytics/filter-data/filter-report-and-cube-instances/filter-report-and-cube-instances.md @@ -7,7 +7,7 @@ description: You can filter data that is returned by the following REST API requ You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-aba744e4-751e-410a-b5c1-4ad7d0db7b67?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/retrieve-filters-applied-to-a-visualization.md b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/retrieve-filters-applied-to-a-visualization.md index e068dbbc9..39cdc3d62 100644 --- a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/retrieve-filters-applied-to-a-visualization.md +++ b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/retrieve-filters-applied-to-a-visualization.md @@ -7,7 +7,7 @@ description: You can use the following REST API endpoint to return information a You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-9468e98f-f4e6-4dcd-b63e-17cb724fa3be?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-attribute-based-view-filters.md b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-attribute-based-view-filters.md index ef21f3d6e..052771585 100644 --- a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-attribute-based-view-filters.md +++ b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-attribute-based-view-filters.md @@ -41,4 +41,4 @@ Attribute-based view filters can be applied in a number of ways. For example, th 1. Click **OK**. 1. Click **Save**. -Refer to the MicroStrategy product manuals for a detailed explanation of attribute-based view filters and how they can be applied. +Refer to the product manuals for a detailed explanation of attribute-based view filters and how they can be applied. diff --git a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-based-view-filters.md b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-based-view-filters.md index 5145fe564..c6dffcd3e 100644 --- a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-based-view-filters.md +++ b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-based-view-filters.md @@ -43,4 +43,4 @@ Metric-based view filters can be applied in a number of ways. For example, they 1. Click **OK**. 1. Click **Save**. -Refer to the MicroStrategy product manuals for a detailed explanation of metric-based view filters and how they can be applied. +Refer to the product manuals for a detailed explanation of metric-based view filters and how they can be applied. diff --git a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-limit-criteria.md b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-limit-criteria.md index 2cb9ec5ee..33d09b242 100644 --- a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-limit-criteria.md +++ b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-metric-limit-criteria.md @@ -36,4 +36,4 @@ Metric limits can be applied in a number of ways. For example, they can be appli 1. Click **OK**. 1. Click **Save**. -Refer to the MicroStrategy product manuals for a detailed explanation of metric limits and how they can be applied. +Refer to the product manuals for a detailed explanation of metric limits and how they can be applied. diff --git a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-template-limit-criteria.md b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-template-limit-criteria.md index a6d42294a..b89fd2e11 100644 --- a/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-template-limit-criteria.md +++ b/docs/common-workflows/analytics/filter-data/retrieve-filters-applied-to-a-visualization/return-template-limit-criteria.md @@ -11,7 +11,7 @@ You use the following REST API endpoint to return information about the template - `GET /api/dossiers/{dossierId}/instances/{instanceId}/chapters/{chapterKey/visualizations/{visualizationKey}` -Template limits correspond to Keep Only and Exclude filters in MicroStrategy Web. They can include multiple criteria, joined by the AND and OR operators. Complex template limit filtering criteria might look like this: +Template limits correspond to Keep Only and Exclude filters in Web. They can include multiple criteria, joined by the AND and OR operators. Complex template limit filtering criteria might look like this: AND [((Accounts = Property, Plant, Equipment) Or (Accounts = Construction In Progress) Or (Accounts = Leasehold Improvements) Or (Accounts = Office Furniture & Equipment) Or (Accounts = Machinery & Equipment) Or (Accounts = Buildings & Improvements) Or (Accounts = Land & Improvements)) And (Departments = Sales and Marketing)] @@ -35,4 +35,4 @@ Template limits can be applied in a number of ways. For example, they can be app 1. Right-click an attribute or metric in the visualization. 1. Choose **Keep Only** or Exclude from the drop-down menu. -Refer to the MicroStrategy product manuals for a detailed explanation of template limits and how they can be applied. +Refer to the product manuals for a detailed explanation of template limits and how they can be applied. diff --git a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/benefits.md b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/benefits.md index 3c4fb2d9c..a70d6f216 100644 --- a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/benefits.md +++ b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/benefits.md @@ -3,7 +3,7 @@ title: Benefits of creating a dataset incrementally with multiple requests description: The benefits of creating a dataset incrementally with multiple requests. --- -The incremental approach to making external data available to MicroStrategy, using multiple requests, has a variety of benefits: +The incremental approach to making external data available to Strategy, using multiple requests, has a variety of benefits: - You can create multiple tables in a dataset, rather than being limited to a single table. - The actions for uploading data and publishing the dataset have been separated, and data can be uploaded in separate chunks. This provides scalability and better performance and is very important when you are working with very large datasets. diff --git a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/workflow-create-a-dataset-incrementally-with-multiple-requests.md b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/workflow-create-a-dataset-incrementally-with-multiple-requests.md index e97eab2b3..5d4955e0e 100644 --- a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/workflow-create-a-dataset-incrementally-with-multiple-requests.md +++ b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/workflow-create-a-dataset-incrementally-with-multiple-requests.md @@ -8,7 +8,7 @@ description: The steps below illustrate the workflow for defining a dataset with You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2f45d89b-a009-455b-b181-f5e529be9121?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -39,7 +39,7 @@ A detailed explanation of each step, with code samples, is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST server. You provide the information used to create the session in the body of the request; in this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST server. You provide the information used to create the session in the body of the request; in this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing the authorization token that will be used in subsequent requests. Sample Request Header: @@ -770,7 +770,7 @@ This endpoint allows the caller to delete the upload session after the dataset i Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user, using the MicroStrategy REST server. You close the active user session by providing the authorization token generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user, using the Strategy REST server. You close the active user session by providing the authorization token generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ### Request diff --git a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-with-one-request/workflow-create-and-modify-a-dataset-with-one-request.md b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-with-one-request/workflow-create-and-modify-a-dataset-with-one-request.md index 0c5beae0e..eaaab3ea5 100644 --- a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-with-one-request/workflow-create-and-modify-a-dataset-with-one-request.md +++ b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-with-one-request/workflow-create-and-modify-a-dataset-with-one-request.md @@ -8,7 +8,7 @@ description: The steps below illustrate the workflow for creating and modifying You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-eccc2471-3af4-44c0-b4aa-9c98a1443823?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -37,7 +37,7 @@ A detailed explanation of each step is provided below. Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used in subsequent requests. Sample Request Header: @@ -90,7 +90,7 @@ Response Body: Empty Endpoint: [POST /api/datasets](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasets/createDICube) -This endpoint allows the caller to create a dataset with the MicroStrategy REST server. You use the authorization token returned in step 1 as the value for `X-MSTR-AuthToken` and a project ID for `X-MSTR-ProjectID`. +This endpoint allows the caller to create a dataset with the Strategy REST server. You use the authorization token returned in step 1 as the value for `X-MSTR-AuthToken` and a project ID for `X-MSTR-ProjectID`. The dataset is created from the data in the `body` parameter of the request. The `body` parameter defines the data you want to upload to the Intelligence Server. @@ -358,7 +358,7 @@ A dataset named SALES_TABLE is created under the My Reports folder. The dataset Endpoint: [PATCH /api/datasets/\{datasetId}/tables/\{tableId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasets/updateDICube) -This endpoint allows the caller to update and republish a dataset that was created by the MicroStrategy REST server (using `POST /api/datasets`). To update and republish a specific dataset, you provide the authorization token, `X-MSTR-AuthToken`, generated in step 1, the dataset ID and table ID to identify the dataset to be updated, the type of update action that should be performed, and the data to be applied. If successful, the resulting HTTP response returns an HTTP status 200. +This endpoint allows the caller to update and republish a dataset that was created by the Strategy REST server (using `POST /api/datasets`). To update and republish a specific dataset, you provide the authorization token, `X-MSTR-AuthToken`, generated in step 1, the dataset ID and table ID to identify the dataset to be updated, the type of update action that should be performed, and the data to be applied. If successful, the resulting HTTP response returns an HTTP status 200. Request Parameters @@ -447,7 +447,7 @@ The dataset named SALES_TABLE, under the My Reports folder, is updated and repub Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated in step 1. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated in step 1. If the call is successful, the resulting HTTP response returns an HTTP status code 204. Sample Request Header: diff --git a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/make-external-data-available.md b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/make-external-data-available.md index f1335a045..0ef0815f9 100644 --- a/docs/common-workflows/analytics/manage-datasets/make-external-data-available/make-external-data-available.md +++ b/docs/common-workflows/analytics/manage-datasets/make-external-data-available/make-external-data-available.md @@ -1,23 +1,23 @@ --- title: Make external data available using the Push Data API -description: The Push Data API, which belongs to the Dataset API family, lets you make external data easily available for analysis in MicroStrategy. You use REST APIs to create and modify datasets using external data uploaded directly to the Intelligence Server. +description: The Push Data API, which belongs to the Dataset API family, lets you make external data easily available for analysis in Strategy. You use REST APIs to create and modify datasets using external data uploaded directly to the Intelligence Server. --- :::tip You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-724e8a71-2d94-4887-af80-f57d62503f46?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -The Push Data API, which belongs to the Dataset API family, lets you make external data easily available for analysis in MicroStrategy. You use REST APIs to create and modify datasets using external data uploaded directly to the Intelligence Server. +The Push Data API, which belongs to the Dataset API family, lets you make external data easily available for analysis in Strategy. You use REST APIs to create and modify datasets using external data uploaded directly to the Intelligence Server. -- By providing a simpler, quicker way to get data out and add data back in, the Push Data API makes it easier to use MicroStrategy as a high-performance data storage and retrieval mechanism and supports predictive workflow by machine learning, artificial intelligence, and data scientist teams. -- The ability to make external data easily available extends MicroStrategy's reach to new and complex data sources where code, rather than end-users, manages the data modeling/mapping flow. -- The Push Data API supports close integration with the ecosystem of third-party ETL tools because it allows them to push data directly into MicroStrategy while allowing the most optimal utilization of MicroStrategy's cube capabilities. The Push Data API provides these tools, whether they are analyst or IT-oriented, with the option to create and update datasets on the MicroStrategy Intelligence Server without requiring an intermediate step of pushing the data into a warehouse. +- By providing a simpler, quicker way to get data out and add data back in, the Push Data API makes it easier to use Strategy as a high-performance data storage and retrieval mechanism and supports predictive workflow by machine learning, artificial intelligence, and data scientist teams. +- The ability to make external data easily available extends Strategy's reach to new and complex data sources where code, rather than end-users, manages the data modeling/mapping flow. +- The Push Data API supports close integration with the ecosystem of third-party ETL tools because it allows them to push data directly into Strategy while allowing the most optimal utilization of Strategy's cube capabilities. The Push Data API provides these tools, whether they are analyst or IT-oriented, with the option to create and update datasets on the Intelligence Server without requiring an intermediate step of pushing the data into a warehouse. -When the Push Data API was introduced in MicroStrategy 10.11, it supported only a single table and data was uploaded and published in the same request. This single request workflow works well for small, simple dataset creation scenarios, but a newer multiple request workflow supports more complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This workflow separates dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication. +When the Push Data API was introduced in Strategy 10.11, it supported only a single table and data was uploaded and published in the same request. This single request workflow works well for small, simple dataset creation scenarios, but a newer multiple request workflow supports more complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This workflow separates dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication. - [Creating a dataset with one request](create-a-dataset-with-one-request/workflow-create-and-modify-a-dataset-with-one-request.md) diff --git a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/create-a-cube-object.md b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/create-a-cube-object.md index e07627aa3..b50470b44 100644 --- a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/create-a-cube-object.md +++ b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/create-a-cube-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new cube object t You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ef6003b3-abe9-40ee-abf7-ff72de088f22?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/manage-cube-objects.md b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/manage-cube-objects.md index 4d09b5c29..abd6545ae 100644 --- a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/manage-cube-objects.md +++ b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/manage-cube-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update cube You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c00a4cc5-d401-4786-8a6d-dba31f6af81f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/retrieve-a-cube-definition.md b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/retrieve-a-cube-definition.md index dcc45f81f..99edc5d23 100644 --- a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/retrieve-a-cube-definition.md +++ b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/retrieve-a-cube-definition.md @@ -10,7 +10,7 @@ description: This topic cover several workflows for retrieving a cube's definiti You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-585d42d1-fbdc-4d1d-afbb-c4e872753709?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -439,7 +439,7 @@ Response Code: 200 (The cube’s definition was returned successfully.) This workflow sample demonstrates how to retrieve the definition of a cube with its filter in tokens format through the Modeling service. Unlike the first workflow, you want to enable the `showFilterTokens` parameter to retrieve the filter's definition in tokens format as well. -Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is `Revenue > Cost`. When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: `("Revenue", Revenue_ID)`, `(">", GreaterThan_ID)`, `("Cost", Cost_ID)`. +Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a filter expression is `Revenue > Cost`. When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: `("Revenue", Revenue_ID)`, `(">", GreaterThan_ID)`, `("Cost", Cost_ID)`. A filter's "qualification" is presented in the following formats: @@ -631,7 +631,7 @@ In this workflow sample, you want to get the definition cube when its filter con If custom expressions are used in a filter, this parameter specifies the format in the which they are returned in the response. -Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is `Revenue > Cost`. When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: `("Revenue", Revenue_ID)`, `(">", GreaterThan_ID)`, `("Cost", Cost_ID)`. +Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a filter expression is `Revenue > Cost`. When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: `("Revenue", Revenue_ID)`, `(">", GreaterThan_ID)`, `("Cost", Cost_ID)`. A filter's "qualification" is presented in the following formats: diff --git a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/update-a-cube-definition.md b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/update-a-cube-definition.md index b774788b6..3d4f139a6 100644 --- a/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/update-a-cube-definition.md +++ b/docs/common-workflows/analytics/manage-datasets/manage-cube-objects/update-a-cube-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a cube’s definiti You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ef6003b3-abe9-40ee-abf7-ff72de088f22?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-documents/get-document-list/get-document-list.md b/docs/common-workflows/analytics/manage-documents/get-document-list/get-document-list.md index 8dd2596ed..842837bdf 100644 --- a/docs/common-workflows/analytics/manage-documents/get-document-list/get-document-list.md +++ b/docs/common-workflows/analytics/manage-documents/get-document-list/get-document-list.md @@ -1,11 +1,11 @@ --- title: Retrieve documents -Description: Retrieve a list of documents using the MicroStrategy REST API. +Description: Retrieve a list of documents using the Strategy REST API. --- -This workflow sample demonstrates how to retrieve a list of documents using the MicroStrategy REST API. +This workflow sample demonstrates how to retrieve a list of documents using the Strategy REST API. :::info diff --git a/docs/common-workflows/analytics/manage-documents/manage-documents.md b/docs/common-workflows/analytics/manage-documents/manage-documents.md index 4ce73b15b..2e625f449 100644 --- a/docs/common-workflows/analytics/manage-documents/manage-documents.md +++ b/docs/common-workflows/analytics/manage-documents/manage-documents.md @@ -1,6 +1,6 @@ --- title: Manage documents -Description: Manage documents using the MicroStrategy REST API. +Description: Manage documents using the Strategy REST API. --- diff --git a/docs/common-workflows/analytics/manage-documents/retrieve-document/retrieve-the-hierarchy-of-a-document.md b/docs/common-workflows/analytics/manage-documents/retrieve-document/retrieve-the-hierarchy-of-a-document.md index beceab2ed..120e7f21d 100644 --- a/docs/common-workflows/analytics/manage-documents/retrieve-document/retrieve-the-hierarchy-of-a-document.md +++ b/docs/common-workflows/analytics/manage-documents/retrieve-document/retrieve-the-hierarchy-of-a-document.md @@ -1,17 +1,17 @@ --- title: Retrieve the hierarchy of document - Description: Retrieve the hierarchy of document using the MicroStrategy REST API. + Description: Retrieve the hierarchy of document using the Strategy REST API. --- :::tip -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -This workflow sample demonstrates how to retrieve the document definition directly using the MicroStrategy REST API. +This workflow sample demonstrates how to retrieve the document definition directly using the Strategy REST API. You want to retrieve the document's definition from “MicroStrategy Tutorial“ project. The document ID is `643209B54CC84199C48A238ACB6CB621`. The project ID is `B19DEDCC11D4E0EFC000EB9495D0F44F`. diff --git a/docs/common-workflows/analytics/manage-dossiers/create-instance/create-instance.md b/docs/common-workflows/analytics/manage-dossiers/create-instance/create-instance.md index 7efb530c6..4d3a6dd46 100644 --- a/docs/common-workflows/analytics/manage-dossiers/create-instance/create-instance.md +++ b/docs/common-workflows/analytics/manage-dossiers/create-instance/create-instance.md @@ -11,7 +11,7 @@ This workflow sample demonstrates how to create an instance of a dashboard in me You can try this API with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/request/16131298-c530c47a-845f-4231-b071-2247bd846c66). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-dossiers/manage-dossiers.md b/docs/common-workflows/analytics/manage-dossiers/manage-dossiers.md index 42f045cdf..10b16cb0a 100644 --- a/docs/common-workflows/analytics/manage-dossiers/manage-dossiers.md +++ b/docs/common-workflows/analytics/manage-dossiers/manage-dossiers.md @@ -1,6 +1,6 @@ --- title: Manage dashboards -Description: Manage dashboards using the MicroStrategy REST API. +Description: Manage dashboards using the Strategy REST API. --- diff --git a/docs/common-workflows/analytics/manage-insights/get-kpi.md b/docs/common-workflows/analytics/manage-insights/get-kpi.md index a3c1e0a8d..2e6848631 100644 --- a/docs/common-workflows/analytics/manage-insights/get-kpi.md +++ b/docs/common-workflows/analytics/manage-insights/get-kpi.md @@ -488,7 +488,7 @@ KPI in response: | content.id | The dashboard ID | | content.instanceId | The instance ID of the dashboard, only required in [POST /api/insight/KPIs](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Insight%20Engine%20-%20KPIs/createKPI) | | schedule | Internal property, this field can be ignored | -| hashInfo | Used only by MicroStrategy App for cache purposes | +| hashInfo | Used only by Strategy App for cache purposes | | dataCompares | The comparison results according to `compareWith` parameter in URL. Comparisons are performed by the latest data point and the data point specified by indicator. e.g. "1d" compares the data point of the current time with the data point 24 hours before the current time. | | dataCompares[*].timestamp | The timestamp of the data point used for comparison | | dataCompares[*].indicator | The comparison indicator | diff --git a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/create-an-irr.md b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/create-an-irr.md index 99eb1e229..a7aca7e92 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/create-an-irr.md +++ b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/create-an-irr.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new Incremental R You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-54f5b582-05ac-4f2d-88f9-98f36dd8373c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/manage-incremental-refresh-report.md b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/manage-incremental-refresh-report.md index b7d90693c..37050de74 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/manage-incremental-refresh-report.md +++ b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/manage-incremental-refresh-report.md @@ -9,7 +9,7 @@ description: You can use REST API requests retrieve, create, and update the In You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-bc4cbadd-29e6-4426-85ff-30bcc0f20d60?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/update-an-irr-definition.md b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/update-an-irr-definition.md index 910843be0..56db2e8d6 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/update-an-irr-definition.md +++ b/docs/common-workflows/analytics/manage-reports/manage-incremental-refresh-report/update-an-irr-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an Incremental Refr You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-54f5b582-05ac-4f2d-88f9-98f36dd8373c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-reports/manage-page-by-information.md b/docs/common-workflows/analytics/manage-reports/manage-page-by-information.md index 013a3df48..95fd8c3dc 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-page-by-information.md +++ b/docs/common-workflows/analytics/manage-reports/manage-page-by-information.md @@ -7,7 +7,7 @@ description: You can use REST API requests to manage page-by information for rep You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-244d4021-db1d-4e6d-9b3e-04dd192faa2f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -17,7 +17,7 @@ You can use REST API requests to manage page-by information for reports. - [Execute the report and fetch data to apply to the page-by information](#execute-the-report-and-fetch-data-to-apply-to-the-page-by-information) - [Update a report instance to modify the current page of page-by(s)](#update-a-report-instance-to-modify-the-current-page-of-page-bys) -The workflows on this page use the Unit Sales Paged report located in the MicroStrategy Tutorial project at **Shared Reports** > **MicroStrategy Platform Capabilities** > **MicroStrategy Office** > **Excel - Self-Service Report Book** > **Paged Report**. +The workflows on this page use the Unit Sales Paged report located in the MicroStrategy Tutorial project at **Shared Reports** > **Strategy Platform Capabilities** > **Strategy Office** > **Excel - Self-Service Report Book** > **Paged Report**. ![page_by_report](../../../images/page_by_report.png) diff --git a/docs/common-workflows/analytics/manage-reports/manage-report-objects/execute-report.md b/docs/common-workflows/analytics/manage-reports/manage-report-objects/execute-report.md index ede964659..a465133ca 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-report-objects/execute-report.md +++ b/docs/common-workflows/analytics/manage-reports/manage-report-objects/execute-report.md @@ -195,7 +195,7 @@ Sample Request Header: Sample Request Body: Empty -Sample Response Body: See details in [MicroStrategy REST](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/executeReport_1) +Sample Response Body: See details in [Strategy REST](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/executeReport_1) Sample Response Code: 200 (Report data has been returned.) diff --git a/docs/common-workflows/analytics/manage-reports/manage-report-objects/manage-report-objects.md b/docs/common-workflows/analytics/manage-reports/manage-report-objects/manage-report-objects.md index 5acd2f0b6..58da41ab8 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-report-objects/manage-report-objects.md +++ b/docs/common-workflows/analytics/manage-reports/manage-report-objects/manage-report-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update repor You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-37579918-50ac-4383-8187-52d886b82d4b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-reports/manage-report-objects/update-the-definition-of-an-existing-report.md b/docs/common-workflows/analytics/manage-reports/manage-report-objects/update-the-definition-of-an-existing-report.md index f05613700..ec3791d58 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-report-objects/update-the-definition-of-an-existing-report.md +++ b/docs/common-workflows/analytics/manage-reports/manage-report-objects/update-the-definition-of-an-existing-report.md @@ -9,7 +9,7 @@ You can use REST APIs to update an existing report object through Modeling servi ## Update the definition of an existing report -In this sample workflow, we want to update an existing report object "New Normal Report" (report ID: `FB7816D149C8AC0573CC55829E56F217`) in project "Microstrategy Tutorial" (project ID: `B19DEDCC11D4E0EFC000EB9495D0F44F`), we have just created it in Workflow Sample: Create a New Report. +In this sample workflow, we want to update an existing report object "New Normal Report" (report ID: `FB7816D149C8AC0573CC55829E56F217`) in project "MicroStrategy Tutorial" (project ID: `B19DEDCC11D4E0EFC000EB9495D0F44F`), we have just created it in Workflow Sample: Create a New Report. :::info diff --git a/docs/common-workflows/analytics/manage-reports/manage-transaction-report-objects/manage-transaction-report-objects.md b/docs/common-workflows/analytics/manage-reports/manage-transaction-report-objects/manage-transaction-report-objects.md index 52f00710d..f085156d0 100644 --- a/docs/common-workflows/analytics/manage-reports/manage-transaction-report-objects/manage-transaction-report-objects.md +++ b/docs/common-workflows/analytics/manage-reports/manage-transaction-report-objects/manage-transaction-report-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update the You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-f0b4a18d-227b-4f84-b000-92d56e8fcf9b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/manage-selectors/manage-selectors.md b/docs/common-workflows/analytics/manage-selectors/manage-selectors.md index f3a10b55e..ae27497d6 100644 --- a/docs/common-workflows/analytics/manage-selectors/manage-selectors.md +++ b/docs/common-workflows/analytics/manage-selectors/manage-selectors.md @@ -1,9 +1,9 @@ --- title: Manage selectors -description: The MicroStrategy RESTful server supports different types of selectors, similar to the function in MicroStrategy Library Web. +description: The Strategy RESTful server supports different types of selectors, similar to the function in Library Web. --- -The MicroStrategy RESTful server supports different types of selectors, similar to the function in MicroStrategy Library Web. +The Strategy RESTful server supports different types of selectors, similar to the function in Library Web. The following five selector types are supported: diff --git a/docs/common-workflows/analytics/object-discovery/data-lineage-analysis-via-rest-apis.md b/docs/common-workflows/analytics/object-discovery/data-lineage-analysis-via-rest-apis.md index 8a93d54dd..53d6337cf 100644 --- a/docs/common-workflows/analytics/object-discovery/data-lineage-analysis-via-rest-apis.md +++ b/docs/common-workflows/analytics/object-discovery/data-lineage-analysis-via-rest-apis.md @@ -9,13 +9,13 @@ description: The metadata is used in object management use cases, such as editin You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-e42edf07-9e68-4cc2-9eb9-a16ad920bb49?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: The metadata is used in object management use cases, such as editing a metric to use a different fact object. In such a use case, the user needs to understand how an object is used and where it comes from. To do so, the user can use a data lineage or data traceability function. Here, we can use search API to perform data lineage analysis on the metadata. -There are two functions that MicroStrategy data lineage supports: +There are two functions that Strategy data lineage supports: - Given an object, for example a report, attribute, dashboard, or database, list the direct and indirect components of that object - Given an object, list the objects which directly and indirectly depend on that object diff --git a/docs/common-workflows/analytics/object-discovery/folder-browsing.md b/docs/common-workflows/analytics/object-discovery/folder-browsing.md index b64689517..c3f4b2121 100644 --- a/docs/common-workflows/analytics/object-discovery/folder-browsing.md +++ b/docs/common-workflows/analytics/object-discovery/folder-browsing.md @@ -8,7 +8,7 @@ description: The workflow for browsing folders in the metadata includes the foll You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-01bcf62f-9d6f-4ddf-9f63-064d875ddae2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -27,7 +27,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. ![swagger_POST_auth_login](../../../images/swagger_POST_auth_login.png) @@ -86,7 +86,7 @@ Sample Response Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1) -This endpoint allows the caller to get the list of projects with the MicroStrategy 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 the header parameter, `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. +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 the header parameter, `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. ![swagger_GET_projects](../../../images/swagger_GET_projects.png) @@ -140,7 +140,7 @@ The response body contains information for each project that is returned, includ Endpoint: [GET /api/folders/preDefined/\{folderType}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Browsing/getPreDefinedFolder) -This endpoint allows the caller to get the objects under a predefined folder with the MicroStrategy REST server. In this example, you get the objects under "Shared Reports" in the "MicroStrategy Tutorial" project. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for `folderType` from the [EnumDSSXMLFolderNames](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLFolderNames.html) enumeration. In this example, you use the value "7" , which specifies the predefined "Shared Reports" folder under the "Public Objects" folder. If the call is successful, the resulting HTTP response returns an HTTP status 200 and a list of metadata objects under the "Shared Reports" folder. +This endpoint allows the caller to get the objects under a predefined folder with the Strategy REST server. In this example, you get the objects under "Shared Reports" in the "MicroStrategy Tutorial" project. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for `folderType` from the [EnumDSSXMLFolderNames](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLFolderNames.html) enumeration. In this example, you use the value "7" , which specifies the predefined "Shared Reports" folder under the "Public Objects" folder. If the call is successful, the resulting HTTP response returns an HTTP status 200 and a list of metadata objects under the "Shared Reports" folder. ![swagger_GET_folders_preDefined](../../../images/swagger_GET_folders_preDefined.png) @@ -170,7 +170,7 @@ Sample Response - Response Body - You can find detail definitions of each parameter in the Response body for this endpoint on the MicroStrategy REST API Explorer page, under Response Class -> Model. + You can find detail definitions of each parameter in the Response body for this endpoint on the Strategy REST API Explorer page, under Response Class -> Model. ```json { @@ -222,7 +222,7 @@ Sample Response "name": "MicroStrategy Platform Capabilities", "id": "D64C532E4E7FBA74D29A7CA3576F39CF", "type": 8, - "description": "This folder contains examples of many of the sophisticated capabilities within the MicroStrategy platform.", + "description": "This folder contains examples of many of the sophisticated capabilities within the Strategy platform.", "subtype": 2048, "dateCreated": "2006-05-23T04:55:20.000-0400", "dateModified": "2012-05-17T05:00:38.000-0400", @@ -273,7 +273,7 @@ Sample Response Endpoint: [GET /api/folders/preDefined?folderType=\{folderType}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Browsing/getPreDefinedFolders) -This endpoint allows the caller to get the folder object of one or more predefined folders with the MicroStrategy REST server. In this example, you get the "Shared Reports" and "My Reports" folder objects in the "MicroStrategy Tutorial" project. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for `folderType` from the [EnumDSSXMLFolderNames](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLFolderNames.html) enumeration. You may specify multiple folder types as a comma separated list. In this example, you use the value "7,20", where "7" specifies the predefined "Shared Reports" folder under the "Public Objects" folder, and "20" specifies the "My Reports" folder under the profile folder of the active user. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the folder objects requested. +This endpoint allows the caller to get the folder object of one or more predefined folders with the Strategy REST server. In this example, you get the "Shared Reports" and "My Reports" folder objects in the "MicroStrategy Tutorial" project. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for `folderType` from the [EnumDSSXMLFolderNames](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLFolderNames.html) enumeration. You may specify multiple folder types as a comma separated list. In this example, you use the value "7,20", where "7" specifies the predefined "Shared Reports" folder under the "Public Objects" folder, and "20" specifies the "My Reports" folder under the profile folder of the active user. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the folder objects requested. Sample Request @@ -354,7 +354,7 @@ Sample Response Endpoint: [GET /api/folders/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Browsing/getFolder) -This endpoint allows the caller to get the objects under a folder with the MicroStrategy REST server using the folder ID. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for the `id` path parameter with the ID of the folder you want to browse to. In this example, the value "032A5E114A59D28267BDD8B6D9E58B22" is used, which is the ID of the "Business Roles" folder under "Shared Reports" that was returned by [GET /api/folders/preDefined/7](#browse-to-the-shared-reports-folder). If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of metadata objects under the folder. +This endpoint allows the caller to get the objects under a folder with the Strategy REST server using the folder ID. You use the authorization token returned by `POST /api/auth/login` as the value for `X-MSTR-AuthToken` and a project ID returned by `GET /api/projects` as the value for `X-MSTR-ProjectID`. You provide a value for the `id` path parameter with the ID of the folder you want to browse to. In this example, the value "032A5E114A59D28267BDD8B6D9E58B22" is used, which is the ID of the "Business Roles" folder under "Shared Reports" that was returned by [GET /api/folders/preDefined/7](#browse-to-the-shared-reports-folder). If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of metadata objects under the folder. Sample Request @@ -538,7 +538,7 @@ When calling `GET /api/folders/{id}`, you can use the optional query parameters Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout](../../../images/swagger_POST_auth_logout.png) diff --git a/docs/common-workflows/analytics/object-discovery/search-for-objects.md b/docs/common-workflows/analytics/object-discovery/search-for-objects.md index cea0a6a56..e566c775d 100644 --- a/docs/common-workflows/analytics/object-discovery/search-for-objects.md +++ b/docs/common-workflows/analytics/object-discovery/search-for-objects.md @@ -8,7 +8,7 @@ description: The workflow for performing a quick search for specific objects inc You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-52d5eba3-f23a-4853-aa5b-6cc0c38f698d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -27,7 +27,7 @@ A detailed explanation of each step is provided below: Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing `X-MSTR-AuthToken`, the authorization token that will be used in subsequent requests. ![swagger_POST_auth_login](../../../images/swagger_POST_auth_login.png) @@ -87,7 +87,7 @@ The authorization token "`x-mstr-authtoken`" is returned in the response header. Endpoint: [GET /api/projects](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getProjects_1) -This endpoint allows the caller to get the list of projects with the MicroStrategy 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. +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. ![swagger_GET_projects](../../../images/swagger_GET_projects.png) @@ -258,7 +258,7 @@ Sample Response Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST server. In this example, you close the active user session by providing the authorization token, X-MSTR-AuthToken, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout](../../../images/swagger_POST_auth_logout.png) diff --git a/docs/common-workflows/analytics/project-management/manage-project-load-settings-on-server-startup.md b/docs/common-workflows/analytics/project-management/manage-project-load-settings-on-server-startup.md index 4bf6bb337..581fa28d9 100644 --- a/docs/common-workflows/analytics/project-management/manage-project-load-settings-on-server-startup.md +++ b/docs/common-workflows/analytics/project-management/manage-project-load-settings-on-server-startup.md @@ -9,7 +9,7 @@ description: A high-level workflow sample for loading project settings at the st You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-a5485e49-f3a6-4f14-bc79-b5c0d716f6db?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -40,7 +40,7 @@ A detailed explanation of each step is provided below. Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the user to authenticate with the MicroStrategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. +This endpoint allows the user to authenticate with the Strategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. ### Sample request @@ -76,7 +76,7 @@ pragma: no-cache x-mstr-authtoken: 6ksnde5dr2mij718ibouu8fgjj cache-control: no-cache, no-store, max-age=0, must-revalidate date: Tue22 Sept 2020 17:58:29 GMT -server: MicroStrategy +server: Strategy expires: 0 content-type: null ``` @@ -246,7 +246,7 @@ Response Code: 200 (OK) Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out the authenticated user from the MicroStrategy REST server. In this example, you close the active user session by providing the X-MSTR-AuthToken authorization token, which is generated by `POST /api/auth/login` during [login](#log-in). If the call is successful, the resulting HTTP response returns a HTTP status code of 204. +This endpoint allows the caller to log out the authenticated user from the Strategy REST server. In this example, you close the active user session by providing the X-MSTR-AuthToken authorization token, which is generated by `POST /api/auth/login` during [login](#log-in). If the call is successful, the resulting HTTP response returns a HTTP status code of 204. ### Sample request @@ -273,7 +273,7 @@ must-revalidate date: Tue22 Sep 2020 04:51:11 GMT expires: 0 pragma: no-cache -server: MicroStrategy +server: Strategy status: 204 ``` diff --git a/docs/common-workflows/analytics/project-management/manage-project-settings.md b/docs/common-workflows/analytics/project-management/manage-project-settings.md index 8fec46c09..e71a0f254 100644 --- a/docs/common-workflows/analytics/project-management/manage-project-settings.md +++ b/docs/common-workflows/analytics/project-management/manage-project-settings.md @@ -9,7 +9,7 @@ description: A high-level workflow sample for managing project settings is shown You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d30bab86-7c75-4b05-88d2-35ca2091e983?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -19,7 +19,7 @@ A high-level workflow sample for managing project settings is shown below. The s Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the user to authenticate with the MicroStrategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username and password. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. +This endpoint allows the user to authenticate with the Strategy REST Server. You can provide the information used to create the session in the body of the request. In this example, you can use standard authentication, so you need to provide the username and password. If the call is successful, the resulting response returns a status code of 204 and a response header containing X-MSTR-AuthToken. This authorization token is used by all subsequent requests. In the following example, standard authentication uses a username of administrator and a blank password. @@ -58,7 +58,7 @@ Response Code: 204 (Success: No Content) Endpoint: [GET /api/v2/projects/\{projectId}/settings/config](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getServerSettingProperties) -This endpoint allows the user to retrieve information on all project settings that are available in MicroStrategy REST API. The information includes the setting description, type, options, unit, minimum value, maximum value, and reboot rule. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows the user to retrieve information on all project settings that are available in Strategy REST API. The information includes the setting description, type, options, unit, minimum value, maximum value, and reboot rule. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). :::tip @@ -133,7 +133,7 @@ Response Code: 200 (Success: OK) Endpoint: [GET /api/v2/projects/\{projectId}/settings](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/getServerSettings_3) -This endpoint allows you to retrieve all project setting values that are available in MicroStrategy REST API. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows you to retrieve all project setting values that are available in Strategy REST API. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). :::tip @@ -285,7 +285,7 @@ Response Code: 200 (Success: OK) Endpoint: [PUT /api/v2/projects/\{projectId}/settings](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Projects/setAllServerSettings) -This endpoint allows you to access all of the setting values that are available in MicroStrategy REST API. In this endpoint, you must provide a complete list of project settings, which is the different from the `PATCH /api/v2/projects/{projectId}/settings` endpoint. You can find a list of project settings exposed in REST API via `GET /api/v2/projects/{projectId}/settings/config`. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). +This endpoint allows you to access all of the setting values that are available in Strategy REST API. In this endpoint, you must provide a complete list of project settings, which is the different from the `PATCH /api/v2/projects/{projectId}/settings` endpoint. You can find a list of project settings exposed in REST API via `GET /api/v2/projects/{projectId}/settings/config`. You must specify an authorization token in the request header, which can be obtained from `POST /api/auth/login` during [login](#log-in). :::tip @@ -396,7 +396,7 @@ Response Code: 200 (Success: OK) Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out the authenticated user from the MicroStrategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting response returns a status code of 204. +This endpoint allows the caller to log out the authenticated user from the Strategy REST server. In this example, you close the active user session by providing the `X-MSTR-AuthToken` authorization token, which is generated by `POST /api/auth/login`. If the call is successful, the resulting response returns a status code of 204. ### Sample request diff --git a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-applicable-advanced-properties.md b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-applicable-advanced-properties.md index f9ec6ebe4..5e512ea1c 100644 --- a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-applicable-advanced-properties.md +++ b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-applicable-advanced-properties.md @@ -10,7 +10,7 @@ description: Get applicable properties for a project. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-585d42d1-fbdc-4d1d-afbb-c4e872753709?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-with-advanced-properties.md b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-with-advanced-properties.md index 5cd605d24..ab356ae50 100644 --- a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-with-advanced-properties.md +++ b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/get-project-with-advanced-properties.md @@ -9,7 +9,7 @@ description: The workflow involves getting project definition along with its adv You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c3c3e563-696d-45b8-8f65-b02cb1cb394e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/project-advanced-properties-management.md b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/project-advanced-properties-management.md index c722ad592..9fa2899b9 100644 --- a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/project-advanced-properties-management.md +++ b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/project-advanced-properties-management.md @@ -9,7 +9,7 @@ description: You can use REST API requests to manage project. You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d30bab86-7c75-4b05-88d2-35ca2091e983?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/update-project-advanced-property.md b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/update-project-advanced-property.md index 7607805a2..d7c834252 100644 --- a/docs/common-workflows/analytics/project-management/project-advanced-properties-management/update-project-advanced-property.md +++ b/docs/common-workflows/analytics/project-management/project-advanced-properties-management/update-project-advanced-property.md @@ -9,7 +9,7 @@ description: The workflow involves modifying project's advanced properties value You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-804b24e1-dccb-48c1-bfde-0a132163e409?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/question-with-bot-routing-api/ask-question-to-bots-in-the-application.md b/docs/common-workflows/analytics/question-with-bot-routing-api/ask-question-to-bots-in-the-application.md index c38da92d0..2c3be7ffa 100644 --- a/docs/common-workflows/analytics/question-with-bot-routing-api/ask-question-to-bots-in-the-application.md +++ b/docs/common-workflows/analytics/question-with-bot-routing-api/ask-question-to-bots-in-the-application.md @@ -4,7 +4,7 @@ title: Ask a question with bot routing description: This workflow sample demonstrates how to ask a question with bot routing. --- - + Use this API to identify the most suitable bot to answer your question based on the application, content group, and specific bots. diff --git a/docs/common-workflows/analytics/question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md b/docs/common-workflows/analytics/question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md index 7100eda6f..c9eb76599 100644 --- a/docs/common-workflows/analytics/question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md +++ b/docs/common-workflows/analytics/question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md @@ -4,7 +4,7 @@ title: Ask suggested questions with bot routing description: This workflow sample demonstrates how to ask suggested questions with bot routing. --- - + This workflow sample demonstrates how to ask suggested questions with bot routing. diff --git a/docs/common-workflows/analytics/question-with-bot-routing-api/get-image-of-answer.md b/docs/common-workflows/analytics/question-with-bot-routing-api/get-image-of-answer.md index 4f2611c4a..4eef3efd0 100644 --- a/docs/common-workflows/analytics/question-with-bot-routing-api/get-image-of-answer.md +++ b/docs/common-workflows/analytics/question-with-bot-routing-api/get-image-of-answer.md @@ -4,7 +4,7 @@ title: Get an image of an answer related to a question with bot routing description: This workflow sample demonstrates how to get an image of an answer related to a question with bot routing. --- - + This workflow sample demonstrates how to get an image of an answer related to a question with bot routing. diff --git a/docs/common-workflows/analytics/question-with-bot-routing-api/get-question-from-bots-in-the-application.md b/docs/common-workflows/analytics/question-with-bot-routing-api/get-question-from-bots-in-the-application.md index 8e5418c6b..fd7a25d92 100644 --- a/docs/common-workflows/analytics/question-with-bot-routing-api/get-question-from-bots-in-the-application.md +++ b/docs/common-workflows/analytics/question-with-bot-routing-api/get-question-from-bots-in-the-application.md @@ -4,7 +4,7 @@ title: Get a question with bot routing description: This workflow sample demonstrates how to get a question with bot routing. --- - + This workflow sample demonstrates how to get a question with bot routing. diff --git a/docs/common-workflows/analytics/question-with-bot-routing-api/question-api.md b/docs/common-workflows/analytics/question-with-bot-routing-api/question-api.md index f82316690..1508c030c 100644 --- a/docs/common-workflows/analytics/question-with-bot-routing-api/question-api.md +++ b/docs/common-workflows/analytics/question-with-bot-routing-api/question-api.md @@ -3,7 +3,7 @@ title: Question with Bot Routing APIs description: This page contains a summary of REST APIs for the "questions" endpoint. You can use REST API requests to ask question with bot routing. --- - + With our newly added question with bot routing APIs, you can inquire all bots within the entire application without the need to manually identify the appropriate bot. The API automatically determines the most suitable bot to address your questions. Additionally, you have the option to specify the search scope using content groups and bot IDs for more accurate responses. diff --git a/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md b/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md index c0d873fe9..1185fe402 100644 --- a/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md +++ b/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md @@ -1,20 +1,20 @@ --- title: Retrieve data from the Intelligence Server using the JSON Data API -description: You can use the Reports API, the Cubes API and the Dashboards API to retrieve definitions and data from the Intelligence Server. Together, they are often referred to as the JSON Data API. They are part of the MicroStrategy REST Server, which is shipped inside the "MicroStrategyLibrary.war" web application. +description: You can use the Reports API, the Cubes API and the Dashboards API to retrieve definitions and data from the Intelligence Server. Together, they are often referred to as the JSON Data API. They are part of the Strategy REST Server, which is shipped inside the "MicroStrategyLibrary.war" web application. --- :::tip You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7b08f07c-89d2-4c61-8bc1-83cee2eb2eaf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -You can use the Reports API, the Cubes API and the Dashboards API to retrieve definitions and data from the Intelligence Server. Together, they are often referred to as the JSON Data API. They are part of the MicroStrategy REST Server, which is shipped inside the `MicroStrategyLibrary.war` web application. +You can use the Reports API, the Cubes API and the Dashboards API to retrieve definitions and data from the Intelligence Server. Together, they are often referred to as the JSON Data API. They are part of the Strategy REST Server, which is shipped inside the `MicroStrategyLibrary.war` web application. :::tip -Prior to MicroStrategy 10.10, there was a standalone server called the JSON Data API Server, which was deployed as an executable jar file. This standalone server has been deprecated. +Prior to Strategy 10.10, there was a standalone server called the JSON Data API Server, which was deployed as an executable jar file. This standalone server has been deprecated. ::: diff --git a/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/workflow-retrieve-data-from-the-intelligence-server.md b/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/workflow-retrieve-data-from-the-intelligence-server.md index d2986df7e..8fcdcdba5 100644 --- a/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/workflow-retrieve-data-from-the-intelligence-server.md +++ b/docs/common-workflows/analytics/retrieve-data-from-the-intelligence-server/workflow-retrieve-data-from-the-intelligence-server.md @@ -8,7 +8,7 @@ description: You can use REST APIs to retrieve both the definition and data for You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-84db2127-16e8-4fd2-909f-b5990516f889?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -36,7 +36,7 @@ To make it easy for you to try out this workflow in your environment, we have pr Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin) -This endpoint allows the caller to authenticate with the MicroStrategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used in subsequent requests. +This endpoint allows the caller to authenticate with the Strategy REST Server. You provide the information used to create the session in the body of the request. In this example, you use standard authentication so you need to provide username, password, and loginMode (which specifies the authentication mode to use). If you omit an optional field, the REST Server uses the default value. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a response header containing X-MSTR-AuthToken, the authorization token that will be used in subsequent requests. ![swagger_POST_auth_login](../../../images/swagger_POST_auth_login.png) @@ -106,7 +106,7 @@ A detailed explanation of how to retrieve the definition of a report, cube, or d Endpoint: [GET /api/reports/\{reportId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/getDefinition_1) -This endpoint returns the definition for a specific report in a specific project from the MicroStrategy Intelligence Server. The body of the response contains the name and ID for the report and all the attributes and metrics included in the report. +This endpoint returns the definition for a specific report in a specific project from the Intelligence Server. The body of the response contains the name and ID for the report and all the attributes and metrics included in the report. - Identify the project by passing the project ID in the request header. - Identify the report by passing the report ID in the path of the request. @@ -217,7 +217,7 @@ Response Code: 204 (Success: No Content) Endpoint: [GET /api/cubes/\{cubeId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Cubes/getDefinition) -This endpoint returns the definition for a specific cube in a specific project from the MicroStrategy Intelligence Server. The body of the response contains the name and ID for the cube and all the attributes and metrics included in the cube definition. +This endpoint returns the definition for a specific cube in a specific project from the Intelligence Server. The body of the response contains the name and ID for the cube and all the attributes and metrics included in the cube definition. - Identify the project by passing the project ID in the request header. - Identify the cube by passing the cube ID in the path of the request. @@ -311,7 +311,7 @@ Response Code: 204 (Success: No Content) Endpoint: [GET /api/dossiers/\{dossierId}/definition](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Dossiers%20and%20Documents/getVisualizationList) -This endpoint returns the hierarchy for a specific dashboard in a specific project from the MicroStrategy Intelligence Server. The body of the response contains the chapters, pages, and visualizations in the dashboard. +This endpoint returns the hierarchy for a specific dashboard in a specific project from the Intelligence Server. The body of the response contains the chapters, pages, and visualizations in the dashboard. - Identify the project by passing the project ID in the request header. - Identify the dashboard by passing the dashboard ID in the path of the request. @@ -394,7 +394,7 @@ When you create a report or cube instance using a POST request, the instance ID Endpoint: [POST /api/reports/\{reportId}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/createReportInstance) -This endpoint creates a new instance of a specific report in a specific project on the MicroStrategy Intelligence Server and returns the results if processing has finished. You can refine the amount of data that is returned using offset and limit parameters in the request and specifying filtering parameters in the body of the request. You can check whether processing has finished by checking the value of status in the body of the request. +This endpoint creates a new instance of a specific report in a specific project on the Intelligence Server and returns the results if processing has finished. You can refine the amount of data that is returned using offset and limit parameters in the request and specifying filtering parameters in the body of the request. You can check whether processing has finished by checking the value of status in the body of the request. - Identify the project by passing the project ID in the request header. - Identify the report by passing the report ID in the path of the request. @@ -661,7 +661,7 @@ Response Code: 204 (Success: OK) Endpoint: [POST /api/cubes/\{cubeId}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Cubes/createCubeInstance) -This endpoint creates a new instance of a specific cube in a specific project on the MicroStrategy Intelligence Server and returns the results if processing has finished. You can refine the amount of data that is returned using offset and limit parameters in the request and specifying filtering parameters in the body of the request. You can check whether processing has finished by checking the value of status in the body of the request. +This endpoint creates a new instance of a specific cube in a specific project on the Intelligence Server and returns the results if processing has finished. You can refine the amount of data that is returned using offset and limit parameters in the request and specifying filtering parameters in the body of the request. You can check whether processing has finished by checking the value of status in the body of the request. - Identify the project by passing the project ID in the request header. - Identify the cube by passing the cube ID in the path of the request. @@ -859,7 +859,7 @@ Response Code: 204 (Success: OK) Endpoint: [POST /api/dossiers/\{dossierId}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Dossiers%20and%20Documents/createDossierInstance_2) -This endpoint allows the caller to create a new instance of a specific dashboard in a specific project from the MicroStrategy Intelligence Server. The request body contains linking and bookmark information for the dashboard. The body of the response contains the instance ID for the dashboard and the status. +This endpoint allows the caller to create a new instance of a specific dashboard in a specific project from the Intelligence Server. The request body contains linking and bookmark information for the dashboard. The body of the response contains the instance ID for the dashboard and the status. In the sample that was provided, you create an instance of the dashboard “Dossier for Advanced sort” in the “MicroStrategy Tutorial” project. This dashboard has two attributes and two metrics. @@ -906,7 +906,7 @@ For dashboards, you can retrieve only data for a specific visualization in the d Endpoint: [GET /api/reports/\{reportId}/instances/\{instanceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/executeReport) -This endpoint gets the data for a specific report instance in a specific project from the MicroStrategy Intelligence Server. The results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. +This endpoint gets the data for a specific report instance in a specific project from the Intelligence Server. The results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. - Identify the project by passing the project ID in the request header. - Identify the report instance by passing the report ID and the report instance ID in the path of the request. @@ -1045,7 +1045,7 @@ Response Code: 204 (Success: OK) Endpoint: [GET /api/cubes/\{cubeId}/instances/\{instanceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Cubes/getReport) -This endpoint gets the data for a specific cube instance in a specific project from the MicroStrategy Intelligence Server. The response body contains the cube data; the results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. +This endpoint gets the data for a specific cube instance in a specific project from the Intelligence Server. The response body contains the cube data; the results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. - Identify the project by passing the project ID in the request header. - Identify the cube instance by passing the cube ID and the cube instance ID in the path of the request. In the sample that was provided, you get the data for an instance of the cube “Advanced sort” in the “MicroStrategy Tutorial” project. This cube has two attributes and two metrics. @@ -1233,7 +1233,7 @@ Response Code: 204 (Success: OK) ### Get dashboard data (specific visualization) -This endpoint gets dashboard data by visualization for a specific dashboard instance in a specific project from the MicroStrategy Intelligence Server. The response body contains the cube data; the results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. +This endpoint gets dashboard data by visualization for a specific dashboard instance in a specific project from the Intelligence Server. The response body contains the cube data; the results are determined by the conditions you applied when you created the instance. You can refine the amount of data that is returned using offset and limit parameters in the request. - Identify the project by passing the project ID in the request header. - Identify the dashboard instance by passing the dashboard ID and the dashboard instance ID in the path of the request. @@ -1390,7 +1390,7 @@ Response Code: 204 (Success: OK) Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout) -This endpoint allows the caller to log out for the authenticated user with the MicroStrategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. +This endpoint allows the caller to log out for the authenticated user with the Strategy REST Server. In this example, you close the active user session by providing the authorization token, `X-MSTR-AuthToken`, generated during login. If the call is successful, the resulting HTTP response returns an HTTP status code 204. ![swagger_POST_auth_logout](../../../images/swagger_POST_auth_logout.png) diff --git a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-dataset-sql.md b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-dataset-sql.md index 0c4b2bf1e..eb09b8e2a 100644 --- a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-dataset-sql.md +++ b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-dataset-sql.md @@ -10,7 +10,7 @@ description: You can retrieve the SQL statements of all datasets in a document o You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5d5e523d-6a02-45a1-9537-bc0d37f9c10c). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-grid-or-graph-query-details.md b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-grid-or-graph-query-details.md index b4e092bfd..ca263b190 100644 --- a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-grid-or-graph-query-details.md +++ b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-grid-or-graph-query-details.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve the query details You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b0ee6146-bd68-4aae-adfb-ef186d9e26ee?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-report-or-card-sql.md b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-report-or-card-sql.md index 0ecbc76b3..ba6764ba7 100644 --- a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-report-or-card-sql.md +++ b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-report-or-card-sql.md @@ -10,7 +10,7 @@ description: You can retrieve a report or card instance’s SQL statement. In th You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c962ed90-f4e6-4934-8b65-4480bf45746e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-sql-statements-and-query-details.md b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-sql-statements-and-query-details.md index f63272e49..79b39f938 100644 --- a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-sql-statements-and-query-details.md +++ b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-sql-statements-and-query-details.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve SQL statements and query You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-fae624de-293e-4c55-9a26-a9ff10d17b3f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-visualization-query-details.md b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-visualization-query-details.md index cfc52ef70..dc9a37c54 100644 --- a/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-visualization-query-details.md +++ b/docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-visualization-query-details.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve the query details You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5d5e523d-6a02-45a1-9537-bc0d37f9c10c). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/sort-data.md b/docs/common-workflows/analytics/sort-data.md index fd1061cf5..aeb2fbc4d 100644 --- a/docs/common-workflows/analytics/sort-data.md +++ b/docs/common-workflows/analytics/sort-data.md @@ -7,7 +7,7 @@ description: When you use a REST API request to create a cube or report, you can You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-f01c3304-fd56-48bf-a13a-cae926afb2a5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -69,7 +69,7 @@ In MicroStrategy Developer, you can set a default attribute sort property, which - If you are creating a report instance that includes an attribute whose form has the default attribute sort property set and it is one of the multiple sorting criteria that is used in the report, you must specify the sort in the hierarchical order where it should be applied. You provide the ID of the attribute. You do not have to specify the attribute form to use or the sort order because they are part of the default attribute sort property. -You cannot set the default attribute sort property in MicroStrategy Web. It can only be set in MicroStrategy Developer. +You cannot set the default attribute sort property in Web. It can only be set in MicroStrategy Developer. ### Sample body parameter diff --git a/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-question.md b/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-question.md index 3954c4616..66fe137c1 100644 --- a/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-question.md +++ b/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-question.md @@ -4,11 +4,11 @@ title: Ask the bot instance a question description: This workflow sample demonstrates how to ask the bot instance a question. --- - + :::caution -This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Ask Question to Bots in the Application API](../question-with-bot-routing-api/ask-question-to-bots-in-the-application) for bot-related workflows. +This API is planned for future retirement. Therefore, Strategy recommends that you transition to the [Ask Question to Bots in the Application API](../question-with-bot-routing-api/ask-question-to-bots-in-the-application) for bot-related workflows. Using Ask Question to Bots in the Application API: diff --git a/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-suggested-question.md b/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-suggested-question.md index 5fbf2d433..904cf5553 100644 --- a/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-suggested-question.md +++ b/docs/common-workflows/analytics/use-bot-api/ask-bot-instance-suggested-question.md @@ -4,11 +4,11 @@ title: Ask a bot instance for suggested questions description: This workflow sample demonstrates how to ask a bot instance for suggested questions --- - + :::caution -This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Ask Suggested Question to Bots in the Application API](../question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md) for retrieving suggested questions from bots. +This API is planned for future retirement. Therefore, Strategy recommends that you transition to the [Ask Suggested Question to Bots in the Application API](../question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md) for retrieving suggested questions from bots. Using Ask Suggested Question to Bots in the Application API: diff --git a/docs/common-workflows/analytics/use-bot-api/create-a-bot-instance.md b/docs/common-workflows/analytics/use-bot-api/create-a-bot-instance.md index d3d26426e..aa69f6fb6 100644 --- a/docs/common-workflows/analytics/use-bot-api/create-a-bot-instance.md +++ b/docs/common-workflows/analytics/use-bot-api/create-a-bot-instance.md @@ -4,11 +4,11 @@ title: Create a bot instance description: This workflow sample demonstrates how to create a bot instance --- - + :::caution -This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows. +This API is planned for future retirement. Therefore, Strategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows. Using the Question with Bot Routing API: diff --git a/docs/common-workflows/analytics/use-bot-api/delete-a-bot-instance.md b/docs/common-workflows/analytics/use-bot-api/delete-a-bot-instance.md index 18cc6dc95..fc771a596 100644 --- a/docs/common-workflows/analytics/use-bot-api/delete-a-bot-instance.md +++ b/docs/common-workflows/analytics/use-bot-api/delete-a-bot-instance.md @@ -4,11 +4,11 @@ title: Delete a bot instance description: This workflow sample demonstrates how to delete a bot instance --- - + :::caution -This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows. +This API is planned for future retirement. Therefore, Strategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows. Using the Question with Bot Routing API: diff --git a/docs/common-workflows/analytics/use-bot-api/get-a-bot-question.md b/docs/common-workflows/analytics/use-bot-api/get-a-bot-question.md index af4d3487b..e9e45a7a2 100644 --- a/docs/common-workflows/analytics/use-bot-api/get-a-bot-question.md +++ b/docs/common-workflows/analytics/use-bot-api/get-a-bot-question.md @@ -4,11 +4,11 @@ title: Get a bot's question description: This workflow sample demonstrates how to get a chat bot's question. --- - + :::caution -This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Get Question from Bots in the Application API](../question-with-bot-routing-api/get-question-from-bots-in-the-application.md) for retrieving bot responses. +This API is planned for future retirement. Therefore, Strategy recommends that you transition to the [Get Question from Bots in the Application API](../question-with-bot-routing-api/get-question-from-bots-in-the-application.md) for retrieving bot responses. The Get Question from Bots in the Application API can be used in combination with the [Ask Question to Bots in the Application API](../question-with-bot-routing-api/ask-question-to-bots-in-the-application.md) to ask questions and retrieve answers from bots. This streamlined workflow removes manual bot instance management and provides flexible bot routing. diff --git a/docs/common-workflows/analytics/use-bot-api/get-bot-configuration.md b/docs/common-workflows/analytics/use-bot-api/get-bot-configuration.md index 72baa0aa9..fd33b9845 100644 --- a/docs/common-workflows/analytics/use-bot-api/get-bot-configuration.md +++ b/docs/common-workflows/analytics/use-bot-api/get-bot-configuration.md @@ -4,7 +4,7 @@ title: Get a chat bot's configuration description: This workflow sample demonstrates how to get a chat bot's configuration. --- - + This workflow sample demonstrates how to get a chat bot's configuration. diff --git a/docs/common-workflows/analytics/use-bot-api/get-bot-question-list.md b/docs/common-workflows/analytics/use-bot-api/get-bot-question-list.md index 121f8839b..1582e043b 100644 --- a/docs/common-workflows/analytics/use-bot-api/get-bot-question-list.md +++ b/docs/common-workflows/analytics/use-bot-api/get-bot-question-list.md @@ -4,7 +4,7 @@ title: Get a bot's question list description: This workflow sample demonstrates how to get a chat bot's question list. --- - + This workflow sample demonstrates how to get a chat bot's question list. diff --git a/docs/common-workflows/analytics/use-bot-api/use-bot-api.md b/docs/common-workflows/analytics/use-bot-api/use-bot-api.md index a210f2b3f..37929e1cf 100644 --- a/docs/common-workflows/analytics/use-bot-api/use-bot-api.md +++ b/docs/common-workflows/analytics/use-bot-api/use-bot-api.md @@ -3,11 +3,11 @@ title: Bot APIs description: This page contains a summary of REST APIs for the "bots" endpoint. You can use REST API requests to consume the chat bots. --- - + :::caution -The following Bot APIs are planned for future retirement. Therefore, MicroStrategy recommends that you use the [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) instead: +The following Bot APIs are planned for future retirement. Therefore, Strategy recommends that you use the [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) instead: - [Create a bot instance.](./create-a-bot-instance.md) - [Ask for suggested questions](./ask-bot-instance-suggested-question.md) @@ -23,7 +23,7 @@ Reason: ::: -For users interested in creating a custom chatbot experience utilizing the capabilities of MicroStrategy AI, a suite of bot-related APIs is available. These APIs are designed to facilitate seamless integration of MicroStrategy AI into nearly any application. By leveraging these tools, users can enhance their applications with advanced AI features quickly and efficiently. For further details on how to use these APIs, please refer to the following sections of this manual. +For users interested in creating a custom chatbot experience utilizing the capabilities of Strategy AI, a suite of bot-related APIs is available. These APIs are designed to facilitate seamless integration of Strategy AI into nearly any application. By leveraging these tools, users can enhance their applications with advanced AI features quickly and efficiently. For further details on how to use these APIs, please refer to the following sections of this manual. - [Get a bot's configuration](./get-bot-configuration.md) - [Get a bot question list.](./get-bot-question-list.md) diff --git a/docs/common-workflows/analytics/use-prompts-objects/answer-prompts.md b/docs/common-workflows/analytics/use-prompts-objects/answer-prompts.md index 7f206327b..a510e08d5 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/answer-prompts.md +++ b/docs/common-workflows/analytics/use-prompts-objects/answer-prompts.md @@ -122,7 +122,7 @@ This endpoint allows the caller to export the document to a PDF file (in the for You can use REST APIs to provide prompt answers for three types of prompts applied to dashboards, documents, and reports. For these three prompt types, you can provide specific answers to prompts, choose to [use default prompt answers](#use-default-prompt-answers), or [close optional prompts without providing answers](#close-prompts-without-answers). You can also reset the status so that the dashboard, document, or report will be re-prompted the next time it is run. -The prompts supported in the MicroStrategy platform are defined in [EnumDSSXMLPromptType.](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html) +The prompts supported in the Strategy platform are defined in [EnumDSSXMLPromptType.](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html) You use the following REST API endpoints to answer a prompt applied to a dashboard, document, or report: diff --git a/docs/common-workflows/analytics/use-prompts-objects/get-prompt-information/get-prompt-information.md b/docs/common-workflows/analytics/use-prompts-objects/get-prompt-information/get-prompt-information.md index 205f9f0cd..743cab8e6 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/get-prompt-information/get-prompt-information.md +++ b/docs/common-workflows/analytics/use-prompts-objects/get-prompt-information/get-prompt-information.md @@ -6,7 +6,7 @@ title: Get prompt information You can use REST APIs to get information about five supported types of prompts applied to dashboards, documents, and reports. You can get a list of the prompts that have been applied to a dashboard, document or report, together with the definition of each prompt. -The prompts supported in the MicroStrategy platform are defined in EnumDSSXMLPromptType. +The prompts supported in the Strategy platform are defined in EnumDSSXMLPromptType. You can use REST APIs to return information about the following prompts: @@ -20,4 +20,4 @@ You can use REST APIs to return information about the following prompts: You can identify prompts with the prompt key, prompt ID, or prompt name. If more than one identifier is provided, the logic for identifying the prompt will follow this order: key, ID, name. The prompt key is used first if is available because the key is the only unique value. Since the same prompt can be applied more than once to a dataset, the ID and the name might not be unique. Despite this possibility, the name is often the most convenient way to identify a prompt because of its descriptive nature. -To help you get started using REST APIs to build feature-rich applications that leverage MicroStrategy's prompt capabilities, we have provided a [workflow sample for getting a prompt definition](workflow-get-prompt-information.md). +To help you get started using REST APIs to build feature-rich applications that leverage Strategy's prompt capabilities, we have provided a [workflow sample for getting a prompt definition](workflow-get-prompt-information.md). diff --git a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-element-prompts.md b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-element-prompts.md index 4ba83696c..7bb0089b8 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-element-prompts.md +++ b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-element-prompts.md @@ -9,7 +9,7 @@ description: The attribute element prompt is one of the most commonly used promp You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5eeb2bce-6951-41c6-aba0-97565505eaa5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-qualification-prompts.md b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-qualification-prompts.md index 0974acd69..ac87a4424 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-qualification-prompts.md +++ b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/attribute-qualification-prompts.md @@ -9,7 +9,7 @@ description: The attribute qualification prompt is a restrictive type prompt tha You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-6fe150ae-169d-441e-8d1d-311c78db3663?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/object-prompts.md b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/object-prompts.md index dd997d8b7..0262a7350 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/object-prompts.md +++ b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/object-prompts.md @@ -9,7 +9,7 @@ description: An object prompt allows the caller to supply a list of objects, suc You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-763d27e2-3d03-47ab-9e7b-6b3b4db736b4?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/prompt-types.md b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/prompt-types.md index c8245da27..c4774c232 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/prompt-types.md +++ b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/prompt-types.md @@ -1,11 +1,11 @@ --- title: Prompt types -description: There are several different prompt types in the MicroStrategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in EnumDSSXMLPromptType. +description: There are several different prompt types in the Strategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in EnumDSSXMLPromptType. --- -There are several different prompt types in the MicroStrategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in [EnumDSSXMLPromptType](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html). +There are several different prompt types in the Strategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in [EnumDSSXMLPromptType](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html). For the following prompt types, you can perform prompt actions supported by REST APIs. This includes getting prompt definitions, providing specific prompt answers, specifying that default prompt answers should be used, closing prompts without supplying answers for optional prompts, or resetting prompts. diff --git a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/value-prompts.md b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/value-prompts.md index ca90d1e1a..6ab7ef5af 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/prompt-types/value-prompts.md +++ b/docs/common-workflows/analytics/use-prompts-objects/prompt-types/value-prompts.md @@ -9,7 +9,7 @@ description: A value prompt allows the results to be filtered based on a specifi You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-30ed13b7-880a-4b38-bdf7-363d868bf70c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/analytics/use-prompts-objects/use-prompts-objects.md b/docs/common-workflows/analytics/use-prompts-objects/use-prompts-objects.md index 8a99caf9e..6b3dd6fc8 100644 --- a/docs/common-workflows/analytics/use-prompts-objects/use-prompts-objects.md +++ b/docs/common-workflows/analytics/use-prompts-objects/use-prompts-objects.md @@ -1,6 +1,6 @@ --- title: Use prompts objects -description: Prompts are a platform capability of MicroStrategy that refine the data displayed in reports, documents, and dashboards. The system poses the prompt as a question during execution of a dashboard, document, or report, and the answer determines the data that is returned. A prompt is similar to a filter; both are applied at runtime and customize the results of data that is returned from a data source. The actual prompt definition cannot be changed at runtime, but the answers to the prompt can be changed dynamically. Together with filtering, prompts allow you to build feature-rich applications by leveraging core MicroStrategy platform capabilities. +description: Prompts are a platform capability of Strategy that refine the data displayed in reports, documents, and dashboards. The system poses the prompt as a question during execution of a dashboard, document, or report, and the answer determines the data that is returned. A prompt is similar to a filter; both are applied at runtime and customize the results of data that is returned from a data source. The actual prompt definition cannot be changed at runtime, but the answers to the prompt can be changed dynamically. Together with filtering, prompts allow you to build feature-rich applications by leveraging core Strategy platform capabilities. --- @@ -9,11 +9,11 @@ description: Prompts are a platform capability of MicroStrategy that refine the You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c22a4c1c-85a3-4f3b-8b34-ffeebd05e795?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -Prompts are a platform capability of MicroStrategy that refine the data displayed in reports, documents, and dashboards. The system poses the prompt as a question during execution of a dashboard, document, or report, and the answer determines the data that is returned. A prompt is similar to a [filter](../filter-data/filter-data.md); both are applied at runtime and customize the results of data that is returned from a data source. The actual prompt definition cannot be changed at runtime, but the answers to the prompt can be changed dynamically. Together with filtering, prompts allow you to build feature-rich applications by leveraging core MicroStrategy platform capabilities. +Prompts are a platform capability of Strategy that refine the data displayed in reports, documents, and dashboards. The system poses the prompt as a question during execution of a dashboard, document, or report, and the answer determines the data that is returned. A prompt is similar to a [filter](../filter-data/filter-data.md); both are applied at runtime and customize the results of data that is returned from a data source. The actual prompt definition cannot be changed at runtime, but the answers to the prompt can be changed dynamically. Together with filtering, prompts allow you to build feature-rich applications by leveraging core Strategy platform capabilities. Prompts are applied directly to reports and stored with the dataset for the report. Prompts are applied to dashboards and documents more indirectly. When you use a prompted report as a dataset for a dashboard or document, the prompts stored with the dataset are automatically applied to the document or dashboard. @@ -26,6 +26,6 @@ You can use REST APIs to integrate prompts into your application workflow. You c :::tip -For general information about prompts, see the [MicroStrategy product help](https://doc-archives.microstrategy.com/producthelp/10.5/basicreporting/webhelp/lang_1033/content/basicreporting/Asking_for_user_input__Prompts.htm#brcreatingquery_2014045409_1076748). For information on using prompts in data displayed on a mobile device, see the MicroStrategy Mobile Design and Administration Guide. +For general information about prompts, see the [Strategy product help](https://doc-archives.microstrategy.com/producthelp/10.5/basicreporting/webhelp/lang_1033/content/basicreporting/Asking_for_user_input__Prompts.htm#brcreatingquery_2014045409_1076748). For information on using prompts in data displayed on a mobile device, see the Mobile Design and Administration Guide. ::: diff --git a/docs/common-workflows/common-workflows.md b/docs/common-workflows/common-workflows.md index 1a0be6544..aafa45479 100644 --- a/docs/common-workflows/common-workflows.md +++ b/docs/common-workflows/common-workflows.md @@ -1,19 +1,19 @@ --- title: Common workflows -description: The first step in a typical MicroStrategy REST API workflow is authenticating the user and creating a session on the Intelligence Server. When authentication is successful, an authorization token and a session cookie are returned in the response header. The authorization token and the cookie must be provided in every subsequent request. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. +description: The first step in a typical Strategy REST API workflow is authenticating the user and creating a session on the Intelligence Server. When authentication is successful, an authorization token and a session cookie are returned in the response header. The authorization token and the cookie must be provided in every subsequent request. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. --- :::tip You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/collection/16131298-9ba9a108-18ee-438e-8f4f-df058f265f1b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -The first step in a typical MicroStrategy REST API workflow is authenticating the user and creating a session on the Intelligence Server. When authentication is successful, an authorization token and a session cookie are returned in the response header. The authorization token and the cookie must be provided in every subsequent request. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. +The first step in a typical Strategy REST API workflow is authenticating the user and creating a session on the Intelligence Server. When authentication is successful, an authorization token and a session cookie are returned in the response header. The authorization token and the cookie must be provided in every subsequent request. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. -REST API request sequences with descriptions and code samples have been provided for the following common MicroStrategy REST API workflows. +REST API request sequences with descriptions and code samples have been provided for the following common Strategy REST API workflows. Our workflows are arranged in 3 sections: diff --git a/docs/common-workflows/modeling/common-object-management/change-ownership.md b/docs/common-workflows/modeling/common-object-management/change-ownership.md index 652abbc57..85bb19c45 100644 --- a/docs/common-workflows/modeling/common-object-management/change-ownership.md +++ b/docs/common-workflows/modeling/common-object-management/change-ownership.md @@ -10,7 +10,7 @@ description: Change the owner of an object. You can try this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-dc9e5266-db8c-4842-9c44-16b5dd614f47). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-object-acl.md b/docs/common-workflows/modeling/common-object-management/manage-object-acl.md index 8a81ff7e2..a3e7a60b3 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-object-acl.md +++ b/docs/common-workflows/modeling/common-object-management/manage-object-acl.md @@ -7,7 +7,7 @@ description: An Access Control List (ACL) is a set of permissions on objects so You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-638a5542-2f37-4df9-be9a-972a11055db5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-object-translations/manage-object-translations.md b/docs/common-workflows/modeling/common-object-management/manage-object-translations/manage-object-translations.md index 14c366b87..e54aeae98 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-object-translations/manage-object-translations.md +++ b/docs/common-workflows/modeling/common-object-management/manage-object-translations/manage-object-translations.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, remove, add and update You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d83e2ec3-5b5b-4fb3-8c30-4338db4c0f51?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/lock-the-schema.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/lock-the-schema.md index 1b2c579bf..e0f18467d 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/lock-the-schema.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/lock-the-schema.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to lock the schema. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c3ac84b3-bce5-495d-94d5-941305fc1def?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/manage-the-schema.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/manage-the-schema.md index 34dec39e7..723056287 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/manage-the-schema.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/manage-the-schema.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve the schema lock, lock and You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-8f48dce2-e826-4f45-98fb-c3ceed64b670?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-asynchronously.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-asynchronously.md index 15bd0cf7b..af1c02090 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-asynchronously.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-asynchronously.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to reload (update) the schema You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-edc29ca6-4db8-4a8b-988e-11d9583ed993?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-synchronously.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-synchronously.md index eb320d5cd..40fe355c1 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-synchronously.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/reload-the-schema-synchronously.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to reload (update) the schema You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b58bf430-4495-4904-8a1c-929a126be1f0?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/retrieve-the-schema-lock.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/retrieve-the-schema-lock.md index 884e7d5a1..aaca10fda 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/retrieve-the-schema-lock.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/retrieve-the-schema-lock.md @@ -51,7 +51,7 @@ Sample Response Body: { "lockType": "exclusive_constituent", "dateCreated": "2021-03-24T01:39:04", - "comment": "MicroStrategy Modeling ServiceMicroStrategy Modeling ServiceE723124CEE0E481FBC8AC539D89C6A67", + "comment": "Strategy Modeling ServiceStrategy Modeling ServiceE723124CEE0E481FBC8AC539D89C6A67", "machineName": "env-247993laiouse1", "ownerName": "MSTR User", "ownerId": "7FC05A65473CE2FD845CE6A1D3F13233" diff --git a/docs/common-workflows/modeling/common-object-management/manage-the-schema/unlock-the-schema.md b/docs/common-workflows/modeling/common-object-management/manage-the-schema/unlock-the-schema.md index c85ec43b3..671cfda9d 100644 --- a/docs/common-workflows/modeling/common-object-management/manage-the-schema/unlock-the-schema.md +++ b/docs/common-workflows/modeling/common-object-management/manage-the-schema/unlock-the-schema.md @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to unlock the schema. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c3ac84b3-bce5-495d-94d5-941305fc1def?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-objects/create-an-attribute-object.md b/docs/common-workflows/modeling/manage-attribute-objects/create-an-attribute-object.md index 273303bb4..2d35af4b7 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/create-an-attribute-object.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/create-an-attribute-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create an attribute object You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-fc30f1d1-7f8e-4bbb-8f27-7b66c67e6db6?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -44,7 +44,7 @@ To create an attribute, in the request body, "forms" contains the detailed defin - "expression": Must be in either "tree" or "tokens" format. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). - "tables": A list of tables that the "expression" applies to. Warehouse partition base tables and metadata partition mapping tables are not allowed here. diff --git a/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-applicable-advanced-properties.md b/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-applicable-advanced-properties.md index 5ab75ac8d..b8340104c 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-applicable-advanced-properties.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-applicable-advanced-properties.md @@ -10,7 +10,7 @@ description: Get applicable properties for an attribute. You can try this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-df3dd3da-b225-4637-93dd-c41579ce1074?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-with-advanced-properties.md b/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-with-advanced-properties.md index a165ba4a4..2c6b60d93 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-with-advanced-properties.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/get-attribute-with-advanced-properties.md @@ -10,7 +10,7 @@ description: Get attribute definition and advanced properties. You can try this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-df3dd3da-b225-4637-93dd-c41579ce1074?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-objects/manage-attribute-objects.md b/docs/common-workflows/modeling/manage-attribute-objects/manage-attribute-objects.md index f0bfe53c0..0dd040494 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/manage-attribute-objects.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/manage-attribute-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create and update attrib You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-df3dd3da-b225-4637-93dd-c41579ce1074?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition-within-a-changeset.md index 33aaad76d..94f6cad4a 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve an attribute's de You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5038d0d2-f112-47fc-b602-e01c58fd8aec?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition.md b/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition.md index b9e58541a..0c5757354 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/retrieve-an-attributes-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve the definition of You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-9a89680f-6695-47d0-b939-4cb8dee003dd?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -221,7 +221,7 @@ Expressions are presented in the following formats: - "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. - "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). If `showExpressionAs` is omitted, the expression is returned in "text" format. diff --git a/docs/common-workflows/modeling/manage-attribute-objects/update-an-attributes-definition.md b/docs/common-workflows/modeling/manage-attribute-objects/update-an-attributes-definition.md index 9a05fd55b..2a90cf20b 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/update-an-attributes-definition.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/update-an-attributes-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an attribute's defi You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-0c9c449c-883d-4112-af6d-f14656ed5d30?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -46,7 +46,7 @@ To update an attribute, in the request body, "forms" contains the detailed defin - "expression": Must be in either "tree" or "tokens" format. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say an attribute form expression is "Year - 10". When the attribute form expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Year_ID", Year_column_ID), ("-", Minus_ID), ("10", Constant). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say an attribute form expression is "Year - 10". When the attribute form expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Year_ID", Year_column_ID), ("-", Minus_ID), ("10", Constant). - "tables": A list of tables that the "expression" applies to. Warehouse partition base tables and metadata partition mapping tables are not allowed here. diff --git a/docs/common-workflows/modeling/manage-attribute-objects/update-attribute-advanced-property.md b/docs/common-workflows/modeling/manage-attribute-objects/update-attribute-advanced-property.md index a994cf817..8dcd01313 100644 --- a/docs/common-workflows/modeling/manage-attribute-objects/update-attribute-advanced-property.md +++ b/docs/common-workflows/modeling/manage-attribute-objects/update-attribute-advanced-property.md @@ -9,7 +9,7 @@ description: The workflow involves modifying attribute's advanced properties val You can try these workflows at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-df3dd3da-b225-4637-93dd-c41579ce1074?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-relationships/manage-attribute-relationships.md b/docs/common-workflows/modeling/manage-attribute-relationships/manage-attribute-relationships.md index 2cfba8a0a..59c4c5952 100644 --- a/docs/common-workflows/modeling/manage-attribute-relationships/manage-attribute-relationships.md +++ b/docs/common-workflows/modeling/manage-attribute-relationships/manage-attribute-relationships.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create and update an att You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-697327d8-4eaa-48ef-9e75-3daa23d4860f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships-within-a-changeset.md b/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships-within-a-changeset.md index 00ee2611f..d9a353e38 100644 --- a/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve an attribute's re You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-8b42c446-de96-4899-b3c1-005f25702596?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships.md b/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships.md index 7a8599396..4bded4146 100644 --- a/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships.md +++ b/docs/common-workflows/modeling/manage-attribute-relationships/retrieve-an-attributes-relationships.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve the relationships You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-063edda6-63ad-4938-ab4c-a4eb8f13d65e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-attribute-relationships/update-an-attributes-relationships.md b/docs/common-workflows/modeling/manage-attribute-relationships/update-an-attributes-relationships.md index 61c7477af..c2c14d961 100644 --- a/docs/common-workflows/modeling/manage-attribute-relationships/update-an-attributes-relationships.md +++ b/docs/common-workflows/modeling/manage-attribute-relationships/update-an-attributes-relationships.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an attribute's rela You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-a1ebd204-40ea-42e0-9ccc-21f391c797fb?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-base-formula-objects/create-a-base-formulas-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-base-formula-objects/create-a-base-formulas-definition-within-a-changeset.md index 3e2ef0b23..7cf661fa8 100644 --- a/docs/common-workflows/modeling/manage-base-formula-objects/create-a-base-formulas-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-base-formula-objects/create-a-base-formulas-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create an attribute object You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-bfe3c7f0-372a-44ef-a687-0f694deda59b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-base-formula-objects/manage-base-formula-objects.md b/docs/common-workflows/modeling/manage-base-formula-objects/manage-base-formula-objects.md index 182858604..815ffc7cb 100644 --- a/docs/common-workflows/modeling/manage-base-formula-objects/manage-base-formula-objects.md +++ b/docs/common-workflows/modeling/manage-base-formula-objects/manage-base-formula-objects.md @@ -9,7 +9,7 @@ description: Base formulas are mathematical expressions created using existing f You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-cf953972-3d9d-4347-b253-5d89e40c088c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -34,7 +34,7 @@ There are two important fields in the API response body defined for a base formu :information_source: **Info** - Tokens are a semi-structured representation of a MicroStrategy expression text that includes object references. When the base formula’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata. + Tokens are a semi-structured representation of a expression text that includes object references. When the base formula’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata. ::: diff --git a/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition-within-a-changeset.md index c55130583..86cb9f514 100644 --- a/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a base formula's You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7bcc16b2-2864-4980-b2b1-77681174827a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition.md b/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition.md index 31f37bf0e..92d8daf66 100644 --- a/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition.md +++ b/docs/common-workflows/modeling/manage-base-formula-objects/retrieve-a-base-formulas-definition.md @@ -10,7 +10,7 @@ description: This topic covers several workflows for retrieving a filter's defin You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7bcc16b2-2864-4980-b2b1-77681174827a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-base-formula-objects/update-a-base-formulas-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-base-formula-objects/update-a-base-formulas-definition-within-a-changeset.md index aa3124a61..a3d6d72cf 100644 --- a/docs/common-workflows/modeling/manage-base-formula-objects/update-a-base-formulas-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-base-formula-objects/update-a-base-formulas-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a base formula's de You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-bfe3c7f0-372a-44ef-a687-0f694deda59b?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-calendar-objects/manage-calendar-objects.md b/docs/common-workflows/modeling/manage-calendar-objects/manage-calendar-objects.md index dded6db6a..6fbb81721 100644 --- a/docs/common-workflows/modeling/manage-calendar-objects/manage-calendar-objects.md +++ b/docs/common-workflows/modeling/manage-calendar-objects/manage-calendar-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and replace cale You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b40233c5-3269-43b2-bc9e-e44f6ad8d432?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-consolidation-objects/create-a-consolidation-object.md b/docs/common-workflows/modeling/manage-consolidation-objects/create-a-consolidation-object.md index bf09fdfda..5aa8589d3 100644 --- a/docs/common-workflows/modeling/manage-consolidation-objects/create-a-consolidation-object.md +++ b/docs/common-workflows/modeling/manage-consolidation-objects/create-a-consolidation-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new consolidation You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-cd93cd32-2391-4f2f-9308-9f47783540bf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-consolidation-objects/manage-consolidation-objects.md b/docs/common-workflows/modeling/manage-consolidation-objects/manage-consolidation-objects.md index 554cd73a3..345f96fd3 100644 --- a/docs/common-workflows/modeling/manage-consolidation-objects/manage-consolidation-objects.md +++ b/docs/common-workflows/modeling/manage-consolidation-objects/manage-consolidation-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and replace cons You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-7cc97135-4b16-4910-a32f-5463f39519cf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-consolidation-objects/retrieve-a-consolidations-definition.md b/docs/common-workflows/modeling/manage-consolidation-objects/retrieve-a-consolidations-definition.md index 03cc66401..a45cdf3b9 100644 --- a/docs/common-workflows/modeling/manage-consolidation-objects/retrieve-a-consolidations-definition.md +++ b/docs/common-workflows/modeling/manage-consolidation-objects/retrieve-a-consolidations-definition.md @@ -10,7 +10,7 @@ description: You can use REST APIs to retrieve the definition for a consolidatio You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d0ad5e63-76a5-47c8-b185-1f5781a443f6?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-consolidation-objects/update-a-consolidation-object.md b/docs/common-workflows/modeling/manage-consolidation-objects/update-a-consolidation-object.md index 4c153a2f1..163bfb36a 100644 --- a/docs/common-workflows/modeling/manage-consolidation-objects/update-a-consolidation-object.md +++ b/docs/common-workflows/modeling/manage-consolidation-objects/update-a-consolidation-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to replace an existing consol You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-cd93cd32-2391-4f2f-9308-9f47783540bf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object-with-filter-elements-using-custom-expressions.md b/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object-with-filter-elements-using-custom-expressions.md index fbf266f30..1e30818a7 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object-with-filter-elements-using-custom-expressions.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object-with-filter-elements-using-custom-expressions.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new custom group You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-595a6492-e685-41a9-bdc2-5c0b9c571315?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object.md b/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object.md index 40c83f311..47e04a616 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/create-a-custom-group-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new custom group You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3c57732e-0689-406a-a6ad-c73ece5960c2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/manage-custom-group-objects.md b/docs/common-workflows/modeling/manage-custom-group-objects/manage-custom-group-objects.md index 24a1dff67..76e6ffee3 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/manage-custom-group-objects.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/manage-custom-group-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update custo You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-897727c2-1954-4b12-8d51-ddf79968e22c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition-within-a-changeset.md index 926824779..464dacf47 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a custom group’ You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-1cd8c3f9-4d8f-496f-b183-3f615c8812e2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition.md b/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition.md index b086d799e..e181138e9 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/retrieve-a-custom-groups-definition.md @@ -10,7 +10,7 @@ description: This topic covers three workflows for retrieving a custom group’s You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-1cd8c3f9-4d8f-496f-b183-3f615c8812e2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -393,7 +393,7 @@ Expressions are presented in the following formats: - `"tree"`: A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. - `"tokens"`: A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a custom group filter element's expression is "Revenue > Cost". When the custom group filter element's expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a custom group filter element's expression is "Revenue > Cost". When the custom group filter element's expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). If omitted, the expression is returned in `"text"` format. diff --git a/docs/common-workflows/modeling/manage-custom-group-objects/update-a-custom-groups-definition.md b/docs/common-workflows/modeling/manage-custom-group-objects/update-a-custom-groups-definition.md index 352b1ecf1..bb544cf27 100644 --- a/docs/common-workflows/modeling/manage-custom-group-objects/update-a-custom-groups-definition.md +++ b/docs/common-workflows/modeling/manage-custom-group-objects/update-a-custom-groups-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a custom group’s You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3c57732e-0689-406a-a6ad-c73ece5960c2?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-datamart-objects/execute-a-datamart.md b/docs/common-workflows/modeling/manage-datamart-objects/execute-a-datamart.md index 8fbc66bca..2ea488c5d 100644 --- a/docs/common-workflows/modeling/manage-datamart-objects/execute-a-datamart.md +++ b/docs/common-workflows/modeling/manage-datamart-objects/execute-a-datamart.md @@ -48,7 +48,7 @@ content-type: application/json date: Thu,09 Feb 2023 06:16:42 GMT expires: 0 pragma: no-cache -server: MicroStrategy +server: Strategy strict-transport-security: max-age=31536000;includeSubDomains x-content-type-options: nosniff x-mstr-ms-instance: 35DCAB983549ECD49FC20F9AB0CC4C28 diff --git a/docs/common-workflows/modeling/manage-datamart-objects/manage-datamart-objects.md b/docs/common-workflows/modeling/manage-datamart-objects/manage-datamart-objects.md index 7e953cd71..972dea2d0 100644 --- a/docs/common-workflows/modeling/manage-datamart-objects/manage-datamart-objects.md +++ b/docs/common-workflows/modeling/manage-datamart-objects/manage-datamart-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update dat You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-1f302e4e-e863-4247-a360-802794a8d8a5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-derived-element-objects/create-a-derived-element.md b/docs/common-workflows/modeling/manage-derived-element-objects/create-a-derived-element.md index a53996644..76874cd05 100644 --- a/docs/common-workflows/modeling/manage-derived-element-objects/create-a-derived-element.md +++ b/docs/common-workflows/modeling/manage-derived-element-objects/create-a-derived-element.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new derived eleme You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d4a5b7c7-3dba-46fc-acce-0683a23bb1fe?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-derived-element-objects/manage-derived-element-objects.md b/docs/common-workflows/modeling/manage-derived-element-objects/manage-derived-element-objects.md index 5ea9aa5ee..40f9c5f12 100644 --- a/docs/common-workflows/modeling/manage-derived-element-objects/manage-derived-element-objects.md +++ b/docs/common-workflows/modeling/manage-derived-element-objects/manage-derived-element-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and replace deri You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-45044f1d-938d-4f1a-872d-6b3577c73416?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-derived-element-objects/replace-an-existing-element.md b/docs/common-workflows/modeling/manage-derived-element-objects/replace-an-existing-element.md index ca13fd5d6..145cbf63a 100644 --- a/docs/common-workflows/modeling/manage-derived-element-objects/replace-an-existing-element.md +++ b/docs/common-workflows/modeling/manage-derived-element-objects/replace-an-existing-element.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to replace an existing derive You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d4a5b7c7-3dba-46fc-acce-0683a23bb1fe?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-derived-element-objects/retrieve-a-derived-elements-definition.md b/docs/common-workflows/modeling/manage-derived-element-objects/retrieve-a-derived-elements-definition.md index 6eb35f1ff..ac07bd8cb 100644 --- a/docs/common-workflows/modeling/manage-derived-element-objects/retrieve-a-derived-elements-definition.md +++ b/docs/common-workflows/modeling/manage-derived-element-objects/retrieve-a-derived-elements-definition.md @@ -10,7 +10,7 @@ description: You can use REST APIs to retrieve the definition for a derived elem You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d4a5b7c7-3dba-46fc-acce-0683a23bb1fe?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-dossier-themes/manage-dossier-themes.md b/docs/common-workflows/modeling/manage-dossier-themes/manage-dossier-themes.md index d9154b5b1..6b4e6f8f9 100644 --- a/docs/common-workflows/modeling/manage-dossier-themes/manage-dossier-themes.md +++ b/docs/common-workflows/modeling/manage-dossier-themes/manage-dossier-themes.md @@ -7,7 +7,7 @@ description: A dashboard theme is used to define dashboard presentation styles. You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-dossier-themes/save-dossier-themes.md b/docs/common-workflows/modeling/manage-dossier-themes/save-dossier-themes.md index f915e4151..2d40373d1 100644 --- a/docs/common-workflows/modeling/manage-dossier-themes/save-dossier-themes.md +++ b/docs/common-workflows/modeling/manage-dossier-themes/save-dossier-themes.md @@ -10,7 +10,7 @@ description: A workflow sample for saving a dashboard theme instance to metadata You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-drill-maps/create-a-drill-map.md b/docs/common-workflows/modeling/manage-drill-maps/create-a-drill-map.md index cd6ee1df6..7ed01824b 100644 --- a/docs/common-workflows/modeling/manage-drill-maps/create-a-drill-map.md +++ b/docs/common-workflows/modeling/manage-drill-maps/create-a-drill-map.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new drill map obj You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2b7a0f0c-2172-418a-93ec-e0f0a13fa741?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-drill-maps/manage-drill-maps.md b/docs/common-workflows/modeling/manage-drill-maps/manage-drill-maps.md index 85a8508a6..273e3c0aa 100644 --- a/docs/common-workflows/modeling/manage-drill-maps/manage-drill-maps.md +++ b/docs/common-workflows/modeling/manage-drill-maps/manage-drill-maps.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update drill You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-675653f8-369b-425d-b730-a43e11b584bb?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-drill-maps/retrieve-a-drill-map-definition.md b/docs/common-workflows/modeling/manage-drill-maps/retrieve-a-drill-map-definition.md index 21ca660c6..ce2349b8e 100644 --- a/docs/common-workflows/modeling/manage-drill-maps/retrieve-a-drill-map-definition.md +++ b/docs/common-workflows/modeling/manage-drill-maps/retrieve-a-drill-map-definition.md @@ -10,7 +10,7 @@ description: You can use REST API requests to retrieve, create, and update drill You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2b7a0f0c-2172-418a-93ec-e0f0a13fa741?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-drill-maps/update-a-drill-map.md b/docs/common-workflows/modeling/manage-drill-maps/update-a-drill-map.md index 1d9950ea3..7b73346a1 100644 --- a/docs/common-workflows/modeling/manage-drill-maps/update-a-drill-map.md +++ b/docs/common-workflows/modeling/manage-drill-maps/update-a-drill-map.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an existing drill m You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2b7a0f0c-2172-418a-93ec-e0f0a13fa741?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-fact-objects/create-a-fact-object.md b/docs/common-workflows/modeling/manage-fact-objects/create-a-fact-object.md index d4baf9838..7afb4068e 100644 --- a/docs/common-workflows/modeling/manage-fact-objects/create-a-fact-object.md +++ b/docs/common-workflows/modeling/manage-fact-objects/create-a-fact-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a fact object throu You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-11d116e7-cf31-451a-848e-0d2be6fa3041?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -47,7 +47,7 @@ To create a fact, in the request body, "expressions" contains a list of fact exp - "expression": Must be in either "tree" or "tokens" format. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). - "tables": A list of tables that the "expression" applies to. Warehouse partition base tables and metadata partition mapping tables are not allowed here. diff --git a/docs/common-workflows/modeling/manage-fact-objects/manage-fact-objects.md b/docs/common-workflows/modeling/manage-fact-objects/manage-fact-objects.md index d3f875a59..a19560cee 100644 --- a/docs/common-workflows/modeling/manage-fact-objects/manage-fact-objects.md +++ b/docs/common-workflows/modeling/manage-fact-objects/manage-fact-objects.md @@ -10,7 +10,7 @@ description: You can use REST API requests to retrieve, create and update fact o You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d9b59a86-7b75-4cea-be1c-941dae6f4b08?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition-within-a-changeset.md index 788f05e22..c1064408e 100644 --- a/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a fact's definiti You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-440d539e-15d7-4709-94a5-9c74eecc03db?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition.md b/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition.md index b819b0db6..e9a27a4c8 100644 --- a/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition.md +++ b/docs/common-workflows/modeling/manage-fact-objects/retrieve-a-facts-definition.md @@ -10,7 +10,7 @@ description: This topic covers two workflows for retrieving a fact’s definitio You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3b137a26-4cf4-4902-8f11-9d7a7cffc5f0?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -109,7 +109,7 @@ Expressions are presented in the following formats: - "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. - "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. -Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). +Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). If `showExpressionAs` is omitted, the expression is returned in "text" format. diff --git a/docs/common-workflows/modeling/manage-fact-objects/update-a-fact-object.md b/docs/common-workflows/modeling/manage-fact-objects/update-a-fact-object.md index 1383a764d..93bae6159 100644 --- a/docs/common-workflows/modeling/manage-fact-objects/update-a-fact-object.md +++ b/docs/common-workflows/modeling/manage-fact-objects/update-a-fact-object.md @@ -10,7 +10,7 @@ description: The workflow to update a fact object. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-11d116e7-cf31-451a-848e-0d2be6fa3041?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -45,7 +45,7 @@ To update a fact, in the request body, "expressions" contains a list of fact exp - "expression": Must be in either "tree" or "tokens" format. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a fact expression is "Revenue - Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", Minus_ID), ("Cost", Cost_ID). - "tables": A list of tables that the "expression" applies to. Warehouse partition base tables and metadata partition mapping tables are not allowed here. - "dataType" is optional. If omitted, it calculates based on the first fact expression. diff --git a/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object-with-a-custom-expression.md b/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object-with-a-custom-expression.md index b4253cddb..4c9ef9f5a 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object-with-a-custom-expression.md +++ b/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object-with-a-custom-expression.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new filter object You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b6421792-16ec-4d68-9af9-8fc38eb35b7e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object.md b/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object.md index 4d58d2da6..d3850bb93 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object.md +++ b/docs/common-workflows/modeling/manage-filter-objects/create-a-filter-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new filter object You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5bb60de6-52e2-43c4-87bc-b404125f96ad?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-filter-objects/manage-filter-objects.md b/docs/common-workflows/modeling/manage-filter-objects/manage-filter-objects.md index d24ff6c4a..1c59513fa 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/manage-filter-objects.md +++ b/docs/common-workflows/modeling/manage-filter-objects/manage-filter-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create and update filter You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c51122ec-725f-4841-aa4f-1ba8f88249ff?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition-within-a-changeset.md index e7bb179e0..fafb4ef4d 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a filter's defini You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-67e58dfc-a902-47a6-9166-a26e308ef644?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition.md b/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition.md index 96a2a4bb6..ca8642baf 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition.md +++ b/docs/common-workflows/modeling/manage-filter-objects/retrieve-a-filters-definition.md @@ -10,7 +10,7 @@ description: This topic covers several workflows for retrieving a filter's defin You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c532ccd7-317b-4f18-9a37-1388740cbab5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -109,7 +109,7 @@ In this workflow sample, you want to get the definition of the "Year < 2015" fil :::tip -Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). +Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). A filter's "qualification" is presented in the following formats: @@ -245,7 +245,7 @@ Custom expressions are presented in the following formats: - "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. - "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. -Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). +Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). If omitted, the custom expression is returned in "text" format. diff --git a/docs/common-workflows/modeling/manage-filter-objects/update-a-filters-definition.md b/docs/common-workflows/modeling/manage-filter-objects/update-a-filters-definition.md index 5a0f082fc..44b78ff28 100644 --- a/docs/common-workflows/modeling/manage-filter-objects/update-a-filters-definition.md +++ b/docs/common-workflows/modeling/manage-filter-objects/update-a-filters-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a filter's definiti You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-5bb60de6-52e2-43c4-87bc-b404125f96ad?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-metric-objects/create-a-metric-within-a-changeset.md b/docs/common-workflows/modeling/manage-metric-objects/create-a-metric-within-a-changeset.md index 1715fbc0e..cc0f121d0 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/create-a-metric-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-metric-objects/create-a-metric-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a metric object thr You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-cd346c9a-019b-401a-9470-6097a5d9b24a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-metric-objects/manage-metric-objects.md b/docs/common-workflows/modeling/manage-metric-objects/manage-metric-objects.md index 5c279eb2c..416a80f3b 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/manage-metric-objects.md +++ b/docs/common-workflows/modeling/manage-metric-objects/manage-metric-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update met You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-e7563dc0-b691-44bd-bba9-a7ff60faeb19?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -29,21 +29,21 @@ Training metrics, extreme metric, reference line metrics, and relationship metri The following table lists important fields in the API response body defined for a metric: -| Field | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| information | Stores the basic subtotal information including `dateCreated`, `dateModified`, `versionId`, `primaryLocale`, `objectId`, `subType`, and `name`. For a metric, `subType` is `metric`. | -| expression | Stores the aggregation types and targets defined in the metric either using single-value functions or group-value functions.

Tokens are a semi-structured representation of a MicroStrategy expression text that includes object references. When the metric’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata.

A metric's “expression" is presented in the following formats:

_"text": A human-readable, but non-parsable text, that describes a metric's expression.

_ "tree": A tree data structure that fully defines the metric's expression.

"tokens": A list of parsed tokens that define a metric's expression. Generating tokens requires additional time.


If `showExpressionAs` is omitted, only "text" formats are returned.

If `showExpressionAs` is `tree`, "text" and "tree" formats are returned.

If `showExpressionAs` is `tokens`, "text" and "tokens" formats are returned. | -| dimty | Contains a list of `DimtyUnit`, which describes the level metrics can be calculated. | -| conditionality | Contains a filter that needs to apply to the metric. | -| metricSubtotals | Contains a vector that needs to apply to the metric. | -| aggregateFromBase | Contains a vector of subtotals to apply to the metric. | -| formulaJoinType | Indicates the formula join type for the metric. | -| dataType | Indicates the data type for the metric. | -| smartTotal | Indicates the total calculation type. | -| format | Contains the header format and value format. | -| subtotalFromBase | Indicates the subtotal type for the metric. | -| columnNameAlias | Contains the name used in SQL generation. | -| metricFormatType | Indicates the format type for the metric. | -| thresholds | Contains a list of thresholds applied to the metric. | +| Field | Description | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| information | Stores the basic subtotal information including `dateCreated`, `dateModified`, `versionId`, `primaryLocale`, `objectId`, `subType`, and `name`. For a metric, `subType` is `metric`. | +| expression | Stores the aggregation types and targets defined in the metric either using single-value functions or group-value functions.

Tokens are a semi-structured representation of a expression text that includes object references. When the metric’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata.

A metric's “expression" is presented in the following formats:

_"text": A human-readable, but non-parsable text, that describes a metric's expression.

_ "tree": A tree data structure that fully defines the metric's expression.

"tokens": A list of parsed tokens that define a metric's expression. Generating tokens requires additional time.


If `showExpressionAs` is omitted, only "text" formats are returned.

If `showExpressionAs` is `tree`, "text" and "tree" formats are returned.

If `showExpressionAs` is `tokens`, "text" and "tokens" formats are returned. | +| dimty | Contains a list of `DimtyUnit`, which describes the level metrics can be calculated. | +| conditionality | Contains a filter that needs to apply to the metric. | +| metricSubtotals | Contains a vector that needs to apply to the metric. | +| aggregateFromBase | Contains a vector of subtotals to apply to the metric. | +| formulaJoinType | Indicates the formula join type for the metric. | +| dataType | Indicates the data type for the metric. | +| smartTotal | Indicates the total calculation type. | +| format | Contains the header format and value format. | +| subtotalFromBase | Indicates the subtotal type for the metric. | +| columnNameAlias | Contains the name used in SQL generation. | +| metricFormatType | Indicates the format type for the metric. | +| thresholds | Contains a list of thresholds applied to the metric. | For more information about the Modeling service, see [Configuring the Modeling Service](https://www2.microstrategy.com/producthelp/2021/InstallConfig/en-us/Content/modeling_service.htm). diff --git a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-applicable-properties.md b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-applicable-properties.md index f72a81064..aae4d103e 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-applicable-properties.md +++ b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-applicable-properties.md @@ -10,7 +10,7 @@ description: This topic covers the workflow for retrieving a metric's applicable You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c9639bc3-853f-4746-94b6-528b5aed21a5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition-within-a-changeset.md index 21595b54b..6d73edefc 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a metric's defini You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c9639bc3-853f-4746-94b6-528b5aed21a5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition.md b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition.md index 2925a6fe7..7bcab10bf 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition.md +++ b/docs/common-workflows/modeling/manage-metric-objects/retrieve-a-metrics-definition.md @@ -10,7 +10,7 @@ description: This topic covers several workflows for retrieving a metric's defin You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c9639bc3-853f-4746-94b6-528b5aed21a5?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-metric-objects/update-a-metrics-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-metric-objects/update-a-metrics-definition-within-a-changeset.md index 92bd57ee5..18077a2d1 100644 --- a/docs/common-workflows/modeling/manage-metric-objects/update-a-metrics-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-metric-objects/update-a-metrics-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a metric's definiti You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-cd346c9a-019b-401a-9470-6097a5d9b24a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/create-a-prompt-within-a-changeset.md b/docs/common-workflows/modeling/manage-prompt-objects/create-a-prompt-within-a-changeset.md index f824bdcd9..e11237ac1 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/create-a-prompt-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/create-a-prompt-within-a-changeset.md @@ -8,7 +8,7 @@ description: This workflow sample demonstrates how to create a new prompt object You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-bfdf91c2-f8d8-495a-b4ca-cf1daeb7c6db?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/manage-prompt-objects.md b/docs/common-workflows/modeling/manage-prompt-objects/manage-prompt-objects.md index 1f7d41e66..a97943a66 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/manage-prompt-objects.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/manage-prompt-objects.md @@ -7,7 +7,7 @@ description: You can use REST API requests to retrieve, create, update, and dele You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-02d537e0-b0b3-4e13-b613-1cd863b7db88?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-element-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-element-prompts.md index b13c1d90d..95c6e2740 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-element-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-element-prompts.md @@ -7,7 +7,7 @@ description: An attribute element prompt is one of the most commonly used prompt You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-fc989893-c6cd-42eb-915f-955f12a7fc05?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-qualification-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-qualification-prompts.md index d5baa4ae2..6683000b8 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-qualification-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/attribute-qualification-prompts.md @@ -7,7 +7,7 @@ description: An attribute qualification prompt is a restrictive type prompt that You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ac7cde77-bb20-4c51-86e3-a457f5b8f43f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/hierarchy-qualification-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/hierarchy-qualification-prompts.md index 41848977a..41eb9177a 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/hierarchy-qualification-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/hierarchy-qualification-prompts.md @@ -7,7 +7,7 @@ description: A hierarchy qualification prompt allows users to filter data in a r You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c7bb0522-b646-4b0a-93a1-159c55b3af82?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/metric-expression-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/metric-expression-prompts.md index fb7aa4716..8524b75a4 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/metric-expression-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/metric-expression-prompts.md @@ -7,7 +7,7 @@ description: A metric expression element prompt is one of the most commonly used You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-bca657c1-687a-4ba4-9050-3b45b4a5ce39?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/object-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/object-prompts.md index 7c57c1aae..c9e6f054a 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/object-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/object-prompts.md @@ -7,7 +7,7 @@ description: An object prompt allows the caller to supply a list of objects, suc You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-10f21f1c-3d27-4459-80ba-729a44b945a7?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/prompt-types.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/prompt-types.md index 477e658f4..08a865e88 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/prompt-types.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/prompt-types.md @@ -1,9 +1,9 @@ --- title: Prompt types for managing prompt objects -description: There are several different prompt types in the MicroStrategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in EnumDSSXMLPromptType. +description: There are several different prompt types in the Strategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in EnumDSSXMLPromptType. --- -There are several different prompt types in the MicroStrategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in [EnumDSSXMLPromptType](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html). +There are several different prompt types in the Strategy platform. Each prompt type is defined by a specific set of parameters and corresponds to a value in [EnumDSSXMLPromptType](https://www2.microstrategy.com/producthelp/2021/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPromptType.html). For the following prompt types, you can perform prompt actions supported by REST APIs for managing prompt objects. This includes retrieving prompt definitions, creating new prompts, modifying prompt definitions, and deleting existing prompts. diff --git a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/value-prompts.md b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/value-prompts.md index f96cb7fff..635f2e232 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/value-prompts.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/prompt-types/value-prompts.md @@ -7,7 +7,7 @@ description: A value prompt allows the results to be filtered based on a specifi You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2541f642-4418-4621-980d-40fa31236eb8?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/retrieve-a-prompts-definition.md b/docs/common-workflows/modeling/manage-prompt-objects/retrieve-a-prompts-definition.md index a994f94c2..315028133 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/retrieve-a-prompts-definition.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/retrieve-a-prompts-definition.md @@ -8,7 +8,7 @@ description: This workflow sample demonstrates how to retrieve a prompt's defini You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3952eb54-479d-4930-aac5-64cf1c1dfdaf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-prompt-objects/update-a-prompts-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-prompt-objects/update-a-prompts-definition-within-a-changeset.md index 5727148fb..2a258dcb9 100644 --- a/docs/common-workflows/modeling/manage-prompt-objects/update-a-prompts-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-prompt-objects/update-a-prompts-definition-within-a-changeset.md @@ -8,7 +8,7 @@ description: This workflow demonstrates how to update a prompt's definition thro You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3952eb54-479d-4930-aac5-64cf1c1dfdaf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-security-filter-objects/manage-security-filter-objects.md b/docs/common-workflows/modeling/manage-security-filter-objects/manage-security-filter-objects.md index 17c596c5e..fb00b98a0 100644 --- a/docs/common-workflows/modeling/manage-security-filter-objects/manage-security-filter-objects.md +++ b/docs/common-workflows/modeling/manage-security-filter-objects/manage-security-filter-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create and update securi You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-add85127-d706-4f6d-b202-16368325e40e?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-security-filter-objects/modify-a-security-filters-member.md b/docs/common-workflows/modeling/manage-security-filter-objects/modify-a-security-filters-member.md index 49439ffef..c9c238645 100644 --- a/docs/common-workflows/modeling/manage-security-filter-objects/modify-a-security-filters-member.md +++ b/docs/common-workflows/modeling/manage-security-filter-objects/modify-a-security-filters-member.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to modify the users and user You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-b39c86ac-1a16-4100-a96d-b1a6d2f74b9c?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-security-filter-objects/retrieve-a-security-filter-definition.md b/docs/common-workflows/modeling/manage-security-filter-objects/retrieve-a-security-filter-definition.md index a6f17f497..c261f6166 100644 --- a/docs/common-workflows/modeling/manage-security-filter-objects/retrieve-a-security-filter-definition.md +++ b/docs/common-workflows/modeling/manage-security-filter-objects/retrieve-a-security-filter-definition.md @@ -256,7 +256,7 @@ In this workflow sample, you want to get the definition of the "Year > 2015" sec :::tip -Security filter tokens are used the same manner as filter tokens. Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let's say a security filter expression is "Revenue > Cost". When the security filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID).

A security filter's "qualification" is presented in the following formats: +Security filter tokens are used the same manner as filter tokens. Tokens are a semi-structured representation of expression text that includes object references. For example, let's say a security filter expression is "Revenue > Cost". When the security filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID).

A security filter's "qualification" is presented in the following formats: - "text": A human-readable, but non-parsable text, describing a filter's qualification. - "tree": A tree data structure fully defining the filter's qualification. @@ -392,7 +392,7 @@ Custom expressions are presented in the following formats: - "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. - "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. - Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let's say a security filter expression is "Revenue > Cost". When the security filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). + Tokens are a semi-structured representation of expression text that includes object references. For example, let's say a security filter expression is "Revenue > Cost". When the security filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). If omitted, the custom expression is returned in "text" format. diff --git a/docs/common-workflows/modeling/manage-subtotal-objects/create-a-subtotal-within-a-changeset.md b/docs/common-workflows/modeling/manage-subtotal-objects/create-a-subtotal-within-a-changeset.md index e1a871582..2cdcad097 100644 --- a/docs/common-workflows/modeling/manage-subtotal-objects/create-a-subtotal-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-subtotal-objects/create-a-subtotal-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a subtotal object t You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-0054ca44-40a6-4387-b766-35fc5f00e428?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-subtotal-objects/manage-subtotal-objects.md b/docs/common-workflows/modeling/manage-subtotal-objects/manage-subtotal-objects.md index d5711dffe..65a751aab 100644 --- a/docs/common-workflows/modeling/manage-subtotal-objects/manage-subtotal-objects.md +++ b/docs/common-workflows/modeling/manage-subtotal-objects/manage-subtotal-objects.md @@ -9,7 +9,7 @@ description: Subtotals allow you to dynamically control the computation and disp You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-0e8e2533-03d6-4235-8aa0-6aef1cc2e723?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -34,7 +34,7 @@ There are three important fields in the API response body defined for a subtotal :information_source: **Info** - Tokens are a semi-structured representation of a MicroStrategy expression text that includes object references. When the subtotal’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata. + Tokens are a semi-structured representation of a expression text that includes object references. When the subtotal’s expression is represented as tokens, the text is broken down into pieces, or tokens, with information about what these pieces represent in the metadata. ::: diff --git a/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition-within-a-changeset.md b/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition-within-a-changeset.md index 43d14a516..4b580e0e3 100644 --- a/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve a subtotal's defi You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d1504a52-db9a-4d71-99d2-0ffbd82ee91a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition.md b/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition.md index 5945742b0..c49146023 100644 --- a/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition.md +++ b/docs/common-workflows/modeling/manage-subtotal-objects/retrieve-a-subtotals-definition.md @@ -10,7 +10,7 @@ description: This topic covers several workflows for retrieving a metric's defin You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-d1504a52-db9a-4d71-99d2-0ffbd82ee91a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-subtotal-objects/update-a-subtotal-within-a-changeset.md b/docs/common-workflows/modeling/manage-subtotal-objects/update-a-subtotal-within-a-changeset.md index 3375f2ca6..b0c84ea49 100644 --- a/docs/common-workflows/modeling/manage-subtotal-objects/update-a-subtotal-within-a-changeset.md +++ b/docs/common-workflows/modeling/manage-subtotal-objects/update-a-subtotal-within-a-changeset.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update a subtotal's defini You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-0054ca44-40a6-4387-b766-35fc5f00e428?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/create-a-new-partition-mapping-table-object.md b/docs/common-workflows/modeling/manage-table-objects/create-a-new-partition-mapping-table-object.md index fea09e621..7fd4202ad 100644 --- a/docs/common-workflows/modeling/manage-table-objects/create-a-new-partition-mapping-table-object.md +++ b/docs/common-workflows/modeling/manage-table-objects/create-a-new-partition-mapping-table-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new partition map You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-43769ee1-7480-4413-990a-13b50119b384). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/create-a-new-table-object.md b/docs/common-workflows/modeling/manage-table-objects/create-a-new-table-object.md index 28e9aca35..eca28d790 100644 --- a/docs/common-workflows/modeling/manage-table-objects/create-a-new-table-object.md +++ b/docs/common-workflows/modeling/manage-table-objects/create-a-new-table-object.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a new table object You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-69df2b48-9b7c-4f35-9b80-15c9066d48b0?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/manage-table-objects.md b/docs/common-workflows/modeling/manage-table-objects/manage-table-objects.md index b077a5e78..c5fbb05ab 100644 --- a/docs/common-workflows/modeling/manage-table-objects/manage-table-objects.md +++ b/docs/common-workflows/modeling/manage-table-objects/manage-table-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update table You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-43769ee1-7480-4413-990a-13b50119b384?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-partition-mapping-tables-definition.md b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-partition-mapping-tables-definition.md index 3e1222790..06b896f31 100644 --- a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-partition-mapping-tables-definition.md +++ b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-partition-mapping-tables-definition.md @@ -10,13 +10,13 @@ description: You can use REST APIs to retrieve the definition for a partition ma You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-43769ee1-7480-4413-990a-13b50119b384). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -You can use REST APIs to retrieve the definition for a partition mapping table through the Modeling service. A brief introduction of partition mapping is provided in this documentation. To learn more about partition mapping, refer to [Microstrategy Community](https://www2.microstrategy.com/producthelp/Current/ProjectDesignGuide/WebHelp/Lang_1033/Content/Dividing_tables_to_increase_performance__Partition.htm). +You can use REST APIs to retrieve the definition for a partition mapping table through the Modeling service. A brief introduction of partition mapping is provided in this documentation. To learn more about partition mapping, refer to [Strategy Community](https://www2.microstrategy.com/producthelp/Current/ProjectDesignGuide/WebHelp/Lang_1033/Content/Dividing_tables_to_increase_performance__Partition.htm). -The partitioning feature improves query performance when working with large data volumes. Partitioning "breaks" the data into different (ideally balanced) portions, and each portion is called a partition base table (PBT), or a partition table. In other words, a partition table is a warehouse table that contains one part of a larger set of data. To manage which partition table to use for a given query, partition mapping is introduced by MicroStrategy to identify and keep track of the partitioned base tables as part of a logical whole. MicroStrategy supports two types of partition mapping: +The partitioning feature improves query performance when working with large data volumes. Partitioning "breaks" the data into different (ideally balanced) portions, and each portion is called a partition base table (PBT), or a partition table. In other words, a partition table is a warehouse table that contains one part of a larger set of data. To manage which partition table to use for a given query, partition mapping is introduced by Strategy to identify and keep track of the partitioned base tables as part of a logical whole. Strategy supports two types of partition mapping: **Warehouse partition mapping (WHPM)**: uses a specialized warehouse table (WHPM table) to determine which table to access diff --git a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-prompt-of-an-sap-hana-table.md b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-prompt-of-an-sap-hana-table.md index 1e1642cd3..2cc8863a4 100644 --- a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-prompt-of-an-sap-hana-table.md +++ b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-prompt-of-an-sap-hana-table.md @@ -10,7 +10,7 @@ description: You can use REST APIs to retrieve a prompt of a table through the M You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-6ddc138b-b2ab-4c53-8172-b2af26f4586d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-tables-definition.md b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-tables-definition.md index 6b0496500..fa7175782 100644 --- a/docs/common-workflows/modeling/manage-table-objects/retrieve-a-tables-definition.md +++ b/docs/common-workflows/modeling/manage-table-objects/retrieve-a-tables-definition.md @@ -10,7 +10,7 @@ description: You can use REST APIs to retrieve the definition for a table throug You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-95d4124f-c4e5-48ce-986e-a05c6d47069f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/update-a-partition-mapping-tables-definition.md b/docs/common-workflows/modeling/manage-table-objects/update-a-partition-mapping-tables-definition.md index 83ff5c5ee..f634d01ce 100644 --- a/docs/common-workflows/modeling/manage-table-objects/update-a-partition-mapping-tables-definition.md +++ b/docs/common-workflows/modeling/manage-table-objects/update-a-partition-mapping-tables-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an existing partiti You can try this workflow with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-43769ee1-7480-4413-990a-13b50119b384). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/update-a-prompt-of-an-sap-hana-table.md b/docs/common-workflows/modeling/manage-table-objects/update-a-prompt-of-an-sap-hana-table.md index 80a768341..f40f0de75 100644 --- a/docs/common-workflows/modeling/manage-table-objects/update-a-prompt-of-an-sap-hana-table.md +++ b/docs/common-workflows/modeling/manage-table-objects/update-a-prompt-of-an-sap-hana-table.md @@ -10,7 +10,7 @@ description: You can use REST APIs to update a prompt of a table through the Mod You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-e3e4974a-dc93-4f79-9ea6-259a1693dc0d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -24,7 +24,7 @@ This workflow applies only to SAP HANA tables with input parameters because only :::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](update-sap-hana-parameters.md). For more information on managed objects, see [About Managed Objects](https://www2.microstrategy.com/producthelp/2021/MDXCubeReporting/WebHelp/Lang_1033/Content/About_managed_objects.htm). +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 Strategy 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](update-sap-hana-parameters.md). For more information on managed objects, see [About Managed Objects](https://www2.microstrategy.com/producthelp/2021/MDXCubeReporting/WebHelp/Lang_1033/Content/About_managed_objects.htm). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/update-a-tables-definition.md b/docs/common-workflows/modeling/manage-table-objects/update-a-tables-definition.md index b215946ed..46ac73a16 100644 --- a/docs/common-workflows/modeling/manage-table-objects/update-a-tables-definition.md +++ b/docs/common-workflows/modeling/manage-table-objects/update-a-tables-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an existing table t You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-95d4124f-c4e5-48ce-986e-a05c6d47069f?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-table-objects/update-a-tables-physical-table-structure.md b/docs/common-workflows/modeling/manage-table-objects/update-a-tables-physical-table-structure.md index 5cddabbe0..63eeddf33 100644 --- a/docs/common-workflows/modeling/manage-table-objects/update-a-tables-physical-table-structure.md +++ b/docs/common-workflows/modeling/manage-table-objects/update-a-tables-physical-table-structure.md @@ -8,7 +8,7 @@ description: This workflow sample demonstrates how to update a table's physical You can try out this workflow at [REST API Playground]. -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-time-zone-objects/create-a-time-zone-object.md b/docs/common-workflows/modeling/manage-time-zone-objects/create-a-time-zone-object.md index 8d8dbead9..6c8995994 100644 --- a/docs/common-workflows/modeling/manage-time-zone-objects/create-a-time-zone-object.md +++ b/docs/common-workflows/modeling/manage-time-zone-objects/create-a-time-zone-object.md @@ -8,7 +8,7 @@ description: This workflow demonstrates how to create a new custom object throug You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-0bea31ca-d010-4214-8ad6-19c1906fbd5a?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-time-zone-objects/manage-time-zone-objects.md b/docs/common-workflows/modeling/manage-time-zone-objects/manage-time-zone-objects.md index 76597184d..dacdfed74 100644 --- a/docs/common-workflows/modeling/manage-time-zone-objects/manage-time-zone-objects.md +++ b/docs/common-workflows/modeling/manage-time-zone-objects/manage-time-zone-objects.md @@ -7,7 +7,7 @@ description: You can use REST API requests to retrieve, create, and replace time You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-dcd45e43-c8f8-4198-9fa6-c0e3a22c0aaf?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-list-of-time-zones-definitions.md b/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-list-of-time-zones-definitions.md index d3afd116f..df1ca6472 100644 --- a/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-list-of-time-zones-definitions.md +++ b/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-list-of-time-zones-definitions.md @@ -7,7 +7,7 @@ description: You can use REST APIs to retrieve definitions for a list of availab You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-8f48dce2-e826-4f45-98fb-c3ceed64b670?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-time-zones-definition.md b/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-time-zones-definition.md index 924ff36ae..e5a019753 100644 --- a/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-time-zones-definition.md +++ b/docs/common-workflows/modeling/manage-time-zone-objects/retrieve-a-time-zones-definition.md @@ -7,7 +7,7 @@ description: You can use REST APIs to retrieve the definition for a timezone thr You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-4845cf11-1e66-4530-b33f-730143143498?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-time-zone-objects/update-a-time-zone-object.md b/docs/common-workflows/modeling/manage-time-zone-objects/update-a-time-zone-object.md index 7c1f44767..36c17fe9c 100644 --- a/docs/common-workflows/modeling/manage-time-zone-objects/update-a-time-zone-object.md +++ b/docs/common-workflows/modeling/manage-time-zone-objects/update-a-time-zone-object.md @@ -8,7 +8,7 @@ description: This workflow sample demonstrates how to update an existing custom You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-4845cf11-1e66-4530-b33f-730143143498?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-transformation-objects/create-a-transformation-object.md b/docs/common-workflows/modeling/manage-transformation-objects/create-a-transformation-object.md index 41651011a..0ebd3fe46 100644 --- a/docs/common-workflows/modeling/manage-transformation-objects/create-a-transformation-object.md +++ b/docs/common-workflows/modeling/manage-transformation-objects/create-a-transformation-object.md @@ -10,7 +10,7 @@ description: The workflow to create a transformation object. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ad947705-6f6c-433c-ae10-cfe90ba9a364?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -38,7 +38,7 @@ To create a transformation, in the request body, `"attributes"` contains a list `"forms"`: A list of transformation attribute forms, which are generated according to the base attribute key form. Each transformation attribute form contains a `"lookupTable"` and `"expression"`. The `"expression"` needs to be in either `"tree"` or `"tokens"` format. -Tokens are a semi-structured representation of a MicroStrategy expression text including object references. For example, let’s say a filter expression is `"Revenue > Cost"`. When represented as tokens, the text is broken down into pieces (tokens) with information of what these parts represent in the metadata: (`"Revenue"`, `Revenue_ID`), (`">"`, `GreaterThan_ID`), (`"Cost"`, `Cost_ID`) +Tokens are a semi-structured representation of a expression text including object references. For example, let’s say a filter expression is `"Revenue > Cost"`. When represented as tokens, the text is broken down into pieces (tokens) with information of what these parts represent in the metadata: (`"Revenue"`, `Revenue_ID`), (`">"`, `GreaterThan_ID`), (`"Cost"`, `Cost_ID`) `"mappingType"`: Defines a mapping relationship. This can be either `“one_to_one”` or `“many_to_many”`. diff --git a/docs/common-workflows/modeling/manage-transformation-objects/manage-transformation-objects.md b/docs/common-workflows/modeling/manage-transformation-objects/manage-transformation-objects.md index 7b4125ff5..dee915425 100644 --- a/docs/common-workflows/modeling/manage-transformation-objects/manage-transformation-objects.md +++ b/docs/common-workflows/modeling/manage-transformation-objects/manage-transformation-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and update table You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-f3672b04-f9fa-4eab-8077-903d754d1797?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-transformation-objects/retrieve-a-transformations-definition.md b/docs/common-workflows/modeling/manage-transformation-objects/retrieve-a-transformations-definition.md index 2d0bea3ad..4b0bb1ff1 100644 --- a/docs/common-workflows/modeling/manage-transformation-objects/retrieve-a-transformations-definition.md +++ b/docs/common-workflows/modeling/manage-transformation-objects/retrieve-a-transformations-definition.md @@ -10,7 +10,7 @@ description: This topic covers the following workflows for retrieving an transfo You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-3fa0dd24-d717-46ba-831c-29cbfe75c3ba?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -174,7 +174,7 @@ Expressions are presented in the following formats: - "text": A human-readable, but non-parsable text, describing the expression. This is the default format that is always returned in the response. - "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. -- "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", `(">"`, `GreaterThan_ID`), (`"Cost"`, `Cost_ID`). +- "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Be aware that generating tokens requires additional time. Tokens are a semi-structured representation of expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the fact expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), ("-", `(">"`, `GreaterThan_ID`), (`"Cost"`, `Cost_ID`). If `showExpressionAs` is omitted, the expression is returned in "text" format. diff --git a/docs/common-workflows/modeling/manage-transformation-objects/update-a-transformations-definition.md b/docs/common-workflows/modeling/manage-transformation-objects/update-a-transformations-definition.md index cde7f2f91..d373e9473 100644 --- a/docs/common-workflows/modeling/manage-transformation-objects/update-a-transformations-definition.md +++ b/docs/common-workflows/modeling/manage-transformation-objects/update-a-transformations-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an existing transfo You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ad947705-6f6c-433c-ae10-cfe90ba9a364?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-user-hierarchy-objects/create-a-user-hierarchy.md b/docs/common-workflows/modeling/manage-user-hierarchy-objects/create-a-user-hierarchy.md index cf5447f32..a997f6651 100644 --- a/docs/common-workflows/modeling/manage-user-hierarchy-objects/create-a-user-hierarchy.md +++ b/docs/common-workflows/modeling/manage-user-hierarchy-objects/create-a-user-hierarchy.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to create a user hierarchy ob You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c257416e-ee2c-46fc-9a71-f2ea390c8452?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-user-hierarchy-objects/manage-user-hierarchy-objects.md b/docs/common-workflows/modeling/manage-user-hierarchy-objects/manage-user-hierarchy-objects.md index ff86480fa..6f1f7f89a 100644 --- a/docs/common-workflows/modeling/manage-user-hierarchy-objects/manage-user-hierarchy-objects.md +++ b/docs/common-workflows/modeling/manage-user-hierarchy-objects/manage-user-hierarchy-objects.md @@ -9,7 +9,7 @@ description: You can use REST API requests to retrieve, create, and delete user You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-6d8c1099-18f5-45c5-95ce-478e0299fe22?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -23,6 +23,6 @@ You can use REST API requests to retrieve, create, and delete user hierarchy obj For more information about the Modeling service, see [Configuring the Modeling Service](https://www2.microstrategy.com/producthelp/Current/InstallConfig/en-us/Content/modeling_service.htm). -See [KB485058](https://community.microstrategy.com/s/article/Scope-and-limitations-of-the-User-Hierarchy-REST-APIs-in-MicroStrategy-2020-Update-2?language=en_US) for more information about the scope and limitations of user hierarchies in MicroStrategy 2020 Update 2. +See [KB485058](https://community.microstrategy.com/s/article/Scope-and-limitations-of-the-User-Hierarchy-REST-APIs-in-Strategy-2020-Update-2?language=en_US) for more information about the scope and limitations of user hierarchies in MicroStrategy 2020 Update 2. You cannot manage system hierarchies using the user hierarchies REST APIs mentioned in this section. diff --git a/docs/common-workflows/modeling/manage-user-hierarchy-objects/retrieve-a-user-hierarchys-definition.md b/docs/common-workflows/modeling/manage-user-hierarchy-objects/retrieve-a-user-hierarchys-definition.md index 05b79712f..1e45e9fbb 100644 --- a/docs/common-workflows/modeling/manage-user-hierarchy-objects/retrieve-a-user-hierarchys-definition.md +++ b/docs/common-workflows/modeling/manage-user-hierarchy-objects/retrieve-a-user-hierarchys-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to retrieve an user hierarchy You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-6403c6f8-0173-4b2c-826c-029742877689?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/common-workflows/modeling/manage-user-hierarchy-objects/update-a-user-hierarchys-definition.md b/docs/common-workflows/modeling/manage-user-hierarchy-objects/update-a-user-hierarchys-definition.md index 1b1e6724d..686ee70c8 100644 --- a/docs/common-workflows/modeling/manage-user-hierarchy-objects/update-a-user-hierarchys-definition.md +++ b/docs/common-workflows/modeling/manage-user-hierarchy-objects/update-a-user-hierarchys-definition.md @@ -10,7 +10,7 @@ description: This workflow sample demonstrates how to update an user hierarchy's You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c257416e-ee2c-46fc-9a71-f2ea390c8452?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication.md index 0a7670ef7..2592dbe74 100644 --- a/docs/getting-started/authentication.md +++ b/docs/getting-started/authentication.md @@ -6,7 +6,7 @@ description: The REST API provides authentication endpoints to initiate a sessio The REST API provides authentication endpoints to initiate a session with the Intelligence Server. It supports multiple authentication modes such as Standard, LDAP, SAML, and so on. -The diagram below shows the workflow when the MicroStrategy REST API is used to authenticate a user. +The diagram below shows the workflow when the Strategy REST API is used to authenticate a user. ![REST_Login_Workflow](../images/REST_Login_Workflow.png) @@ -18,7 +18,7 @@ The diagram below shows the workflow when the MicroStrategy REST API is used to :::tip -The MicroStrategy REST server maintains an HTTP session for every client connecting to it. +The Strategy REST server maintains an HTTP session for every client connecting to it. ::: @@ -30,7 +30,7 @@ Once the REST API layer has validated the user's credentials using the specified - **Session cookie** -The MicroStrategy REST framework currently relies on an HTTP session. The Java EE server (for example, Tomcat) sends a session cookie in the response header for the client to maintain. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. +The Strategy REST framework currently relies on an HTTP session. The Java EE server (for example, Tomcat) sends a session cookie in the response header for the client to maintain. If a browser is handling requests, it will also handle the cookies. However, if you are using your own client, you need to maintain the cookie and include it in further requests, together with the authorization token. - **Session timeout** diff --git a/docs/getting-started/configure-clustered-environments.md b/docs/getting-started/configure-clustered-environments.md index 2d1a478eb..554f2025b 100644 --- a/docs/getting-started/configure-clustered-environments.md +++ b/docs/getting-started/configure-clustered-environments.md @@ -3,7 +3,7 @@ title: Configure clustered environments description: This page provides information for clustered environment configuration. --- -The MicroStrategy REST platform provides a highly scalable solution to meet your performance needs by installing multiple instances of REST servers that can communicate with an Intelligence Server cluster. +The Strategy REST platform provides a highly scalable solution to meet your performance needs by installing multiple instances of REST servers that can communicate with an Intelligence Server cluster. ![REST Configuration](../images/REST_Configuration.png) @@ -22,9 +22,9 @@ You must configure certain properties for horizontal scaling of REST Servers. - /WEB-INF/classes/config/\* - /WEB-INF/classes/auth/\* -- The MicroStrategyLibrary REST Server provides an admin page to modify some of the configuration settings. +- The StrategyLibrary REST Server provides an admin page to modify some of the configuration settings. - The MicroStrategy REST Server contains default values for configuration in …/config/configDefaults.properties. The configDefaults.properties file contains key-value pairs of configuration options. To specify a configuration option, the desired key can be copied from the configDefaults.properties file, and saved into configOverride.properties with a different value. + The Strategy REST Server contains default values for configuration in …/config/configDefaults.properties. The configDefaults.properties file contains key-value pairs of configuration options. To specify a configuration option, the desired key can be copied from the configDefaults.properties file, and saved into configOverride.properties with a different value. However, if you use this method to make configuration changes and your REST Server is running in a clustered environment, only one of the nodes in the cluster is modified. To resolve this problem, you can use a shared drive across all nodes via Mount or Symbolic links. If you use Symbolic links, you need to enable the Tomcat property allowLinking. Refer to the Apache Tomcat Configuration Reference. diff --git a/docs/getting-started/embedding-sdk.md b/docs/getting-started/embedding-sdk.md index d115cf24d..0c52a35e7 100644 --- a/docs/getting-started/embedding-sdk.md +++ b/docs/getting-started/embedding-sdk.md @@ -1,11 +1,11 @@ --- title: Using REST API with Embedding SDK -description: You can use MicroStrategy REST API together with MicroStrategy Embedding SDK. +description: You can use Strategy REST API together with Strategy Embedding SDK. --- ## What is the Embedding SDK? -The Embedding SDK allows you to quickly integrate a MicroStrategy dashboard into a web application in a responsive manner. It also provides resources to add functionality such as controlling navigation, retrieving and applying filters, setting properties, and managing events, and supports different authentication environments. +The Embedding SDK allows you to quickly integrate a dashboard into a web application in a responsive manner. It also provides resources to add functionality such as controlling navigation, retrieving and applying filters, setting properties, and managing events, and supports different authentication environments. ## Common use cases of REST API with Embedding SDK diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index 190edface..e9605c6ea 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -1,9 +1,9 @@ --- title: Getting started -description: The following topics are designed to help you get started using the MicroStrategy REST API. +description: The following topics are designed to help you get started using the Strategy REST API. --- -To get started, view the following topics to know the basics of the MicroStrategy REST API: +To get started, view the following topics to know the basics of the Strategy REST API: - [REST API architecture](rest-api-architecture.md) - [REST API families](rest-api-families.md) @@ -18,7 +18,7 @@ After learning the basics, view the following topics to understand some general You can use the REST API Explorer and Playground as tools to learn more and run live REST API calls: -- [MicroStrategy REST API Explorer](microstrategy-rest-api-explorer.md) -- [MicroStrategy REST API Playground](playground.md) +- [Strategy REST API Explorer](microstrategy-rest-api-explorer.md) +- [Strategy REST API Playground](playground.md) For more specific REST API topics, view the [common workflows](../common-workflows/common-workflows.md). diff --git a/docs/getting-started/handle-rest-api-exceptions.md b/docs/getting-started/handle-rest-api-exceptions.md index 84af7b44a..0e2c8456b 100644 --- a/docs/getting-started/handle-rest-api-exceptions.md +++ b/docs/getting-started/handle-rest-api-exceptions.md @@ -1,9 +1,9 @@ --- title: Handle REST API errors -description: This page provides a guidance on designing exception workflows when using MicroStrategy REST API. +description: This page provides a guidance on designing exception workflows when using Strategy REST API. --- -When developers use MicroStrategy REST APIs to build dynamic applications, they need to add code to handle error conditions. The instructions below are designed to provide a guidance on designing exception workflows when using MicroStrategy REST API. +When developers use Strategy REST APIs to build dynamic applications, they need to add code to handle error conditions. The instructions below are designed to provide a guidance on designing exception workflows when using Strategy REST API. ## 1. Understand the status code @@ -33,12 +33,12 @@ When you encounter REST API error, you may receive an error message that looks l ```json { "code": "ERR001", - "message": "MicroStrategy Intelligence Server is not configured to support LDAP authentication.", + "message": "Strategy Intelligence Server is not configured to support LDAP authentication.", "iServerCode": -214720549 } ``` -The value of `code` is a MicroStrategy REST API Server code. The table below provides a general description of each error code. Use the error code to create meaningful text for the error message that will help users when they encounter errors. +The value of `code` is a Strategy REST API Server code. The table below provides a general description of each error code. Use the error code to create meaningful text for the error message that will help users when they encounter errors. | Error code | Description | | :--------- | :------------------------------ | @@ -65,7 +65,7 @@ The value of `code` is a MicroStrategy REST API Server code. The table below pro ## 4. IServer error code -The MicroStrategy error message may also contain an integer value for `iServerCode`. This integer value maps to a constant value in the [WebAPIErrorCodes](https://www2.microstrategy.com/producthelp/Current/ReferenceFiles/reference/com/microstrategy/utils/localization/WebAPIErrorCodes.html) class. There are many error codes in this class. You should look at the `iServerCode` error and decide if you think it provides meaningful context. If so, you may want to handle it in your code. +The error message may also contain an integer value for `iServerCode`. This integer value maps to a constant value in the [WebAPIErrorCodes](https://www2.microstrategy.com/producthelp/Current/ReferenceFiles/reference/com/microstrategy/utils/localization/WebAPIErrorCodes.html) class. There are many error codes in this class. You should look at the `iServerCode` error and decide if you think it provides meaningful context. If so, you may want to handle it in your code. If needed, you can also find more information in the Library Sever's error log, such as stack traces. @@ -140,7 +140,7 @@ Example: #### 404 Not Found -A 404 error means the requested endpoint doesn't exist, or the endpoint is valid but the resource does not exist. You might not always get a response JSON for this status code depending on your URL. MicroStrategy REST API also uses this status code for not supported HTTP methods. +A 404 error means the requested endpoint doesn't exist, or the endpoint is valid but the resource does not exist. You might not always get a response JSON for this status code depending on your URL. Strategy REST API also uses this status code for not supported HTTP methods. Example: diff --git a/docs/getting-started/improve-performance-by-working-with-partial-resources/field-selection-for-data-api-v2-result-fetching-endpoints.md b/docs/getting-started/improve-performance-by-working-with-partial-resources/field-selection-for-data-api-v2-result-fetching-endpoints.md index bb5641fb6..ba8c13f9b 100644 --- a/docs/getting-started/improve-performance-by-working-with-partial-resources/field-selection-for-data-api-v2-result-fetching-endpoints.md +++ b/docs/getting-started/improve-performance-by-working-with-partial-resources/field-selection-for-data-api-v2-result-fetching-endpoints.md @@ -1,17 +1,17 @@ --- title: Field selection for data API v2 result-fetching endpoints -description: For Data API v2 result-fetching endpoints, the MicroStrategy REST API provides a specialized flavor of field selection support. It is tailored for Data API specific use cases using a similar syntax. +description: For Data API v2 result-fetching endpoints, the Strategy REST API provides a specialized flavor of field selection support. It is tailored for Data API specific use cases using a similar syntax. --- :::tip You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-a6457d75-f616-4092-9485-e6007627b73d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: -For Data API v2 result-fetching endpoints, the MicroStrategy REST API provides a specialized flavor of field selection support. It is tailored for Data API specific use cases using a similar syntax. +For Data API v2 result-fetching endpoints, the Strategy REST API provides a specialized flavor of field selection support. It is tailored for Data API specific use cases using a similar syntax. The endpoints are: @@ -45,9 +45,9 @@ Some things to keep in mind: ## Supported rule: Filtering metric value representations and other per metric-cell information -MicroStrategy Library Server 2020 Update 2 and above +Strategy Library Server 2020 Update 2 and above -MicroStrategy Intelligence Server 2020 Update 2 and above +Strategy Intelligence Server 2020 Update 2 and above By default, metric values are returned in both raw representation (data.metricValues.raw) and formatted representation (`data.metricValues.formatted`). Other metric cell information under extras, such as optional thresholds, are returned as well. @@ -59,7 +59,7 @@ Clients can request part of these fields by using the following exclusion rules: Exclusion rules can significantly improve the performance of certain clients, such as the ones mentioned below, roughly halving the size of data transfers: -- Frontend apps and exporters that render results similarly as MicroStrategy client products, by focusing on human-reader formatted values that can be rendered directly. These frontend apps and exporters may need extras for determining advanced formatting. +- Frontend apps and exporters that render results similarly as Strategy client products, by focusing on human-reader formatted values that can be rendered directly. These frontend apps and exporters may need extras for determining advanced formatting. - Data connectors that focus on raw values are compact and easily parsed and post-processed. diff --git a/docs/getting-started/improve-performance-by-working-with-partial-resources/improve-performance-by-working-with-partial-resources.md b/docs/getting-started/improve-performance-by-working-with-partial-resources/improve-performance-by-working-with-partial-resources.md index acb04011b..f1831a1e0 100644 --- a/docs/getting-started/improve-performance-by-working-with-partial-resources/improve-performance-by-working-with-partial-resources.md +++ b/docs/getting-started/improve-performance-by-working-with-partial-resources/improve-performance-by-working-with-partial-resources.md @@ -7,13 +7,13 @@ description: While API endpoints define full response models, you may only need You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-ea1451c1-67fc-44c2-9f08-427b6cd60393?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: While API endpoints define full response models, you may only need a subset of the available data. You can ask the server to only send the fields you need and get a partial response instead. This helps improve performance, since extra resources are not devoted transferring, parsing, and storing unnecessary fields. -MicroStrategy supports top-level field selection on most endpoints. +Strategy supports top-level field selection on most endpoints. - For endpoints that return a JSON object, the client specifies which fields to include for the root object. - For endpoints that return a JSON array, the client specifies which fields to include for every element of the root array. @@ -56,7 +56,7 @@ The fields query parameter is exposed on endpoints that support field selection. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-6ea58912-5546-4576-a94b-01db9437118d?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: @@ -100,7 +100,7 @@ Here is an example of full representation without fields. You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2f86322d-d0b2-4005-881e-f8b878c83680?ctx=documentation). -Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md). +Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md). ::: diff --git a/docs/getting-started/microstrategy-rest-api-explorer.md b/docs/getting-started/microstrategy-rest-api-explorer.md index 669968f45..fe7cb6a28 100644 --- a/docs/getting-started/microstrategy-rest-api-explorer.md +++ b/docs/getting-started/microstrategy-rest-api-explorer.md @@ -1,13 +1,13 @@ --- -title: MicroStrategy REST API Explorer -description: Instructions for using MicroStrategy REST API Explorer, our official REST API documentation. +title: Strategy REST API Explorer +description: Instructions for using Strategy REST API Explorer, our official REST API documentation. --- ## Overview -[MicroStrategy API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs) serves as the REST API reference guide, providing a comprehensive list of the available MicroStrategy REST APIs grouped into REST API families. Common MicroStrategy platform capabilities are exposed in a RESTful web service. +[Strategy API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs) serves as the REST API reference guide, providing a comprehensive list of the available Strategy REST APIs grouped into REST API families. Common Strategy platform capabilities are exposed in a RESTful web service. -It is hosted on [demo.microstrategy.com](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs). You can also use the API Explorer shipped in your MicroStrategyLibrary server. Once the MicroStrategyLibrary server is started, you access the MicroStrategy REST API Explorer at `{YOUR_LIBRARY_SERVER_URL}/api-docs/`, e.g., `https://env-263053.customer.cloud.microstrategy.com/MicroStrategyLibrary/api-docs`. +It is hosted on [demo.microstrategy.com](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs). You can also use the API Explorer shipped in your StrategyLibrary server. Once the StrategyLibrary server is started, you access the Strategy REST API Explorer at `{YOUR_LIBRARY_SERVER_URL}/api-docs/`, e.g., `https://env-263053.customer.cloud.microstrategy.com/MicroStrategyLibrary/api-docs`. When you access the server, you are able to see the available APIs. You can drill down into these to see HTTP headers and input and output information for each request, and enter values to try out the APIs. diff --git a/docs/getting-started/playground.md b/docs/getting-started/playground.md index 3e66bfb15..9d059c876 100644 --- a/docs/getting-started/playground.md +++ b/docs/getting-started/playground.md @@ -1,18 +1,18 @@ --- -title: MicroStrategy REST API Playground -description: MicroStrategy REST API Playground is a place you can see live demos of our REST API, API specifications, and code examples. You can also play with it without writing a single line of code. +title: Strategy REST API Playground +description: Strategy REST API Playground is a place you can see live demos of our REST API, API specifications, and code examples. You can also play with it without writing a single line of code. --- ## What is the playground? -MicroStrategy REST API Playground is a place you can see live demos of our REST API, API specifications, and code examples. You can also play with it without writing a single line of code. +Strategy REST API Playground is a place you can see live demos of our REST API, API specifications, and code examples. You can also play with it without writing a single line of code. [This GitHub Page](https://github.com/MicroStrategy/rest-api-playground) provides the instructions for you to set up and start to use it. You can access the playground at [https://www.postman.com/microstrategysdk](https://www.postman.com/microstrategysdk). If you are not familiar Postman interface, be sure to check out [the documentation](https://learning.postman.com/docs/getting-started/introduction/) on Postman's learning center. There are two collections in the workspace: -- MicroStrategy REST API: Use it as API Documentation. It contains examples and built-in scripts to save the context information after some requests, such as `authToken`, `userId`. -- MicroStrategy REST API Workflows: It contains workflow examples. You can pick a folder and run all the requests. +- Strategy REST API: Use it as API Documentation. It contains examples and built-in scripts to save the context information after some requests, such as `authToken`, `userId`. +- Strategy REST API Workflows: It contains workflow examples. You can pick a folder and run all the requests. You need to pick an environment to run the requests. There are two environments shipped: diff --git a/docs/getting-started/rest-api-architecture.md b/docs/getting-started/rest-api-architecture.md index 2774c5cb3..05f18be12 100644 --- a/docs/getting-started/rest-api-architecture.md +++ b/docs/getting-started/rest-api-architecture.md @@ -1,9 +1,9 @@ --- title: REST API architecture -description: The MicroStrategy REST framework follows REST conventions to provide a simplified interface for utilizing platform capabilities through JSON data via HTTP(s) protocol. +description: The Strategy REST framework follows REST conventions to provide a simplified interface for utilizing platform capabilities through JSON data via HTTP(s) protocol. --- -The MicroStrategy REST framework follows REST conventions to provide a simplified interface for utilizing platform capabilities through JSON data via HTTP(s) protocol. You can use the REST framework to perform actions such as: +The Strategy REST framework follows REST conventions to provide a simplified interface for utilizing platform capabilities through JSON data via HTTP(s) protocol. You can use the REST framework to perform actions such as: - [Authentication](authentication.md) - [Retrieve data](../common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md) @@ -12,7 +12,7 @@ The MicroStrategy REST framework follows REST conventions to provide a simplifie The REST framework is scalable, allowing you to configure a clustered environment that supports multiple instances of REST servers communicating with an Intelligence Server cluster. -The REST Framework layer is built on top of the existing WebObjects and XML API layers. It provides a comprehensive set of APIs that allow developers to quickly and easily customize MicroStrategy BI functionality. +The REST Framework layer is built on top of the existing WebObjects and XML API layers. It provides a comprehensive set of APIs that allow developers to quickly and easily customize Strategy BI functionality. ![REST Architecture](../images/REST_architecture.png) diff --git a/docs/getting-started/rest-api-families.md b/docs/getting-started/rest-api-families.md index 03302fc15..eb0adf77b 100644 --- a/docs/getting-started/rest-api-families.md +++ b/docs/getting-started/rest-api-families.md @@ -1,10 +1,10 @@ --- sidebar_label: REST API families -title: MicroStrategy REST API families -description: The MicroStrategy REST API Explorer lets you drill down into the individual APis. You can see HTTP headers and input and output information for each request, and enter values to try out the APIs. +title: Strategy REST API families +description: The Strategy REST API Explorer lets you drill down into the individual APis. You can see HTTP headers and input and output information for each request, and enter values to try out the APIs. --- -The [MicroStrategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/) lets you drill down into the individual APis. You can see HTTP headers and input and output information for each request, and enter values to try out the APIs. +The [Strategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/) lets you drill down into the individual APis. You can see HTTP headers and input and output information for each request, and enter values to try out the APIs. ## [Authentication API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication) @@ -48,11 +48,11 @@ The Custom Groups API family allows developers to obtain a custom group's defini ## [Datasets API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasets) -The Datasets API family allows developers to push external data directly to the MicroStrategy Intelligence Server. This data can be used to create a dataset or to modify an existing dataset in a Data Import cube. Once the data has been pushed to the Intelligence Server, developers can use the Cubes API or the Reports API to manipulate that data. This API is often referred to as the Push Data API. +The Datasets API family allows developers to push external data directly to the Intelligence Server. This data can be used to create a dataset or to modify an existing dataset in a Data Import cube. Once the data has been pushed to the Intelligence Server, developers can use the Cubes API or the Reports API to manipulate that data. This API is often referred to as the Push Data API. ## [Datasource management API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management) -The Datasource Management API family allows administrators to create, update, and delete database connections in the MicroStrategy metadata. This functionality can be used to automate the update of data source credentials. +The Datasource Management API family allows administrators to create, update, and delete database connections in the metadata. This functionality can be used to automate the update of data source credentials. ## [Derived elements API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Derived%20Elements) @@ -68,7 +68,7 @@ The Drivers API family allows developers to obtain drivers' definition and updat ## [Emails API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Emails) -The Emails API family allows administrators and developers to send emails using MicroStrategy Distribution Services email transmitters. +The Emails API family allows administrators and developers to send emails using Distribution Services email transmitters. ## [Facts API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Facts) @@ -88,7 +88,7 @@ The Library API family exposes the publishing workflow, allowing requests to pub ## [Object management API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Object%20Management) -The Object Management API family exposes the ability to programmatically manage objects in the MicroStrategy metadata. Endpoints can be used to certify or de-certify a report or dashboard, delete objects, and update object info for any object type. +The Object Management API family exposes the ability to programmatically manage objects in the metadata. Endpoints can be used to certify or de-certify a report or dashboard, delete objects, and update object info for any object type. ## [Packages API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Packages) @@ -124,7 +124,7 @@ The Security Roles API family allows administrators and developers to obtain a l ## [System administration API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration) -The System Administration API family allows administrators and developers to programmatically configure the settings related to the MicroStrategy Library web application. For example, this functionality can be used to configure default values related to the authentication process, set up trust relationships to the Intelligence Server, and more. +The System Administration API family allows administrators and developers to programmatically configure the settings related to the Library web application. For example, this functionality can be used to configure default values related to the authentication process, set up trust relationships to the Intelligence Server, and more. ## [System hierarchy API](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Hierarchy) diff --git a/docs/index.md b/docs/index.md index 8151998f6..b6f98b5d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,24 +2,24 @@ title: Introduction to REST API date: Last Modified slug: / -description: The MicroStrategy REST API is a RESTful application that uses HTTP requests such as POST, DELETE, and GET. It is designed to help developers build data-driven client applications quickly and easily. It does this by providing light-weight JSON data that is easy to consume because it includes raw data without direct formatting. Developers can use the MicroStrategy REST API programmatically in their own code, or in a tool like curl. +description: The Strategy REST API is a RESTful application that uses HTTP requests such as POST, DELETE, and GET. It is designed to help developers build data-driven client applications quickly and easily. It does this by providing light-weight JSON data that is easy to consume because it includes raw data without direct formatting. Developers can use the Strategy REST API programmatically in their own code, or in a tool like curl. --- -The MicroStrategy REST API is a RESTful application that uses HTTP requests such as POST, DELETE, and GET. It is designed to help developers build data-driven client applications quickly and easily. It does this by providing light-weight JSON data that is easy to consume because it includes raw data without direct formatting. Developers can use the MicroStrategy REST API programmatically in their own code, or in a tool like curl. +The Strategy REST API is a RESTful application that uses HTTP requests such as POST, DELETE, and GET. It is designed to help developers build data-driven client applications quickly and easily. It does this by providing light-weight JSON data that is easy to consume because it includes raw data without direct formatting. Developers can use the Strategy REST API programmatically in their own code, or in a tool like curl. -The following topics are designed to help you understand and use the MicroStrategy REST API. +The following topics are designed to help you understand and use the Strategy REST API. ## [Getting started](getting-started/getting-started.md) -Quick overviews introduce you to the MicroStrategy REST framework, configuring clustered environments, handling exceptions, and the MicroStrategy REST API Explorer, which serves as the REST API reference guide. +Quick overviews introduce you to the Strategy REST framework, configuring clustered environments, handling exceptions, and the Strategy REST API Explorer, which serves as the REST API reference guide. ## [REST API families](getting-started/rest-api-families.md) -MicroStrategy REST APIs are grouped into API families. These families represent functionality, such as Authentication or Browsing, or categories, such as Cubes or Security Roles. +Strategy REST APIs are grouped into API families. These families represent functionality, such as Authentication or Browsing, or categories, such as Cubes or Security Roles. ## [Common REST API workflows](common-workflows/common-workflows.md) -Descriptions and quick start guides are provided for common MicroStrategy REST API workflows, such as authentication, folder browsing, filtering data, searching, retrieving data from the Intelligence Server (referred to as the JSON Data API), uploading external data (referred to as the Push Data API), and manage attributes, relationships, facts, tables, filters, prompts, derived elements, and security filters through the Modeling service. +Descriptions and quick start guides are provided for common Strategy REST API workflows, such as authentication, folder browsing, filtering data, searching, retrieving data from the Intelligence Server (referred to as the JSON Data API), uploading external data (referred to as the Push Data API), and manage attributes, relationships, facts, tables, filters, prompts, derived elements, and security filters through the Modeling service. ## [REST API samples](microstrategy-rest-api-samples/microstrategy-rest-api-samples.md) diff --git a/docs/microstrategy-rest-api-samples/create-reports-on-the-fly.md b/docs/microstrategy-rest-api-samples/create-reports-on-the-fly.md index 800252387..a0ab92272 100644 --- a/docs/microstrategy-rest-api-samples/create-reports-on-the-fly.md +++ b/docs/microstrategy-rest-api-samples/create-reports-on-the-fly.md @@ -8,7 +8,7 @@ This interactive REST API sample highlights the ability to create reports on the This sample gets data from an Intelligent cube or a report. It uses the attributes and metrics from the report definition to populate two list boxes. When a user selects attributes and metrics from the list boxes, an ad-hoc report is run on the cube and the results are displayed. A specified number of rows are returned, with additional rows displayed each time the user clicks the forward and backward arrows. Two types of view filters allow the user to narrow the results that are displayed. An auto-load button lets a user decide whether to automatically apply changes as they are made. -You can [view a live demo](https://microstrategy.github.io/data-api-demo/site/) of the sample. You can also [download the code](https://github.com/microstrategy/data-api-demo/) for this sample to help you understand and use MicroStrategy REST APIs in your application. +You can [view a live demo](https://microstrategy.github.io/data-api-demo/site/) of the sample. You can also [download the code](https://github.com/microstrategy/data-api-demo/) for this sample to help you understand and use Strategy REST APIs in your application. ## Understand the REST API workflow in the sample @@ -16,7 +16,7 @@ This sample uses REST APIs to authenticate the user, get a list of reports and c **1.** `POST /api/auth/login` -This REST API authenticates a user. It creates a MicroStrategy session using credentials for the user and a specified authentication mode. It returns an authorization token, which is used by subsequent REST API calls. In this sample, the API is used to create a configuration session. +This REST API authenticates a user. It creates a session using credentials for the user and a specified authentication mode. It returns an authorization token, which is used by subsequent REST API calls. In this sample, the API is used to create a configuration session. **2.** `GET /api/searches/results` @@ -57,7 +57,7 @@ The config.js file is used to configure the sample for your environment. Set val | Variable name | Variable description | | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- | | restServerURL | Base URL of the REST API. For example, `http://localhost:8080/MicroStrategyLibrary/api`. The REST API endpoints will be appended to this base URL. | -| projectId | ID of the MicroStrategy project that will be used by the REST API endpoints. For example, "B19DEDCC11D4E0EFC000EB9495D0F44F". | +| projectId | ID of the project that will be used by the REST API endpoints. For example, "B19DEDCC11D4E0EFC000EB9495D0F44F". | | username | Username that will be authenticated. The default value is "administrator". | | password | Password for username that will be authenticated. | | cubes | Array of cube IDs. These cubes are listed in the Datasets panel on the left of the sample, under Cubes. Be sure to use valid cube IDs. | diff --git a/docs/microstrategy-rest-api-samples/microstrategy-rest-api-samples.md b/docs/microstrategy-rest-api-samples/microstrategy-rest-api-samples.md index a4beccdee..6ddbc638d 100644 --- a/docs/microstrategy-rest-api-samples/microstrategy-rest-api-samples.md +++ b/docs/microstrategy-rest-api-samples/microstrategy-rest-api-samples.md @@ -1,5 +1,5 @@ --- -title: MicroStrategy REST API samples +title: Strategy REST API samples description: A variety of samples are provided to illustrate how to use REST APIs --- diff --git a/docs/whats-new.md b/docs/whats-new.md index 59600985b..4e7b854ea 100644 --- a/docs/whats-new.md +++ b/docs/whats-new.md @@ -79,7 +79,7 @@ Description: What's New in the REST API. - [Create and edit incremental refresh reports (IRR).](common-workflows/analytics/manage-reports/manage-incremental-refresh-report/manage-incremental-refresh-report.md) - [Create and manage cube objects](common-workflows/analytics/manage-datasets/manage-cube-objects/manage-cube-objects.md) with advanced properties. - [Create and manage SAP HANA tables with input parameters using the modeling schema.](common-workflows/modeling/manage-table-objects/manage-table-objects.md) -- [Create and import migration packages](common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md) just as in Workstation. This allows all packages to be managed by the MicroStrategy Storage Service so migration processes can be monitored in Workstation. +- [Create and import migration packages](common-workflows/administration/migrations/migrations-in-workstation/migrations-in-workstation.md) just as in Workstation. This allows all packages to be managed by the Storage Service so migration processes can be monitored in Workstation. ## 2021 Update 5 @@ -141,14 +141,14 @@ Description: What's New in the REST API. - Enhancement to APIs returning data from reports and cubes to allow the modification of attribute and metric template positioning. - Enhancement to APIs that execute reports, cubes, and dashboards to allow the request for asynchronous executions. - [Monitor and manage cubes](common-workflows/administration/monitors/monitor-and-manage-cube-caches.md). This includes viewing and changing the status of a cube. -- Additional [server](common-workflows/administration/server-management/manage-server-settings.md) and [application level settings](common-workflows/analytics/project-management/manage-project-settings.md) from MicroStrategy Developer are available in MicroStrategy Workstation. +- Additional [server](common-workflows/administration/server-management/manage-server-settings.md) and [application level settings](common-workflows/analytics/project-management/manage-project-settings.md) from MicroStrategy Developer are available in Workstation. - Ability to [request object lineage information](common-workflows/analytics/object-discovery/data-lineage-analysis-via-rest-apis.md). - Create, list, and delete multi-content subscriptions. ## 2020 Update 2 - [Asynchronously extract data from reports, cubes. and dashboards.](common-workflows/analytics/retrieve-data-from-the-intelligence-server/asynchronous-execution-of-reports-and-cubes.md) -- [Exclude raw or formatted values](https://community.microstrategy.com/s/article/KB484350-Data-API-Filtering-Enhancement-to-Improve-Performance-in-MicroStrategy-2020-Update-2) to reduce the volume of data transferred when using report, cube, and dashboard data APIs. +- [Exclude raw or formatted values](https://community.microstrategy.com/s/article/KB484350-Data-API-Filtering-Enhancement-to-Improve-Performance-in-Strategy-2020-Update-2) to reduce the volume of data transferred when using report, cube, and dashboard data APIs. - List available schedules and schedule metadata, such as schedule type and next delivery. - List subscriptions and their recipients, content, and delivery information. - Delete subscriptions. @@ -183,7 +183,7 @@ Description: What's New in the REST API. - [Push Data API has been enhanced](common-workflows/analytics/manage-datasets/make-external-data-available/create-a-dataset-incrementally-with-multiple-requests/create-a-dataset-incrementally-with-multiple-requests.md). -The ability to make external data available to MicroStrategy—often referred to as the Push Data API—has been enhanced. The newest version of the Push Data API supports complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This is accomplished by separating dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication. +The ability to make external data available to Strategy—often referred to as the Push Data API—has been enhanced. The newest version of the Push Data API supports complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This is accomplished by separating dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication. Performance was significantly improved for [Data import using the Push Data API (with multiple requests)](common-workflows/analytics/filter-data/filter-data.md), and issues were addressed for stability improvements. @@ -211,7 +211,7 @@ The REST API has been enhanced to support the ability to pass filters into the R - The stand-alone JSON Data API Server has been removed. -The [JSON Data API](common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md) is made up of four different MicroStrategy API families. All of these families are part of the MicroStrategy REST Server, which is shipped inside the MicroStrategyLibrary.war web application. +The [JSON Data API](common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md) is made up of four different Strategy API families. All of these families are part of the Strategy REST Server, which is shipped inside the MicroStrategyLibrary.war web application. ## 10.10 @@ -221,7 +221,7 @@ The [JSON Data API](common-workflows/analytics/retrieve-data-from-the-intelligen ## 10.9 -- The MicroStrategy REST API has been unified and expanded to include the following [REST API families](getting-started/rest-api-families.md): +- The Strategy REST API has been unified and expanded to include the following [REST API families](getting-started/rest-api-families.md): - Authentication API - Browsing API - Cubes API @@ -237,12 +237,12 @@ The [JSON Data API](common-workflows/analytics/retrieve-data-from-the-intelligen - System Administration API - User Management API - The /reports endpoint accepts the `requestedObjects` parameter, allowing the caller to dynamically decide which objects to include on the template when the data is returned. Previously, only the /cubes endpoint accepted the `requestedObjects` parameter. However ,there is a difference in the implementation for reports and cubes. When `requestedObjects` is null for the /reports endpoint, the result of the original template is returned and nothing is done; for the /cubes endpoint, all attributes and metrics in the working set are added to the template and the result is run. -- You can view and use all of the MicroStrategy REST API endpoints in the [MicroStrategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/). -- Quick Start Guides illustrate how to use the MicroStrategy REST API for common workflows, including [folder browsing](common-workflows/analytics/object-discovery/folder-browsing.md), [searcommon-workflows/modeling/object-discovery/search-for-objects.mdects.md), creating and modifying datasets, and [exporting a document to PDF](common-workflows/analytics/export-to-pdf.md). -- The JSON Data API and Push Data API are part of the unified MicroStrategy REST platform. This platform is contained within the MicroStrategyLibrary war file, which can be deployed to application servers. +- You can view and use all of the Strategy REST API endpoints in the [Strategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/). +- Quick Start Guides illustrate how to use the Strategy REST API for common workflows, including [folder browsing](common-workflows/analytics/object-discovery/folder-browsing.md), [searcommon-workflows/modeling/object-discovery/search-for-objects.mdects.md), creating and modifying datasets, and [exporting a document to PDF](common-workflows/analytics/export-to-pdf.md). +- The JSON Data API and Push Data API are part of the unified Strategy REST platform. This platform is contained within the StrategyLibrary war file, which can be deployed to application servers. - The current packaging of the [JSON Data API](common-workflows/analytics/retrieve-data-from-the-intelligence-server/retrieve-data-from-the-intelligence-server.md) (jar deployment) has been deprecated. It will be supported until the next platform release. -- X-MSTR-ProjectID has been added for every endpoint to provide context. The X-MSTR-AuthToken stores a reference to all of the user's sessions in memory on the MicroStrategy REST Server, abstracting project session creation and management from the end user. -- The result format for error cases has been changed. This information is available in the [MicroStrategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/). +- X-MSTR-ProjectID has been added for every endpoint to provide context. The X-MSTR-AuthToken stores a reference to all of the user's sessions in memory on the Strategy REST Server, abstracting project session creation and management from the end user. +- The result format for error cases has been changed. This information is available in the [Strategy REST API Explorer](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/). - The version information included in the contentType and Accept headers has been removed. ## 10.8 diff --git a/docusaurus.config.js b/docusaurus.config.js index 66e18286b..c4ae4c6bf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -62,7 +62,7 @@ const config = { ({ navbar: { logo: { - alt: "MicroStrategy Developer", + alt: "Strategy Developer", src: "img/dev-docs-logo.png", href: "https://microstrategy.github.io/", }, diff --git a/postman.json b/postman.json index 4aebbc9e2..6cb5e1c65 100644 --- a/postman.json +++ b/postman.json @@ -2,7 +2,7 @@ "data": [ { "id": "16131298-15ac2bcb-1b3c-4be4-81b2-c3defec602ad", - "name": "MicroStrategy REST API", + "name": "Strategy REST API", "folders_order": [ "c3e9496b-0d87-4a9e-908c-2ac6072cc4ac", "e1477e3c-37b0-4778-8729-1dd86275ee70", @@ -7975,7 +7975,7 @@ }, { "id": "16131298-ac58f345-f38f-4703-abf6-5cf4900b8ca9", - "name": "Update MicroStrategy Web configuration settings", + "name": "Update Web configuration settings", "method": "PUT", "collection": "16131298-15ac2bcb-1b3c-4be4-81b2-c3defec602ad", "folder": "16131298-c75abd47-feaf-44cb-ae44-59232bbfe566", @@ -8208,7 +8208,7 @@ }, { "id": "16131298-e2d1b1d8-b956-49ab-ae90-d1fc4200e853", - "name": "Update MicroStrategy Web configuration settings", + "name": "Update Web configuration settings", "method": "PUT", "collection": "16131298-15ac2bcb-1b3c-4be4-81b2-c3defec602ad", "folder": "16131298-c75abd47-feaf-44cb-ae44-59232bbfe566", @@ -11550,7 +11550,7 @@ }, { "id": "16131298-9ba9a108-18ee-438e-8f4f-df058f265f1b", - "name": "MicroStrategy REST API Workflows", + "name": "Strategy REST API Workflows", "folders_order": [ "b999a521-d7c7-45b6-9da8-41e22b5491ec", "6aebd4c5-6eae-4ce4-9ecc-4c8769f68208", diff --git a/scripts/convert_title_to_sentence_case.py b/scripts/convert_title_to_sentence_case.py index 0d1b73ca2..8abe0d7fa 100644 --- a/scripts/convert_title_to_sentence_case.py +++ b/scripts/convert_title_to_sentence_case.py @@ -11,7 +11,7 @@ 'microstrategy.': 'microstrategy.', 'microstrategy-rest-api-samples': 'microstrategy-rest-api-samples', './microstrategy-rest-api-explorer.md': './microstrategy-rest-api-explorer.md', - '#working-in-the-microstrategyrest-api-docs-repository': '#working-in-the-microstrategyrest-api-docs-repository', + '#working-in-the-strategyrest-api-docs-repository': '#working-in-the-strategyrest-api-docs-repository', 'embedding sdk': 'Embedding SDK', 'embedding sdk playground': 'Embedding SDK Playground', 'rest api playground': 'REST API Playground', @@ -20,7 +20,7 @@ 'samesite': 'SameSite', 'cross-origin resource sharing': 'Cross-Origin Resource Sharing', 'developer': 'Developer', - 'microstrategy developer': 'MicroStrategy Developer', + 'microstrategy developer': 'Strategy Developer', 'json data api': 'JSON Data API', 'push data api': 'Push Data API', 'api explorer': 'API Explorer', @@ -44,9 +44,9 @@ 'to the library': 'to the Library', 'modeling service': 'Modeling service', 'shared reports': "Shared Reports", - 'microstrategy docs': 'MicroStrategy Docs', + 'microstrategy docs': 'Strategy Docs', 'github docs': 'GitHub Docs', - '#keep-contributing-as-you-use-microstrategy-docs': '#keep-contributing-as-you-use-microstrategy-docs', + '#keep-contributing-as-you-use-strategy-docs': '#keep-contributing-as-you-use-strategy-docs', } def is_word_in_camel_case(word): diff --git a/sidebars.js b/sidebars.js index 0b90fb9ab..3fc93108a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1066,7 +1066,7 @@ const sidebars = { type: "doc", id: "microstrategy-rest-api-samples/microstrategy-rest-api-samples", }, - label: "MicroStrategy REST API samples", + label: "Strategy REST API samples", items: [ "microstrategy-rest-api-samples/create-reports-on-the-fly", "microstrategy-rest-api-samples/react-user-manage-sample", diff --git a/src/css/custom.css b/src/css/custom.css index 41377d689..0af779383 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -6,7 +6,7 @@ /* You can override the default Infima variables here. */ :root { - --ifm-color-primary: #D9232E; + --ifm-color-primary: #FA660F; --ifm-color-primary-dark: #29784c; --ifm-color-primary-darker: #277148; --ifm-color-primary-darkest: #205d3b; @@ -21,7 +21,7 @@ /* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { - --ifm-color-primary: #D9232E; + --ifm-color-primary: #FA660F; --ifm-color-primary-dark: #21af90; --ifm-color-primary-darker: #1fa588; --ifm-color-primary-darkest: #1a8870; @@ -31,3 +31,14 @@ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } +.navbar__logo { + display: flex; + align-items: center; + height: 100%; + margin-right: 50px; +} + +.navbar__logo img { + width: 180px; +} + diff --git a/static/img/dev-docs-logo.png b/static/img/dev-docs-logo.png index 4937fe0a0..379644427 100644 Binary files a/static/img/dev-docs-logo.png and b/static/img/dev-docs-logo.png differ diff --git a/static/img/favicon.ico b/static/img/favicon.ico index 3d1388db2..2e29ed1c5 100644 Binary files a/static/img/favicon.ico and b/static/img/favicon.ico differ