Intervals API Resource: task

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

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
localid no integer1 Restricts the task list based on a task's "localid," which is the number that appears associated with the task in the Intervals application.
personid no integer Limits the list to people who have access to the project this task belongs to.
includetimerid no integer Retrieves timerid and starttime for the passed-in personid (if present).
assigneeid no integer1 Limits the list to tasks assigned to this person. To include tasks with no assignee, pass a value of -1.
followerid no integer1 Limits the list to tasks followed by this person. To include tasks with no followers, pass a value of -1.
statusid no integer1 Limits the list to tasks having this status.
clientid no integer1 Limits the list to tasks belonging to this client. To include tasks with no client, pass a value of -1.
projectid no integer1 Limits the list to tasks belonging to this project.
moduleid no integer1 Limits the list to tasks having this module.
milestoneid no integer1 Limits the list to tasks belonging to this milestone. To include tasks with no milestone, pass a value of -1.
title no string Limits the list to tasks containing this string in the title.
dateopen no date Limits the list to tasks opening on this specific date.
datedue no date Limits the list to tasks due on this specific date.
dateclosed no date Limits the list to tasks closed on this specific date.
hasduedate no boolean Limits the list to tasks with or without a due date.
ownerid no integer1 Limits the list to tasks owned by this person.
priorityid no integer1 Limits the list to tasks having this priority.
tasklistfilterid no integer Limits the list to tasks matching this tasklistfilter.
overdue no boolean
excludeclosed no boolean f Limits the list to tasks that are not closed.
assignedorownedby no integer1 [DEPRECATED] Previously limited the list to tasks that are either assigned to or owned by the people specified. Now this filter operates like the 'hastaskrelation' filter, which is described below and includes tasks followed by the people listed.
hastaskrelation no integer1 Limits the list to tasks that are either assigned to, followed by or owned by the people with the IDs specified. For restricted resources (users who can only see tasks that they own or that are assigned to them), this value will be set to the user by default; anything in the assigneeid or ownerid fields will be overridden.
search no string Limits the list to tasks that match the search string. Searches title, summary, request queue title, request queue description, and localid.
sortfield no string Sort the list by any of the following fields: id, localid, queueid, assigneeid, statusid, projectid, module, moduleid, title, summary, dateopen, datedue, dateclosed, estimate, ownerid, priorityid, sev.priority, severity, status (returns status alphabetically), status_order (returns status ordered by level of completion), project, client, assignee, milestoneid, milestone, owner.
sortdir no string Sets the sort direction of the returned list. Must be either "ASC" or "DESC".
offset no integer
limit no integer 10

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

Examples

To retrieve the entire list of this resource:

GET /task/

To filter the list based on certain parameters:

GET /task/?tasklistfilterid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
DELETEAdministrator, Manager
POSTAdministrator, Manager, Resource
PUTAdministrator, Manager, Resource
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
assigneeid no integer Allows you to specify the task assignee. You can submit multiple assignees in the form of comma separated integers (e.g. '22,334,222').
followerid no integer Allows you to specify the task followers. You can submit multiple followers in the form of comma separated integers (e.g. '22,334,222').
milestoneid no integer The milestone the task belongs to.
statusid yes integer The corresponding status of the task. Tasks that have a status other than closed and a due date in the past are considered overdue.
projectid yes integer The project the task belongs to.
moduleid yes integer The module the task belongs to.
title yes string (255) The task title.
summary no html The task summary.
dateopen yes date The start date of the task.
datedue no date The due date of the task. Tasks that have a due date in the past that don't have the status set to closed are considered overdue.
dateclosed no date The date on which the task was closed.
estimate no double The estimated hours for the task.
ownerid yes integer The ID of the owner of the task. You can submit multiple owners in the form of comma separated integers (e.g. '22,334,222'). NOTE: Resource-level users may not set the owner of a new task to someone other than themselves, and they are not allowed to change the owner of an existing task.
priorityid yes integer The ID of the priority of the task.

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

Examples

To retrieve one member resource:

GET /task/{id}/

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

To delete a particular member resource:

DELETE /task/{id}/

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

To create a new member resource:

POST /task/
{
    "statusid": value,
    "projectid": value,
    "moduleid": value,
    "title": value,
    "dateopen": value,
    "ownerid": value,
    "priorityid": 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 /task/{id}/
{
    "title": value,
    "dateclosed": value
}

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

 

Don’t have an Intervals account? Start your own unlimited trial.

No credit card required. No software to install. Cancel any time.

Try it Free