Read a timezone
GET {{baseUrl}}/api/model/timezones/:timezoneId
This API gets the definition for a specified timezone. An information field describes the common object information such as the object ID, creation time, version ID, etc. The baseTimezone field is a reference to system timezone
object, and it only exists for custom timezones. The currentOffset shows the number of seconds current timezone is ahead of of behind UTC. Since timezones are configuration objects, the project ID is not required to return a timezone's definition in metadata.
The changeset ID is required to return a timezone's definition within a specific changeset. A changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"information": {
"versionId": "E99EB9A0F5DD4DA4AFDF11AD6590728A",
"primaryLocale": "en-US",
"objectId": "C32DEC3E17A8489AB3EF1D5AB189266A",
"subType": "timezone_custom",
"name": "new timezone",
"ownerId": "7FC05A65473CE2FD845CE6A1D3F13233",
"destinationFolderId": "706CB221A9F24E8596B657DCF7E4140F"
},
"baseTimezone": {
"objectId": "1D18D39B4594CFAF60A6C1B2F48164E8",
"subType": "timezone_system",
"name": "America New York time"
},
"currentOffset": -14400
} |
ENDPOINTS