Skip to Content
bpms.ai
ReferenceCalendars

Read the calendar settings

GET
/api/v1/calendars/settings

Reads the calendar compatibility profile of the tenant of the request and the calendars that override it. A tenant that never set it has LEGACY_3X, the 3.x computation. Requires the 3.x authority 6.1.7.6 (view calendars).

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Response Body

The settings of the tenant

application/json
  1. response

The calendar compatibility profile of the tenant and the calendars that override it

calendars?array<>

Calendars that use another profile than the tenant, by id

compatibility?string

Profile of every calendar without an override; LEGACY_3X until set

Value in"LEGACY_3X""CORRECTED"
Example Request
curl -X GET 'https://bpms.bpms.work/api/v1/calendars/settings'
Example Response
{  "calendars": [    {      "calendarId": 900,      "compatibility": "CORRECTED"    }  ],  "compatibility": "LEGACY_3X"}