Get project definition and advanced properties

Available since 2021 Update 8

tip

You can try out this workflow at REST API Playground.

Learn more about MicroStrategy REST API Playground here.

This workflow sample demonstrates how to retrieve project's definition and its advanced properties.

You want to get the advanced properties of the MicroStrategy Tutorial Project object. The object ID is 6851110C470AF40EB46B559D5098F309.

info

Get the authorization token needed to execute the request with POST /api/auth/login.

Get the project ID from GET /api/projects.

Retrieve the advanced properties using GET /api/model/projects/{projectId}?showAdvancedProperties=true.

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "cs0intmf1fgij7ao0v2v0j48e5"
"X-MSTR-ProjectID": "B7CA92F04B9FAE8D941C3E9B7E0CD754"

Sample Request Body: Empty

Sample Curl:

curl -X GET "https://demo.microstrategy.com/MicroStrategyLibrary/api/model/projects/6851110C470AF40EB46B559D5098F309?showAdvancedProperties=true" \
-H "accept: application/json" \
-H "X-MSTR-AuthToken: cs0intmf1fgij7ao0v2v0j48e5" \
-H "X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754"

Sample Response Body:

You can view project's definition and its advanced properties in the response.

{
  "information": {
    "dateCreated": "2021-05-27T01:59:49.000Z",
    "dateModified": "2022-11-15T13:36:45.627Z",
    "versionId": "08725E361F499117604F26BA8230223C",
    "acg": 255,
    "primaryLocale": "en-US",
    "objectId": "6851110C470AF40EB46B559D5098F309",
    "subType": "project",
    "name": "MicroStrategy Tutorial",
    "description": "MicroStrategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed."
  },
  "advancedProperties": {
    "vldbProperties": {
      "[AnalyticalEngineProperties].[ConsolidationSubtotal]": {
        "name": "ConsolidationSubtotal",
        "type": "boolean",
        "value": "true",
        "resolvedLocation": "default",
        "isInherited": true
      },
      "[AnalyticalEngineProperties].[CustomGroupDisplayForJointElments]": {
        "name": "CustomGroupDisplayForJointElments",
        "type": "boolean",
        "value": "false",
        "resolvedLocation": "default",
        "isInherited": true
      }
    }
  }
}

Response Code: 200 (The project's definition and its advanced properties were returned successfully.)