calendars

17 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List the calendars this user may see#

GET/calendar/calendarsToken

Parameter

Name Ort Typ Beschreibung

Name	Ort	Typ	Beschreibung
`sort`	Query	`string`	Order of the list; by name when left out Werte: `name_ascname_desccreated_desccreated_ascupdated_descupdated_asc`

sort

Query

string

Order of the list; by name when left out

Werte: name_ascname_desccreated_desccreated_ascupdated_descupdated_asc

Antworten

200Calendars returned, each with the access level held
403Calendar module not enabled

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a calendar, personal or in a space#

POST/calendar/calendarsToken

Request-Body`application/jsonCreateCalendarDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	–
`space_id`	`string`	Space the calendar belongs to. Left out for a personal one.
`description`	`string`	–
`color`	`string`	Hex colour, e.g. #4f8cff
`visibility`	`string`	private or organization for a personal calendar, private or space for a space calendar Werte: `privatespaceorganization` Standard: `"private"`
`default_timezone`	`string`	IANA time zone new events start in, e.g. Europe/Berlin Standard: `"UTC"`
`shares`	`CalendarShareDto[]`	–
`shares[].target_type`Pflicht	`string`	Werte: `userbase_rolespace`
`shares[].target_id`Pflicht	`string`	User id, or role id when target_type is role
`shares[].level`	`string`	The older single level. Read when no permissions object is sent. Werte: `vieweditmanage`
`shares[].permissions`	`CalendarSharePermissionsDto`	–
`shares[].base_role`	`string`	Space or organization role the target came from, for display
`shares[].granted_by`	`string`	Who last granted or changed this rule (set by the server)
`shares[].granted_at`	`string`	When this rule was last granted or changed (set by the server)
`field_settings`	`CalendarFieldSettingDto[]`	–
`field_settings[].field_id`Pflicht	`string`	Id of an existing custom field
`field_settings[].required`	`boolean`	Standard: `false`
`field_settings[].order`	`number`	–
`default_reminders`	`CalendarReminderDto[]`	Reminders every entry gets unless it sets its own
`default_reminders[].minutes_before`Pflicht	`number`	Werte: `051015306012014402880432057607200864010080`
`default_reminders[].channels`Pflicht	`string[]`	Werte: `notificationemail`
`default_reminders[].repeat_times`	`number`	Times to send it, spaced evenly up to the start; once when left out

Antworten

201Calendar created
403Not allowed to create a calendar in that space

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/calendar/calendars" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

Read one calendar#

GET/calendar/calendars/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Antworten

200Calendar returned
404Not found, or not visible to this user

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Rename, recolour or re-scope a calendar#

PATCH/calendar/calendars/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Request-Body`application/jsonUpdateCalendarDto`

Name	Typ	Beschreibung
`name`	`string`	–
`description`	`string`	–
`color`	`string`	Hex colour, e.g. #4f8cff
`space_id`	`object`	The space the calendar belongs to; null makes it personal
`visibility`	`string`	Werte: `privatespaceorganization`
`default_timezone`	`string`	IANA time zone, e.g. Europe/Berlin
`default_reminders`	`CalendarReminderDto[]`	Reminders every entry gets unless it sets its own
`default_reminders[].minutes_before`Pflicht	`number`	Werte: `051015306012014402880432057607200864010080`
`default_reminders[].channels`Pflicht	`string[]`	Werte: `notificationemail`
`default_reminders[].repeat_times`	`number`	Times to send it, spaced evenly up to the start; once when left out

Antworten

200Calendar updated
403Edit access required

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…","color":"…"}'

Delete a calendar and its entries#

DELETE/calendar/calendars/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Antworten

200Calendar deleted
403Manage access required

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Replace the ticket sources shown on a calendar#

PUT/calendar/calendars/{id}/feedsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Request-Body`application/jsonSetCalendarFeedsDto`

Name	Typ	Beschreibung
`feeds`Pflicht	`CalendarFeedDto[]`	–
`feeds[].id`	`string`	Kept when editing an existing source
`feeds[].space_id`Pflicht	`string`	Space whose tickets are shown
`feeds[].task_id`	`string`	One ticket to show. Left out, the whole space is shown.
`feeds[].date_field`Pflicht	`string`	Werte: `due_datestart_dateend_date`
`feeds[].label`	`string`	What the source is called on the calendar
`feeds[].color`	`string`	Hex colour, e.g. #f59e0b
`feeds[].linked_at`	`string`	When the source was first linked (set by the server)
`feeds[].excluded_task_ids`	`string[]`	Tickets of an All-tickets source that are not shown

Antworten

200Ticket sources updated
403Manage access required, or you cannot see that space's tickets

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}/feeds" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"feeds":[]}'

Replace the custom fields a calendar shows on its entries#

PUT/calendar/calendars/{id}/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Request-Body`application/jsonSetCalendarFieldSettingsDto`

Name	Typ	Beschreibung
`fields`Pflicht	`CalendarFieldSettingDto[]`	–
`fields[].field_id`Pflicht	`string`	Id of an existing custom field
`fields[].required`	`boolean`	Standard: `false`
`fields[].order`	`number`	–

Antworten

200Fields updated
400A field is not available to this calendar

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fields":[]}'

One page of the given spaces' tickets not linked to this calendar yet#

GET/calendar/calendars/{id}/linkable-ticketsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID
`space_ids`	Query	`string`	Spaces to read, comma separated (1-20)
`search`	Query	`string`	Search on key or summary
`page`	Query	`number`	–
`pageSize`	Query	`number`	–

Antworten

200Ticket ids, page and total
403No ticket-dates access, or you cannot see that space's tickets

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}/linkable-tickets" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Replace who a calendar is shared with#

PUT/calendar/calendars/{id}/sharesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Request-Body`application/jsonSetCalendarSharesDto`

Name	Typ	Beschreibung
`shares`Pflicht	`CalendarShareDto[]`	–
`shares[].target_type`Pflicht	`string`	Werte: `userbase_rolespace`
`shares[].target_id`Pflicht	`string`	User id, or role id when target_type is role
`shares[].level`	`string`	The older single level. Read when no permissions object is sent. Werte: `vieweditmanage`
`shares[].permissions`	`CalendarSharePermissionsDto`	–
`shares[].base_role`	`string`	Space or organization role the target came from, for display
`shares[].granted_by`	`string`	Who last granted or changed this rule (set by the server)
`shares[].granted_at`	`string`	When this rule was last granted or changed (set by the server)

Antworten

200Sharing updated
403Manage access required

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}/shares" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"shares":[]}'

One page of the tickets linked to a calendar#

GET/calendar/calendars/{id}/ticket-linksToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID
`page`	Query	`number`	–
`pageSize`	Query	`number`	–
`search`	Query	`string`	Search on key or summary
`space`	Query	`string`	Only this space
`status`	Query	`string`	Status names, comma separated
`priority`	Query	`string`	Priority names, comma separated
`type`	Query	`string`	Task type ids, comma separated

Antworten

200Linked ticket ids, page and total

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars/{id}/ticket-links" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Whether this user may create calendars#

GET/calendar/calendars/can-createToken

Antworten

200{ allowed: boolean }

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars/can-create" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Calendars whose owner has left the organization (name and owner only)#

GET/calendar/calendars/ownerlessToken

Antworten

200Calendars returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/calendars/ownerless" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Delete a calendar left behind by someone who has left#

DELETE/calendar/calendars/ownerless/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Calendar UUID

Antworten

200Calendar deleted
404Calendar not found or still owned

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/calendar/calendars/ownerless/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

One page of a linkable space's tickets#

GET/calendar/link-ticketsToken

Parameter

Name	Ort	Typ	Beschreibung
`space_id`Pflicht	Query	`string`	Space to read
`search`	Query	`string`	Search on key or summary
`page`	Query	`number`	–
`page_size`	Query	`number`	–

Antworten

200Tickets, page and total
403That space cannot be linked

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/link-tickets" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

One page of the tickets linked to the calendars this person may list#

GET/calendar/link-tickets/linkedToken

Parameter

Name	Ort	Typ	Beschreibung
`calendar`	Query	`string`	Only this calendar
`space`	Query	`string`	Only this space
`status`	Query	`string`	Status names, comma separated
`priority`	Query	`string`	Priority names, comma separated
`type`	Query	`string`	Task type ids, comma separated
`date_field`	Query	`string`	Only links shown by this date
`search`	Query	`string`	Search on key or summary
`page`	Query	`number`	–
`page_size`	Query	`number`	–

Antworten

200Linked tickets, page and total

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/link-tickets/linked" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Tickets by id, from linkable spaces only#

POST/calendar/link-tickets/lookupToken

Request-Body`application/jsonLinkTicketsLookupDto`

Name	Typ	Beschreibung
`ids`Pflicht	`string[]`	–

Antworten

200Found tickets and missing ids

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/calendar/link-tickets/lookup" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ids":[]}'

Every open space with Tasks on, for the Link ticket tab#

GET/calendar/link-tickets/spacesToken

Antworten

200Spaces, by name

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/calendar/link-tickets/spaces" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

calendars

List the calendars this user may see#

Parameter

Antworten

Create a calendar, personal or in a space#

Request-Bodyapplication/jsonCreateCalendarDto

Antworten

Read one calendar#

Parameter

Antworten

Rename, recolour or re-scope a calendar#

Parameter

Request-Bodyapplication/jsonUpdateCalendarDto

Antworten

Delete a calendar and its entries#

Parameter

Antworten

Replace the ticket sources shown on a calendar#

Parameter

Request-Bodyapplication/jsonSetCalendarFeedsDto

Antworten

Replace the custom fields a calendar shows on its entries#

Parameter

Request-Bodyapplication/jsonSetCalendarFieldSettingsDto

Antworten

One page of the given spaces' tickets not linked to this calendar yet#

Parameter

Antworten

Replace who a calendar is shared with#

Parameter

Request-Bodyapplication/jsonSetCalendarSharesDto

Antworten

One page of the tickets linked to a calendar#

Parameter

Antworten

Whether this user may create calendars#

Antworten

Calendars whose owner has left the organization (name and owner only)#

Antworten

Delete a calendar left behind by someone who has left#

Parameter

Antworten

One page of a linkable space's tickets#

Parameter

Antworten

One page of the tickets linked to the calendars this person may list#

Parameter

Antworten

Tickets by id, from linkable spaces only#

Request-Bodyapplication/jsonLinkTicketsLookupDto

Antworten

Every open space with Tasks on, for the Link ticket tab#

Antworten

Request-Body`application/jsonCreateCalendarDto`

Request-Body`application/jsonUpdateCalendarDto`

Request-Body`application/jsonSetCalendarFeedsDto`

Request-Body`application/jsonSetCalendarFieldSettingsDto`

Request-Body`application/jsonSetCalendarSharesDto`

Request-Body`application/jsonLinkTicketsLookupDto`