Returns the categories (common and personal categories).
URL:
http://{domain_name}/{rest_context_name}/private/v1/calendar/categories
Supported Format: JSON
Parameters:
Required (path parameters): No
Optional (query parameters):
| Parameter | Description |
|---|---|
| offset | The starting point when paging the result. Default is 0. |
| limit | Maximum number of categories returned. If omitted or exceeds the query limit parameter configured for the class, query limit is used instead. |
| fields | Comma-separated list of selective category attributes to be returned. All returned if not specified. |
| jsonp | The name of a JavaScript function to be used as the JSONP callback. If not specified, only JSON object is returned. |
Request example:
GET: http://localhost:8080/rest/private/v1/calendar/categories?fields=id,name
Response:
{
"limit": 10,
"data": [
{
"name": "defaultEventCategoryNameAll",
"href": "http://localhost:8080/rest/private/v1/calendar/categories/defaultEventCategoryIdAll",
"id": "defaultEventCategoryIdAll"
},
{...}
],
"size": 6,
"offset": 0
}