Retrieve a scope filter's definition

Available since Strategy ONE (November 2025)

tip

You can try out this workflow at REST API Playground.

Learn more about Strategy REST API Playground here.

This workflow sample demonstrates how to retrieve a scope filter's definition.

Retrieve a scope filter's definition

You want to get the definition of the scope filter with a "Customer last name equals Smith" qualification. The scope filter ID is 639FF974194E4469896352772CB0B379. The project ID is B7CA92F04B9FAE8D941C3E9B7E0CD754.

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 scope filter's definition using GET /api/model/scopeFilters/{scopeFilterId}.

Sample Request Header:

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

Sample Request Body: Empty

Sample Curl:

curl -X GET "https://demo.microstrategy.com/MicroStrategyLibrary/api/model/scopeFilters/639FF974194E4469896352772CB0B379" -H "accept: application/json" -H "X-MSTR-AuthToken: 4bb7n1dhjo860e7tlpchg57hl" -H "X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754"

Sample Response Body:

You can view the scope filter's definition in the response body.

{
  "information": {
    "dateCreated": "2025-10-25T05:20:36.565Z",
    "dateModified": "2025-10-25T05:41:55.668Z",
    "versionId": "0884D416481A675FA285D3B8E85FA896",
    "acg": 255,
    "primaryLocale": "en-US",
    "objectId": "639FF974194E4469896352772CB0B379",
    "subType": "global_filter",
    "name": "new scope filter"
  },
  "controlType": "view",
  "conditions": [
    {
      "expressionType": "attribute",
      "question": {
        "predefinedObjects": [
          {
            "objectId": "8D679D3C11D3E4981000E787EC6DE8A4",
            "subType": "attribute",
            "name": "Customer"
          }
        ],
        "displayForms": "all_forms"
      },
      "defaultAnswer": {
        "qualification": {
          "text": "Customer ({Last Name}) = \"Smith\"",
          "tree": {
            "type": "predicate_form_qualification",
            "predicateId": "011453986C074889829F6CADA7F7E129",
            "predicateText": "Customer ({Last Name}) = \"Smith\"",
            "predicateTree": {
              "function": "equals",
              "parameters": [
                {
                  "parameterType": "constant",
                  "constant": {
                    "type": "string",
                    "value": "Smith"
                  }
                }
              ],
              "attribute": {
                "objectId": "8D679D3C11D3E4981000E787EC6DE8A4",
                "subType": "attribute",
                "name": "Customer"
              },
              "form": {
                "objectId": "8D67A35B11D3E4981000E787EC6DE8A4",
                "subType": "attribute_form_system",
                "name": "Last Name"
              },
              "dataLocale": "en-US"
            }
          }
        }
      },
      "restriction": {
        "required": false,
        "allowPersonalAnswers": "none"
      },
      "id": "FD94DF5EFD7743EEAEF0ED32151A14E8"
    }
  ]
}

Response Code: 200 (The scope filter's definition was returned successfully.)