Intervals API Resource: tasknote

The base URL for this resource is located at
https://api.myintervals.com/tasknote/

When using the date, datebegin, and dateend filters with the task collection, dates need to be entered in UTC. When taskid is not submitted, the datebegin to dateend range, and the datemodifiedbegin to datemodifiedend range, can not exceed 7 days.

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive

Allowed Filters
Filter Name	Required?	Expects	Default	Description
taskid	no	integer1		Limits the list to task notes belonging to a task. If not submitted, only last 7 days of task notes created will be returned. Or, use the datemodifiedbegin and datemodifiedend fields to return task notes modified instead of created.
title	no	string
date	no	date		Limits the list to task notes created on this date.
datebegin	no	datetime		Limits the list to task notes created on or after this date.
dateend	no	datetime		Limits the list to task notes created before or on this date.
datemodifiedbegin	no	datetime		Limits the list to task notes modified on or after this date.
datemodifiedend	no	datetime		Limits the list to task notes modified before or on this date.
authorid	no	integer1
public	no	boolean
sortfield	no			Sort the list by any of the following fields: id, taskid, authorid, date.
sortdir	no			Sets the sort direction of the returned list. Must be either "ASC" or "DESC".
offset	no	integer		Return tasknotes starting from the nth tasknote.
limit	no	integer	10	Sets a limit to the amount of tasknotes returned in the response.

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To retrieve the entire list of this resource:

GET /tasknote/

To filter the list based on certain parameters:

GET /tasknote/?limit={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive
DELETE	Administrator
POST	Administrator, Manager, Resource, Executive
PUT	Administrator

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
taskid	yes	integer		The ID of the task this note belongs to.
note	yes	html		The body of the task note.
public	yes	boolean	f	If true, this task note will be visible to executive users. For executive users, all notes created are public.

string (xxx) indicates a string with a maximum length of xxx characters.

Examples

To retrieve one member resource:

GET /tasknote/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

To delete a particular member resource:

DELETE /tasknote/{id}/

Assuming no errors, the server will respond with 200 OK.

To create a new member resource:

POST /tasknote/

{
    "taskid": value,
    "note": value,
    "public": value
}

Assuming no errors, the server will respond with 201 Created and the newly-created element. This will allow you to get the id of the item you just created and verify the field values. Note: Only required fields were listed here. The entire list of possible fields is above.

To update a member resource:

PUT /tasknote/{id}/

{
    "note": value,
    "public": value
}

Assuming no errors, the server will respond with 202 Accepted and the entire element. This will allow you to verify the field values.