Skip to main content

Retrieve a prompt's definition

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 prompt's definition.

You want to get the definition of the "Call Center in USA" prompt object. The object ID of the prompt is 2804B5284AFF95E8E0EEB4AC09B5B972 in the MicroStrategy Tutorial project. The project ID is B7CA92F04B9FAE8D941C3E9B7E0CD754.

info

An authorization token allows the API layer to hide internal session-related implementations such as managing different project-specific sessions. Once the REST API layer has validated the user's credentials using the specified authentication mode, it initiates a session with the Intelligence server and creates a unique authorization token for the client.

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

tip

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

Get the project ID from GET /api/projects.

Get the prompt's definition within the changeset​

Use GET /api/model/prompts/{PromptID}.

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "4bb7n1dhjo860e7tlpchg57hl"
"X-MSTR-MS-Changeset": "2A131744C91B4915B54A61FFDC528F62"

Sample Request Body: Empty

Sample Curl:

curl -X GET "http://10.23.7.118:8080/MicroStrategyLibrary/api/model/prompts/2804B5284AFF95E8E0EEB4AC09B5B972" -H "accept: application/json" -H "X-MSTR-AuthToken": "4bb7n1dhjo860e7tlpchg57hl" -H "X-MSTR-MS-Changeset: 2A131744C91B4915B54A61FFDC528F62"

Sample Response Body:

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

{
  "information": {
    "dateCreated": "2021-02-19T09:04:10.693Z",
    "dateModified": "2021-02-19T09:05:09.833Z",
    "versionId": "6AACDA444F24436837E717AC1AB54F58",
    "primaryLocale": "en-US",
    "objectId": "2804B5284AFF95E8E0EEB4AC09B5B972",
    "subType": "prompt_elements",
    "name": "Call Center in USA"
  },
  "title": "Call Center in USA",
  "instruction": "Choose elements of Call Center.",
  "question": {
    "attribute": {
      "objectId": "8D679D3511D3E4981000E787EC6DE8A4",
      "subType": "attribute",
      "name": "Call Center"
    },
    "listAllElements": false,
    "filter": {
      "objectId": "4C46C8CB43D1BCD0347E10BA3004E70D",
      "subType": "filter",
      "name": "CountryInUSA"
    }
  },
  "defaultAnswer": {
    "elements": [
      {
        "display": "San Diego",
        "elementId": "h2"
      },
      {
        "display": "San Francisco",
        "elementId": "h4"
      },
      {
        "display": "Atlanta",
        "elementId": "h1"
      },
      {
        "display": "Washington, DC",
        "elementId": "h5"
      },
      {
        "display": "Salt Lake City",
        "elementId": "h6"
      }
    ]
  },
  "restriction": {
    "required": false,
    "allowPersonalAnswers": "none",
    "min": 2,
    "max": 5
  }
}

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