Retrieve a fact's definition within a changeset

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 retrieve a fact's definition within a changeset.

tip

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

1. Create a changeset.
2. Get a fact's definition within a changeset.
3. Delete the changeset.

You want to get the definition of the "Profit" fact object. The object ID of the fact is FDD652E7444ADD7AB6B25F9C1FA15F92 in the "MicroStrategy Tutorial" project. 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.

Get a fact's definition within a changeset

Endpoint: GET /api/model/facts/{factId}.

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "ouddou5qdd421ndfpjqd6ssman"
"X-MSTR-MS-Changeset": "FA282B2D8EFD4327A652FE09B32A439D"

Sample Request Body: Empty

Sample Curl:

curl -X GET "https://demo.microstrategy.com/MicroStrategyLibrary/api/model/facts/FDD652E7444ADD7AB6B25F9C1FA15F92" -H "accept: application/json" -H "X-MSTR-AuthToken: ouddou5qdd421ndfpjqd6ssman" -H "X-MSTR-MS-Changeset: FA282B2D8EFD4327A652FE09B32A439D"

Sample Response Body:

You can view the fact's definition in the body of the response.

{
  "information": {
    "dateCreated": "2021-03-22T18:05:47.821Z",
    "dateModified": "2021-03-22T18:05:47.821Z",
    "versionId": "3FF0319C5B496906BE3EF5A0F825CE77",
    "primaryLocale": "en-US",
    "objectId": "FDD652E7444ADD7AB6B25F9C1FA15F92",
    "subType": "fact",
    "name": "Profit"
  },
  "dataType": {
    "type": "float",
    "precision": 53,
    "scale": 0
  },
  "expressions": [
    {
      "expressionId": "7A4ABE8CAC6F11D58AD900C04FF2C54C",
      "expression": {
        "text": "TOT_DOLLAR_SALES - TOT_COST"
      },
      "tables": [
        {
          "objectId": "9A28CFCC42DB8E9627D547975958C138",
          "subType": "logical_table",
          "name": "CITY_MNTH_SLS"
        },
        {
          "objectId": "54D82D5B4BD115DA313C03A5742900AE",
          "subType": "logical_table",
          "name": "CUSTOMER_SLS"
        }
      ]
    }
  ],
  "entryLevel": []
}

Response Code: 200 (The fact's definition is returned successfully.)