- eXo Platform Documentation
- REST API Documentation
- Calendar Resources
- GET /v1/calendar/categories/{id}
Returns a category specified by id if it is a common category or is a personal category of the user.
URL:
http://{domain_name}/{rest_context_name}/private/v1/calendar/categories/{id}
Supported Format: JSON
Parameters:
Required (path parameters):
| Parameter | Description |
|---|---|
| id | Identity of the category. |
Optional (query parameters):
| Parameter | Description |
|---|---|
| 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/cat123?fields=id,name
Response:
{
"name": "defaultEventCategoryNameAll",
"href": "http://localhost:8080/rest/private/v1/calendar/categories/defaultEventCategoryIdAll",
"id": "defaultEventCategoryIdAll"
}