MicroStrategy REST API API Documentation
Read a time period template
GET {{baseUrl}}/api/model/timePeriodTemplates/:timePeriodTemplateId
This API gets the definition for a specified time period template. 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 period templates.
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-12T06:32:12.000Z",
"versionId": "95D48CF245A92732229A1A96B4E5E7FB",
"acg": 255,
"primaryLocale": "en-US",
"objectId": "38EC4C89276A4FE98953E116B55C76B2",
"subType": "time_period_template",
"name": "Percent Change",
"ownerId": "54F3D26011D2896560009A8E67019608",
"description": "Percent Change"
},
"category": "percent_change"
} |
Curl
curl -X GET 'baseUrl/api/model/timePeriodTemplates/:timePeriodTemplateId' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Changeset: rd_changesetId'
ENDPOINTS