close anchor

Notes

To get information on notes:

GET /notes

If no user is logged in, only project-wide notes will be included. In order to get notes intended for a particular user based on entity type or privilege level, log that user in.

Parameters

Param Type Description Optional
id string The UUID of an individual note.
type string The note type, or type of entity to be identified with the note, being one of the types provided by the /note/types endpoint..
entity string The UUID of an entity, of the type indicated, by which to filter notes.
users string Indicate whether to provide the id or email of user(s) identified with a note, based on the entities to which it is posted.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: text, title.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, title.
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the note object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of note object(s).

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_entity_type The note entity type is not valid.

If an error is not described on this page, the platform-wide error table provides further information.

To post a note:

POST /notes

In order to post a note, log a user in. The user type or privilege level expected is based on the type of entity to which the note is being posted, on which further explanation is provided on the note information page.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
entity object The type of entity to which the note is being posted, and the id thereof (being a one-dimensional array in which each value is the UUID of an entity of the type indicated). This enables identifying one note with a group of entities, for instance posting a note to two users instead of one. Information on valid entity types is provided by the /note/types endpoint. If the project entity type is declared, the Elebase project ID will be inferred.
title string The title of the note.
text string The textual body of the note.

The data object provided by this endpoint is the note posted.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_entity_type The entity type is not valid.
invalid_group_type The entity being posted to is not a user group.
invalid_text The text body of the note is an empty value or was not provided.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a note:

PUT /notes

In order to edit or update a note, log in the user who initially posted the note.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the note.
title string The title of the note.
text string The textual body of the note.

The data object provided by this endpoint is the updated note.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_text The text body of the note is an empty value or was not provided.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a note:

DELETE /notes

In order to delete an existing note, log in either the user who initially posted it, or a user with owner-level privileges.

Param Type Description
id string The UUID of the note.

The data object provided by this endpoint is the deleted note.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*