Overview

Get Calendar Definitions.

Request

POST /Calendar/getCalendarDefs

Request Arguments

    {
        calendars:[
            {
                "id": "6a6ecbae-535c-11ec-b080-0242ac140008",
                "calendarId": "6a6ecbae-535c-11ec-b080-0242ac140008",
                "userId": "1"
            },
            {
                "id": "6a7358cc-535c-11ec-9ff7-0242ac140008",
                "calendarId": "6a7358cc-535c-11ec-9ff7-0242ac140008",
                "userId": "1"
            }
        ]
    }

Response

The response will be an array of objects containing the calendar definitions:
Name Type Description
calendarId string Calendar ID
id string Calendar ID
assigned_user_id string User ID
name string Calendar definition name
color string Color value of events
module string Events module
start_field string Field used for event start
end_field string Field used for event end
dblclick_event string Double click informations
calendar_type string Calendar type: either made for main calendar or dashlets
allow_create bool Allow create
allow_update bool Allow update
allow_delete bool Allow delete
objName string Object name of the module

Response Example

[
    {
        "calendarId": "6a6ecbae-535c-11ec-b080-0242ac140008",
        "id": "6a6ecbae-535c-11ec-b080-0242ac140008",
        "assigned_user_id": "1",
        "name": "Calls",
        "color": "#c0edff",
        "module": "Calls",
        "start_field": "date_start",
        "end_field": null,
        "dblclick_event": "detail:self:id",
        "calendar_type": "^main^",
        "allow_create": true,
        "allow_update": true,
        "allow_delete": true,
        "objName": "Call"
    },
    {
        "calendarId": "6a7358cc-535c-11ec-9ff7-0242ac140008",
        "id": "6a7358cc-535c-11ec-9ff7-0242ac140008",
        "assigned_user_id": "1",
        "name": "Meetings",
        "color": "#c6ddff",
        "module": "Meetings",
        "start_field": "date_start",
        "end_field": null,
        "dblclick_event": "detail:self:id",
        "calendar_type": "^main^",
        "allow_create": true,
        "allow_update": true,
        "allow_delete": true,
        "objName": "Meeting"
    },
    {
        "calendarId": "6a778dca-535c-11ec-b946-0242ac140008",
        "id": "6a778dca-535c-11ec-b946-0242ac140008",
        "assigned_user_id": "1",
        "name": "Tasks",
        "color": "#e2d4fd",
        "module": "Tasks",
        "start_field": "date_start",
        "end_field": "date_due",
        "dblclick_event": "detail:self:id",
        "calendar_type": "^main^",
        "allow_create": true,
        "allow_update": true,
        "allow_delete": true,
        "objName": "Task"
    },
]

Change Log

Version Change
v11_14 Added /Calendar/modules POST endpoint.
v11_15 Added objName