Skip to main content

Create a derived element

Available since 2021 Update 1
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 create a new derived element object through Modeling service.

Create a derived element using a list element​

You want to create a new "{Age Range} = 25 to 34, Under 24" derived element object under the Public Objects folder in the MicroStrategy Tutorial project. The folder object ID is 98FE182C2A10427EACE0CD30B6768258. The project ID is 091B51154B22036C53CFBB9958B2E8FC.

info

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

Get the project ID from GET /api/projects.

tip

Changesets are used in this workflow. For information on how to create and use changesets, see Changesets.

Create a new derived element​

Use POST /api/model/derivedElements.

The embedded elements in a derived element can be "list", "filter", "calculation" or "all_other". In this example, you are creating a derived element that has an embedded "list" element. To create a derived element with a "filter" or "calculation" element, see More examples.

tip

Each derived element must have exactly one "all_other" element.

Sample Request Header

"accept": "application/json"
"X-MSTR-AuthToken": "pisu5dkkutqfblaamdomgr00ch"
"X-MSTR-MS-Changeset": "0E9F01172ECF4BA2BB510F7B9FB4F6E8"

Sample Request Body:

tip

For more details on how to set format properties, see Format samples for derived elements.

{
  "information": {
    "name": "list derived element",
    "destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
  },
  "attribute": {
    "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
    "name": "Age Range"
  },
  "elements": [
    {
      "name": "Age under 34",
      "type": "list",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "individual_items",
        "subtotal": "individual_items",
        "includeIndividual": true
      },
      "text": "Under 24, 25 to 34",
      "elements": [
        {
          "display": "Under 24",
          "elementId": "h1"
        },
        {
          "display": "25 to 34",
          "elementId": "h2"
        }
      ]
    },
    {
      "name": "All Other",
      "type": "all_other",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "this_element",
        "subtotal": "disable"
      }
    }
  ]
}

Sample Curl:

curl -X POST "https://10.23.10.77:8443/MicroStrategyLibrary/api/model/derivedElements" -H "accept: application/json" -H "X-MSTR-AuthToken: 9rlq0e1dgg3rp237hiddruqcd0" -H "X-MSTR-MS-Changeset: EE48CD8879C44A03B18660AE7AFC8F68" -H "Content-Type: application/json" -d "{\"information\":{\"subType\":\"consolidation_element\",\"name\":\"list derived element\",\"destinationFolderId\":\"98FE182C2A10427EACE0CD30B6768258\"},\"attribute\":{\"objectId\":\"5603951E4FE1BC04A44E44B85BBB8ED2\",\"subType\":\"attribute\",\"name\":\"Age Range\"},\"elements\":[{\"name\":\"Age under 34\",\"type\":\"list\",\"format\":{\"header\":[],\"values\":[]},\"options\":{\"display\":\"individual_items\",\"subtotal\":\"individual_items\",\"includeIndividual\":true},\"text\":\"Under 24, 25 to 34\",\"elements\":[{\"display\":\"Under 24\",\"elementId\":\"h1\"},{\"display\":\"25 to 34\",\"elementId\":\"h2\"}]},{\"id\":\"087A10774C48EA58DEBDEB8C79C7AD53\",\"name\":\"All Other\",\"type\":\"all_other\",\"format\":{\"header\":[],\"values\":[]},\"options\":{\"display\":\"this_element\",\"subtotal\":\"disable\"}}]}"

Sample Response Body:

You can view the new derived element's definition in the body of the response.

{
  "information": {
    "versionId": "A990C4E70AD0423FAF537A1727029F14",
    "primaryLocale": "en-US",
    "objectId": "5ED9E1F465664B7191D186515960E008",
    "subType": "consolidation_element",
    "name": "list derived element",
    "destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
  },
  "attribute": {
    "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
    "subType": "attribute",
    "name": "Age Range"
  },
  "elements": [
    {
      "id": "772CE3142D5D40B38BFC57BC26664143",
      "name": "Age under 34",
      "type": "list",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "individual_items",
        "subtotal": "individual_items",
        "includeIndividual": true
      },
      "text": "Under 24, 25 to 34",
      "elements": [
        {
          "display": "Under 24",
          "elementId": "h1"
        },
        {
          "display": "25 to 34",
          "elementId": "h2"
        }
      ]
    },
    {
      "id": "B9A54B5DE9FB4D4E8FCEEBFECB1A1808",
      "name": "All Other",
      "type": "all_other",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "this_element",
        "subtotal": "disable"
      }
    }
  ]
}

Sample Response Code: 201 (A new derived element is created successfully in the changeset.)

More examples​

In the above workflow, you created a derived element with "list" element. This section contains more examples of how to create a derived element with a "filter" or "calculation" element.

Create a derived element using a filter element​

In a derived element, only attribute form qualifications and attribute element list qualifications are supported for filters. See those pages for more samples.

Create an {Age Range} = 25 to 34, Under 24 derived element with a filter element.

Sample Response Body:

{
  "information": {
    "name": "filter derived element",
    "destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
  },
  "attribute": {
    "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
    "name": "Age Range"
  },
  "elements": [
    {
      "name": "FilterElementList",
      "type": "filter",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "individual_items",
        "subtotal": "this_element",
        "includeIndividual": false
      },
      "qualification": {
        "text": "{Age Range} = 25 to 34, Under 24",
        "tree": {
          "type": "predicate_element_list",
          "predicateId": "2BD916DF10BA4B5CB8CFFF0A3E1F9729",
          "predicateTree": {
            "attribute": {
              "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
              "subType": "attribute",
              "name": "Age Range"
            },
            "elements": [
              {
                "display": "25 to 34",
                "elementId": "h2"
              },
              {
                "display": "Under 24",
                "elementId": "h1"
              }
            ],
            "function": "in"
          }
        }
      }
    },
    {
      "id": "087A10774C48EA58DEBDEB8C79C7AD53",
      "name": "All Other",
      "type": "all_other",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "this_element",
        "subtotal": "disable"
      }
    }
  ]
}

Create a derived element using a calculation element​

Create an Average({Age Range=Under 24}, 4.0, 5.0) derived element with a calculation element.

Sample Response Body:

{
  "information": {
    "name": "calculation derived element",
    "destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
  },
  "attribute": {
    "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
    "name": "Age Range"
  },
  "elements": [
    {
      "name": "New Calculation 1",
      "type": "calculation",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "this_element",
        "subtotal": "this_element",
        "includeIndividual": false
      },
      "expression": {
        "text": "Average(Under 24,4,5)",
        "tree": {
          "function": "average",
          "children": [
            {
              "type": "elements_object",
              "elements": [
                {
                  "display": "Under 24",
                  "elementId": "h1",
                  "attribute": {
                    "objectId": "5603951E4FE1BC04A44E44B85BBB8ED2",
                    "subType": "attribute",
                    "name": "Age Range"
                  }
                }
              ]
            },
            {
              "type": "constant",
              "variant": {
                "type": "double",
                "value": "4.0"
              }
            },
            {
              "type": "constant",
              "variant": {
                "type": "double",
                "value": "5.0"
              }
            }
          ],
          "type": "operator"
        }
      }
    },
    {
      "name": "All Other",
      "type": "all_other",
      "format": {
        "header": [],
        "values": []
      },
      "options": {
        "display": "individual_items",
        "subtotal": "this_element"
      }
    }
  ]
}