MicroStrategy REST API API Documentation
Read a time period
GET {{baseUrl}}/api/model/timePeriods/:timePeriodId
This API gets the definition for a specified time period. An information field describes the common object information such as the object ID, creation time, version ID, etc. The category field is used to distinguish different kinds of time periods.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"information": {
"dateCreated": "2023-10-12T06:32:12.000Z",
"dateModified": "2023-10-17T09:35:45.000Z",
"versionId": "0F43032A4CD5F0F7297317ADCE7728E4",
"acg": 255,
"primaryLocale": "en-US",
"objectId": "10181F3D2B76440EB2FDEA8AE9E5BE30",
"subType": "time_period_system",
"name": "Actual",
"ownerId": "54F3D26011D2896560009A8E67019608",
"description": "Actual"
},
"category": "actual"
} |
Curl
curl -X GET 'baseUrl/api/model/timePeriods/:timePeriodId' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Changeset: rd_changesetId'
ENDPOINTS