Skip to main content

Update a custom calendar object

Available since 2021 Update 7

This workflow sample demonstrates how to update an existing custom calendar object through the Modeling service.

You want to update the existing Custom Calendar with object ID 66FBD8D81F254B63B3C74B599EC7BB47 with the following changes:

  • Modify the weekStartDay to Monday
  • Rename the calendar to "Chinese Calendar"
  • Modify the calendarEnd to 20
info

Obtain the authorization token needed to execute the request using POST /api/auth/login.

Since calendar objects are configuration objects, you must set the project ID as an empty string.

tip

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

Update an existing custom calendar​

Endpoint: PUT /api/model/calendars/{calendarId}

System calendars cannot be updated through API.

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "qr56qbrjb59oq5m193v8avjsdv"
"X-MSTR-MS-Changeset": "46FB9631EB134C9F992BC2F9E92DDC50"

Sample Request Body:

{
  "information": {
    "name": "Chinese Calendar",
    "subType": "calendar_custom"
  },
  "baseCalendar": {
    "objectId": "1414DF67F20B4E4F910E418C8DCE7274",
    "subType": "calendar_system"
  },
  "tablePrefix": "MSTR_",
  "calendarBegin": {
    "staticYear": "2022"
  },
  "calendarEnd": {
    "dynamicYearOffset": 20
  },
  "weekStartDay": "Monday"
}

Sample Curl:

curl -X 'PUT' \
  'https://env-294821.customer.cloud.microstrategy.com/MicroStrategyLibrary/api/model/calendars/015FB8D4CF30413DAF120DCDE4C2F85C' \
  -H 'accept: application/json' \
  -H 'X-MSTR-AuthToken: qr56qbrjb59oq5m193v8avjsdv' \
  -H 'X-MSTR-MS-Changeset: 46FB9631EB134C9F992BC2F9E92DDC50' \
  -H 'Content-Type: application/json' \
  -d '{
  "information": {
    "name": "Chinese Calendar",
    "subType": "calendar_custom"
  },
  "baseCalendar": {
    "objectId": "1414DF67F20B4E4F910E418C8DCE7274",
    "subType": "calendar_system"
  },
  "tablePrefix": "MSTR_",
  "calendarBegin": {
    "staticYear": "2022"
  },
  "calendarEnd": {
    "dynamicYearOffset": 20
  },
  "weekStartDay": "Monday"
}'

Sample Response Body:

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

{
  "information": {
    "dateCreated": "2022-07-22T04:44:03.000Z",
    "dateModified": "2022-08-03T06:46:42.019Z",
    "versionId": "0CA4BAE39B44F1212BD6F8B843E736B6",
    "acg": 255,
    "primaryLocale": "en-US",
    "objectId": "015FB8D4CF30413DAF120DCDE4C2F85C",
    "subType": "calendar_custom",
    "name": "Chinese Calendar",
    "ownerId": "7E7D7CAA4F1F36CAE1DC01B7220EE3C1",
    "description": "custom calendar",
    "destinationFolderId": "636200232691438EA7CA6CB26CCDB4EF"
  },
  "baseCalendar": {
    "objectId": "1414DF67F20B4E4F910E418C8DCE7274",
    "subType": "calendar_system",
    "name": "Gregorian Calendar"
  },
  "tablePrefix": "MSTR_",
  "calendarBegin": {
    "staticYear": "2022"
  },
  "calendarEnd": {
    "dynamicYearOffset": 20
  },
  "weekStartDay": "Monday"
}

Response Code: 200 (Calendar is successfully updated in the changeset.)

The following fields of a custom calendar could be updated using PUT API.

  • information.name
  • baseCalendar.objectId
  • tablePrefix
  • calendarBegin
  • calendarEnd
  • weekStartDay