GET /v1/calendar/tasks/{id}

Returns a task specified by id, in one of conditions: the calendar of the task is public; OR the authenticated user is the owner of the calendar; OR the user belongs to the group of the calendar; OR the task is delegated to the user; OR the calendar has been shared with the user or with a group of the user.

URL:

http://{domain_name}/{rest_context_name}/private/v1/calendar/tasks/{id}

Supported Format: JSON

Parameters:

  • Required (path parameters):

Parameter Description
id Identity of the task.
  • Optional (query parameters):

Parameter Description
fields Comma-separated list of selective task properties to be returned. All returned if not specified.
expand Used to ask for more attributes of a sub-resource, instead of its link only. This is a comma-separated list of task attributes names. For example: expand=calendar,categories. In case of collections, you can specify offset (default: 0), limit (default: querylimit ). For example, expand=categories(1,5). Instead of: { "calendar": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId", } It returns: { "calendar": { "editPermission": "", "viewPermission": "", "privateURL": null, "publicURL": null, "icsURL": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId/ics", "description": null, "color": "asparagus", "timeZone": "Europe/Brussels", "name": "John Smith", "type": "0", "owner": "john", "groups": null, "href": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId", "id": "john-defaultCalendarId" }, }
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/tasks/Task123?fields=id,name

Response:

 {
   "to": "2015-07-18T12:00:00.000Z",
   "attachments": [],
   "from": "2015-07-18T11:30:00.000Z",
   "categories": [
     "http://localhost:8080/rest/private/v1/calendar/categories/defaultEventCategoryIdAll"
   ],
   "categoryId": "defaultEventCategoryIdAll",
   "reminder": [],
   "delegation": [
     "john"
   ],
   "calendar": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId",
   "name": "caramazov",
   "priority": "none",
   "note": null,
   "status": "",
   "href": "http://localhost:8080/rest/private/v1/calendar/tasks/Event99f63db07f0001016dd7a4b4e0e7125c",
   "id": "Event99f63db07f0001016dd7a4b4e0e7125c"
 } 

Copyright ©2018. All rights reserved. eXo Platform SAS
blog comments powered byDisqus