Intervals API Resource: milestonenote

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

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
milestoneid yes integer
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 /milestonenote/

To filter the list based on certain parameters:

GET /milestonenote/?milestoneid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
DELETEAdministrator
POSTAdministrator, Manager, Resource, Executive
PUTAdministrator
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
milestoneid yes integer The ID of the milestone this note belongs to.
note yes html The body of the milestone 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 /milestonenote/{id}/

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

To delete a particular member resource:

DELETE /milestonenote/{id}/

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

To create a new member resource:

POST /milestonenote/
{
    "milestoneid": 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 /milestonenote/{id}/
{
    "milestoneid": 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.

 

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