Skip to Content
bpms.ai
ReferenceCalendars

Replace the calendar settings

PUT
/api/v1/calendars/settings

Replaces the profile of the tenant of the request and every override; a calendar left out follows the tenant again. Each override names a live calendar of the tenant. Only due dates computed afterwards change; stored dates never do. Requires the 3.x authority 6.1.7.3 (save calendars).

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Request Body

The whole settings

application/json
  1. body
calendars?array<>

Every override; calendars left out follow the tenant

compatibility?string

Profile of the tenant

Value in"LEGACY_3X""CORRECTED"

Response Body

The stored settings

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 PUT 'https://bpms.bpms.work/api/v1/calendars/settings' \  -H 'Content-Type: application/json' \  -d '{  "calendars": [    {      "calendarId": 900,      "compatibility": "CORRECTED"    }  ],  "compatibility": "LEGACY_3X"}'
Example Response
{  "calendars": [    {      "calendarId": 900,      "compatibility": "CORRECTED"    }  ],  "compatibility": "LEGACY_3X"}