Intervals API Resource: milestone

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

Collection

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

Allowed Filters
Filter Name	Required?	Expects	Default	Description
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.
search	no	string		Limits the list to milestones that match the search string. Searches title, description, notes, and localid.
clientid	no	integer1		Limits the list to milestones that belong to the client corresponding to the ID(s) passed. You can pass a value of -1 for projects that have no client.
projectid	no	integer1		Limits the list to milestones that belong to the project corresponding to the ID(s) passed.
ownerid	no	integer1		Limits the list to milestones that belong to the owner corresponding to the ID(s) passed.
hasmilestonerelation	no	integer1		Limits the list to milestones that are either owned by, or contains tasks which the people with the IDs specified are assigned, own, or are followers of. 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.
complete	no	boolean		Limits the list to milestones that are either complete or incomplete.
dateduebegin	no	date		Limits the list to milestones that have a due date on or after the date passed.
datedueend	no	date		Limits the list to milestones that have a due date on or before the date passed.
title	no	string		Limits the list to milestones with titles containing the search string.
sortfield	no	string		Sort the list by any of the following fields: id, localid, projectid, clientid, datedue, title, description, progress, estimate, actual, owner, projectlabelid, projectlabel (sorted by project labels alphabeticaly), and projectabel_order (sorted by project label order in Settings & Defaults).
sortdir	no	string		Sets the sort direction of the returned list. Must be either "ASC" or "DESC".
offset	no	integer		Return milestones starting from the nth milestone.
limit	no	integer	10	Sets a limit to the amount of milestones 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 /milestone/

To filter the list based on certain parameters:

GET /milestone/?datedueend={value}

Note: You can string together multiple filters.

Member

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

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
projectid	yes	integer		The ID of the project the milestone belongs to.
ownerid	yes	integer		The ID of the owner of this milestone. You can submit multiple owners in the form of comma separated integers (e.g. '22,334,222').
title	yes	string (255)		The title of the milestone.
datedue	yes	date		The due date of the milestone. Milestones that are not completed and have a due date in the past are considered overdue. Milestones that are completed that have a due date in the future are considered in progress.
description	no	html		The milestone description.
complete	yes	boolean	f	Whether the milestone has been completed or not. Milestones that are not completed that have a due date in the past are considered overdue. Milestones that are completed that have a due date in the future are considered in progress.

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

Examples

To retrieve one member resource:

GET /milestone/{id}/

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

To delete a particular member resource:

DELETE /milestone/{id}/

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

To create a new member resource:

POST /milestone/

{
    "projectid": value,
    "ownerid": value,
    "title": value,
    "datedue": value,
    "complete": 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 /milestone/{id}/

{
    "ownerid": value,
    "description": value
}

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