JetBrains Space Help

Public Holidays

Create calendar

post /api/http/public-holidays/calendars

Create a public holiday calendar for a location.

Request arguments
object with fields:
  • name: string( Required )

  • location: string( Required )

Get all calendars

get /api/http/public-holidays/calendars

Get all public holiday calendars.

Request arguments
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:
  • next: string( Required )

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

  • data: array of PublicHolidayCalendarRecord( Required )

Import

post /api/http/public-holidays/calendars/import

Import holidays in a public holiday calendar, using an attachment (.ics format) as the source.

Request arguments
object with fields:
  • calendar: string( Required )

  • attachmentId: string( Required )

Response
string

Update calendar

patch /api/http/public-holidays/calendars/{id}

Update an existing public holiday calendar.

Request arguments
id: string (Path) ( Required )
object with fields:
  • name: string( Required )

  • location: string( Required )

Delete calendar

delete /api/http/public-holidays/calendars/{id}

Delete

Request arguments
id: string (Path) ( Required )
Response
No arguments

Create holiday

post /api/http/public-holidays/holidays

Add a holiday to a public holiday calendar, and specify if it is a working day or not.

Request arguments
object with fields:
  • calendar: string( Required )

  • name: string( Required )

  • date: string (format: full-date)( Required )

  • workingDay: boolean( Required )

  • halfDay: boolean( Nullable and Optional , defaults to false)

Get all holidays

get /api/http/public-holidays/holidays

Get/search all holidays in a public holiday calendar. Parameters are applied as 'AND' filters.

Request arguments
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
calendar: string (Query) ( Nullable and Optional , defaults to null)
location: string (Query) ( Nullable and Optional , defaults to null)
startDate: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
endDate: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:
  • next: string( Required )

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

  • data: array of PublicHoliday( Required )

Update holiday

patch /api/http/public-holidays/holidays/{id}

Update a holiday in a public holiday calendar. Optional parameters will be ignored when not specified, and updated otherwise.

Request arguments
id: string (Path) ( Required )
object with fields:
  • calendar: string( Nullable and Optional , defaults to null)

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

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

  • workingDay: boolean( Nullable and Optional , defaults to null)

  • halfDay: boolean( Nullable and Optional , defaults to false)

Delete holiday

delete /api/http/public-holidays/holidays/{id}

Delete a holiday from a public holiday calendar.

Request arguments
id: string (Path) ( Required )
Response
No arguments

Get all profile holidays

get /api/http/public-holidays/holidays/profile-holidays

Get holidays observed in the location(s) of the current profile during the selected period.

Request arguments
startDate: string (format: full-date) (Query) ( Required )
endDate: string (format: full-date) (Query) ( Required )
profile: string (Query) ( Required )
workingDays: boolean (Query) ( Nullable and Optional , defaults to null)
Response
array of PublicHoliday
get /api/http/public-holidays/holidays/related-holidays

Search related holidays in all public holiday calendars, during the selected period.

Request arguments
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
startDate: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
endDate: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:
  • next: string( Required )

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

  • data: array of PublicHoliday( Required )

Last modified: 15 March 2021