MicroStrategy REST API API Documentation
List available schedules for specified contents
POST {{baseUrl}}/api/schedules/results
Get a list of available schedules for a list of contents within a given project. This endpoint returns the ID and name of the available schedules. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You retrieve the available schedules list by specifying the list of contents (content ID and content type) in the request body.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID | |
Content-Type
|
string |
RESPONSES
status OK
| {
"schedules": [
{
"id": "FF7BB3C811D501F0C00051916B98494F",
"name": "All the Time"
},
{
"id": "FF7BB3BC11D501F0C00051916B98494F",
"name": "At Close of Business (Weekday)"
}
]
} |
Curl
curl -X POST 'baseUrl/api/schedules/results?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json'
ENDPOINTS