{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Events
/api/calendar/{calendarId}/events/{eventId}/recurrence
Exposes stored calendar events and stages event changes until commit.
GET /api/calendar/{calendarId}/events/{eventId}/recurrence
Optional recurrence rule and exception data.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
calendarId |
path | string |
yes | — |
eventId |
path | string |
yes | current internal event identifier |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
EventRecurrence |
Successful response. |
Example Request
# Request
GET /api/calendar/<calendarId>/events/<eventId>/recurrence HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"rrule": "string",
"exdate": [
0
],
"rdate": [
0
],
"until": 0
}
PUT /api/calendar/{calendarId}/events/{eventId}/recurrence
Replaces or clears recurrence data while normalizing omitted date collections.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
calendarId |
path | string |
yes | — |
eventId |
path | string |
yes | current internal event identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
EventRecurrence |
yes | replacement recurrence, or null to clear it |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
EventRecurrence |
Successful response. |
Example Request
# Request
PUT /api/calendar/<calendarId>/events/<eventId>/recurrence HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json
{
"rrule": "string",
"exdate": [
0
],
"rdate": [
0
],
"until": 0
}
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"rrule": "string",
"exdate": [
0
],
"rdate": [
0
],
"until": 0
}
Common Error Responses
The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:
{
"status": 404,
"code": "route_not_found",
"message": "The requested API route does not exist.",
"details": []
}
Schemas
Request and response schemas used on this page.
EventRecurrence
| Property | Type | Required | Description |
|---|---|---|---|
rrule |
string |
no | — |
exdate |
array<number (int64)> |
no | — |
rdate |
array<number (int64)> |
no | — |
until |
number (int64) |
no | — |
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |