Intervals API Resource: projectnote

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

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
localid no integer1 Restricts the list based on a project note's "localid," which is the number that appears associated with the note in the Intervals application.
clientid no integer1 Restricts the list to project notes belonging to projects for the clients corresponding to the ID(s) passed.
projectid no integer1 Restricts the list to project notes belonging to projects corresponding to the ID(s) passed.
authorid no integer1 Restricts the list to project notes created by the person corresponding to the ID(s) passed.
title no string
search no string Limits the list to project notes that match the search string. Searches title and note* (* only searched when project note is not secure).
noteid no 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 /projectnote/

To filter the list based on certain parameters:

GET /projectnote/?authorid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource
DELETEAdministrator, Manager, Resource
POSTAdministrator, Manager, Resource
PUTAdministrator, Manager, Resource
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
projectid yes integer The project this note belongs to. You can only add new notes to active projects.
title yes string (255) The title of the project note.
note yes html The body of the project note.
secure yes boolean f Secure project notes are securely encoded before storage; they are also only visible to people with access to secure notes for this project.

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

Examples

To retrieve one member resource:

GET /projectnote/{id}/

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

To delete a particular member resource:

DELETE /projectnote/{id}/

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

To create a new member resource:

POST /projectnote/
{
    "projectid": value,
    "title": value,
    "note": value,
    "secure": 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 /projectnote/{id}/
{
    "title": value,
    "note": 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