JetBrains Space Help

Calendars

Get all absence events

get /api/http/calendars/absence-events

Get/search absences. Parameters are applied as ' AND ' filters.

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

Response

array of AbsenceEvent

Get all birthday events

get /api/http/calendars/birthday-events

Get/search birthdays. Parameters are applied as ' AND ' filters.

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

Response

array of BirthdayEvent

Get all starred birthday events

get /api/http/calendars/birthday-events/starred

Get/search birthdays in a specific time period for starred profiles.

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

Response

array of BirthdayEvent

Update event participation

patch /api/http/calendars/event-participations/{id}

Update RSVP / calendar event participation status for a calendar event attached to an article

Request arguments

id: string (Path) Required

object with fields:

Get all events

get /api/http/calendars/events

Get calendar events attached to an article in a specific time period

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

Response

array of MeetingRecord

Get event

get /api/http/calendars/events/{id}

Get a calendar event attached to an article

Request arguments

id: string (Path) Required

Get all holidays

get /api/http/calendars/holidays

Get/search holidays. Parameters are applied as ' AND ' filters.

Request arguments

startDate: string (format: full-date) (Query) Required

endDate: string (format: full-date) (Query) Required

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

workingDays: boolean (Query) ( Nullable and Optional , defaults to null)

Response

array of HolidaysEvent

Create meeting

post /api/http/calendars/meetings

Create a meeting

Rights, that may be checked: Update meetings

Request arguments

object with fields:

  • summary: string Required

  • description: string ( Nullable and Optional , defaults to null)

  • occurrenceRule: CalendarEventSpec Required

  • locations: array of string ( Optional , defaults to [])

  • profiles: array of string ( Optional , defaults to [])

  • externalParticipants: array of string ( Optional , defaults to [])

  • teams: array of string ( Optional , defaults to [])

  • visibility: MeetingVisibility ( Optional , defaults to "EVERYONE")

  • modificationPreference: MeetingModificationPreference ( Optional , defaults to "PARTICIPANTS")

  • joiningPreference: MeetingJoiningPreference ( Optional , defaults to "NOBODY")

  • notifyOnExport: boolean ( Optional , defaults to true)

  • organizer: string ( Nullable and Optional , defaults to null)

  • conferenceData: EventConferenceData ( Nullable and Optional )

  • attachments: array of MeetingAttachment ( Nullable and Optional , defaults to null)

  • calendarId: CalendarIdentifier ( Nullable and Optional , defaults to null)

Response

DTO_Meeting

Get all meetings

get /api/http/calendars/meetings

Search meetings by name, location, time period and other parameters. Parameters are applied as ' AND ' filters while values in lists of locations, profiles and teams have ' OR ' semantics.

Rights, that may be checked: View meetings

Request arguments

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

summaryQuery: string (Query) ( Optional , defaults to "")

locationsQuery: array of string (Query) ( Optional , defaults to [])

startingAfter: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

endingAfter: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

endingBefore: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

startingBefore: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

profiles: array of string (Query) ( Optional , defaults to [])

teams: array of string (Query) ( Optional , defaults to [])

organizer: string (Query) ( Nullable and Optional , defaults to null)

includePrivate: boolean (Query) ( Optional , defaults to false)

includeArchived: boolean (Query) ( Optional , defaults to false)

includeMeetingInstances: boolean (Query) ( Optional , defaults to true)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of DTO_Meeting Required

Get next meeting occurrence

get /api/http/calendars/meetings/next-occurrence

Search for the next meeting occurrence that starts after the provided time point or after the current time if it is not specified

Rights, that may be checked: View meetings

Request arguments

meetingId: string (Query) Required

since: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

Get meeting occurrences for period

get /api/http/calendars/meetings/occurrences

Search for occurrences of a meeting that start in the provided time interval. Interval limits are inclusive, response is limited by the first 1_000 results by default.

Rights, that may be checked: View meetings

Request arguments

meetingId: string (Query) Required

since: string (format: date-time) (Query) Required

until: string (format: date-time) (Query) Required

limit: integer (format: int32) (Query) ( Nullable and Optional , defaults to null)

Response

array of MeetingOccurrenceTime

Get meeting occurrences for period for multiple meetings

get /api/http/calendars/meetings/occurrences-by-meeting

Search for occurrences of a meeting that start in the provided time interval. Interval limits are inclusive, response is limited by the first 1_000 results by default ( per meeting ) .

Rights, that may be checked: View meetings

Request arguments

meetingIds: array of string (Query) Required

since: string (format: date-time) (Query) Required

until: string (format: date-time) (Query) Required

limit: integer (format: int32) (Query) ( Nullable and Optional , defaults to null)

Response

array of MeetingWithOccurrenceTime

Get meeting participation statuses for profiles

get /api/http/calendars/meetings/participation-statuses

Rights, that may be checked: View meetings

Request arguments

id: string (Query) Required

profileIds: array of string (Query) Required

Response

array of EventParticipationStatus

Get rsvp statuses for external users

get /api/http/calendars/meetings/participation-statuses-external

Rights, that may be checked: View meetings

Request arguments

id: string (Query) Required

emails: array of string (Query) Required

Response

array of EventParticipationStatus

Get profile participation statuses for meetings

get /api/http/calendars/meetings/profile-participation

Rights, that may be checked: View meetings

Request arguments

profileId: string (Query) Required

events: array of string (Query) Required

Response

array of object with fields:

Get profile participation status records for meetings

get /api/http/calendars/meetings/profile-participation-records

Rights, that may be checked: View meetings

Request arguments

profileId: string (Query) Required

events: array of string (Query) Required

Response

array of DTO_MeetingRSVP

Get meeting

get /api/http/calendars/meetings/{id}

Rights, that may be checked: View meetings

Request arguments

id: string (Path) Required

Response

DTO_Meeting

Update meeting

patch /api/http/calendars/meetings/{id}

Patch a meeting. Only not-null parameters and not empty diffs will be applied.

Rights, that may be checked: Update meetings

Request arguments

id: string (Path) Required

object with fields:

  • summary: string ( Nullable and Optional , defaults to null)

  • description: string ( Nullable and Optional , defaults to null)

  • occurrenceRule: CalendarEventSpec ( Nullable and Optional , defaults to null)

  • locationsDiff: Diff ( Optional )

  • profilesDiff: Diff ( Optional )

  • externalParticipantsDiff: Diff ( Optional )

  • teamsDiff: Diff ( Optional )

  • visibility: MeetingVisibility ( Nullable and Optional , defaults to null)

  • modificationPreference: MeetingModificationPreference ( Nullable and Optional , defaults to null)

  • joiningPreference: MeetingJoiningPreference ( Nullable and Optional , defaults to null)

  • notifyOnExport: boolean ( Optional , defaults to true)

  • organizer: string ( Nullable and Optional , defaults to null)

  • targetDate: string (format: date-time) ( Nullable and Optional , defaults to null)

  • modificationKind: RecurrentModification ( Optional , defaults to "All")

  • conferenceData: EventConferenceData ( Nullable and Optional , defaults to null)

  • attachments: array of MeetingAttachment ( Nullable and Optional , defaults to null)

  • calendarId: CalendarIdentifier ( Nullable and Optional , defaults to null)

Response

DTO_Meeting

Delete meeting

delete /api/http/calendars/meetings/{id}

Rights, that may be checked: Update meetings

Request arguments

id: string (Path) Required

targetDate: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

modificationKind: RecurrentModification (Query) ( Optional , defaults to "All")

Response

DTO_Meeting

Update profile participation status

patch /api/http/calendars/meetings/{id}/participation-status

Update profile participation status for a meeting

Rights, that may be checked: Update meeting RSVP status

Request arguments

id: string (Path) Required

object with fields:

Response

DTO_Meeting

Get all membership events

get /api/http/calendars/membership-events

Get/search membership events. Parameters are applied as ' AND ' filters.

Rights, that may be checked: View memberships

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

Response

array of MembershipEvent

Get all non working days events

get /api/http/calendars/non-working-days-events

Get/search non-working day events. Parameters are applied as ' AND ' filters.

Request arguments

dateFrom: string (format: full-date) (Query) Required

dateTo: string (format: full-date) (Query) Required

member: string (Query) ( Nullable and Optional , defaults to null)

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

Response

array of NonWorkingDaysEvent

Last modified: 28 September 2022