Resources
TimelineNote Resource
This resource represents the timeline of notes.
Available HTTP-Methods for TimelineNote Resource
By sending a HTTP-POST request, the server returns a list of all requested timeline note resources with the following attributes Additional there are two meta datas in the response, use it in case the query parameters exceed the supported length. First with the number of all found elements and secound whether there are more available elements.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../timelineNotes/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | filterHtml | Specifies whether the timeline resources response is formatted as plain text or with HTML tags. |
| integer | maxTextLength | Specifies the length of the note text to retrieve a list of timeline resources with a cut off text for better list representation. |
| integer | offset | Specifies the offset of the list to return results for. Default Value is 0 |
| integer | maxCount | Specifies the maximum amount of items in the resulting list. Default Value is 10. Note: Using it for retrieving the topic list the following parameter is required: topicListType=LAST_MODIFIED! |
| integer | checkAtLeastMoreResults | With this parameter it is possible to define a number of additional entities, which should be loaded when requesting data. These will be used to build information for paging, endless scrolling etc.. |
| string[] | f_contentIds | Filters for notes with attachments with one of the given content identifiers. Since Communote version 3.3 |
| long | f_discussionId | Filters notes which are part of the specified discussion. If the discussion identifier is set the sort mode change from chronological (newest first) to threaded view style. Additional the discussion depth is set. |
| boolean | f_showFollowedItems | Filters notes which are followed by the user. |
| boolean | f_showNotesForMe | Filters notes which are addressed for the current user. |
| long[] | f_topicIds | Filters for notes with a topic being part of the given identifiers. |
| string[] | f_topicAliases | Filters for notes with topics being part of the given aliases. |
| long[] | f_topicIdsToExclude | Filters for notes NOT being part of the given topic identifiers. |
| long[] | f_tagIds | Filters for notes having all the tags assigned. The tag identifier refers to the tag database identifier. |
| string | f_tagPrefix | Filters for notes containing at least one tag starting with the given string. |
| long[] | f_userIds | Filters for notes with an author matching one of the given user identifiers. |
| string[] | f_userAliases | Filters for notes with an author matching one of the given user aliases. |
| date | f_startDate | Filters for notes being written after the specified date. |
| date | f_endDate | Filters for notes being written before or on the given date. Note: The specified day is included. If this day should be excluded, subtract 24 hours (86.400.000 ms) from f_endDate. |
| string | f_userSearchString | Filters for notes with an authors alias, last name or first name matching one of the given search string. |
| string | f_noteSearchString | Filters for notes containing the given string. Note: The results may vary depending on the Communote database used. |
| string | f_fullTextSearchString | Filters for notes where either the note content, the tags of the note or the name of the author contains the given string. |
| long | f_parentNoteId | Filters for notes with the specified parent's note id and the parent note itself. |
| string[] | f_repositoryIds | Filters for notes with attachments with the given repository identifiers. The order must match to the given f_contentIds parameter. Since Communote version 3.3 |
| boolean | f_showDirectMessages | Filters for notes which are direct messages. |
| boolean | f_showFavorites | Filters for notes which are marked as favorite. |
| boolean | f_includeComments | Specifies whether comments (or answers) of notes are included in the resulting list. |
| string | f_propertyFilter | Array of properties to filter for. The array is build like this: FILTER_1, FILTER_2, ..., FILTER_3 where every FILTER looks like {"name":"Example","value":[0:Property, 1:Group, 2:Key, 3:Value, 4:MatchMode, 5:Negate (Optional)]}, whereas Property can be one of Note, Entity, Dummy and MatchMode can be one of EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_EQUALS. Negate is optional (default = false) can be true or false. Note: Every filter value has to be escaped with double quotes ". Example: {"name":"Image","value":["Note","com.communote","contentTypes.image","image","EQUALS"]} |
| string | f_topicAccess | Filter for notes which can be accessed at least by the given access level. Constant Values manager - Lists all topics of which the user is the manager. read - Lists all topics of which the user has read access. write - Lists all topics of which the user has write access. |
| boolean | f_showOnlyDiscussions | Show only the discussion. |
| boolean | f_showOnlyRootNotes | Show only root notes. |
| boolean | f_showDiscussionParticipation | Filter for discussions, the current user has participated in. |
| long | f_targetTopicId | Id of the topic to filter for. |
| long | f_noteId | Id of the note to filter for. |
| boolean | f_topicRelated | Specifies whether the results have to be topic/utp related. |
| long | f_retrieveOnlyNotesBeforeId | Only retrieve notes with a smaller id. Can only be used in conjunction with f_retrieveOnlyNotesBeforeDate. |
| long | f_retrieveOnlyNotesBeforeDate | Only retrieve notes created before this date. Can only be used in conjunction with f_retrieveOnlyNotesBeforeId. |
| long | f_retrieveOnlyNotesAfterId | Only retrieve notes with a later id. Can only be used in conjunction with f_retrieveOnlyNotesAfterDate. |
| long | f_retrieveOnlyNotesAfterDate | Only retrieve notes created after this date. Can only be used in conjunction with f_retrieveOnlyNotesAfterId. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| Attachment[] | attachments | Contains all attachment resources. |
| TimelineUser | author | Contains the author of note. |
| date | creationDate | The date of creation of note. |
| TimelineNoteDiscussion | discussion | Contains information of the current discussion, where the note is parent or discussion part. |
| boolean | isDirectMessage | Indicates whether the note is a direct message or a normal message. |
| long | noteId | Is the identifier of an note. |
| integer | numberOfChildNotes | Number of all child notes. |
| integer | numberOfLikes | Number of users who like this note. |
| long | parentNoteId | Note identifier of the parent note. Is null when note is parent. |
| Property[] | properties | Properties of note. Properties are key value pairs. |
| string[] | rights | Specifies the possibilities what the user can do with this note. Constant Values CAN_EDIT - Mark that the user can edit this note. CAN_REPLY - Mark that the user can reply this note. CAN_DELETE - Mark that the user can delete this note. |
| string | shortText | The short message of note. |
| TimelineNoteTag[] | tags | Tags of the note. |
| string | text | The message of the note. |
| TimelineTopic | topic | Contains the topic where the not was posted. |
| string[] | userNoteProperties | Specifies properties of the current user. Multiple markers can be set. Constant Values FAV - Mark for note is favor of current user. LIKE - Mark that the current user like this note. NOTIFY - Mark that the current user is notify in this note. |
| TimelineUser[] | usersToNotify | Contains all notifyed users. |
PUT - Url
.../timelineNotes/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| Property[] | properties | Properties of note. Properties are key value pairs. |
By sending a HTTP-GET request, the server returns the requested timeline note resource with the following attributes.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking get requests on your server.
GET - Url
.../timelineNotes/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | filterHtml | Specifies whether the timeline resources response is formatted as plain text or with HTML tags. |
| integer | maxTextLength | Specifies the length of the note text to retrieve a list of timeline resources with a cut off text for better list representation. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| Attachment[] | attachments | Contains all attachment resources. |
| TimelineUser | author | Contains the author of note. |
| date | creationDate | The date of creation of note. |
| TimelineNoteDiscussion | discussion | Contains information of the current discussion, where the note is parent or discussion part. |
| boolean | isDirectMessage | Indicates whether the note is a direct message or a normal message. |
| boolean | isMentionDiscussionAuthors | Indicates that this note addresses all participants of the discussion this note is part of. |
| boolean | isMentionTopicAuthors | Indicates that this note addresses all users with at least one note within the topic. |
| boolean | isMentionTopicManagers | Indicates that this note addresses all managers of the the topic. |
| boolean | isMentionTopicReaders | Indicates that this note addresses all readers of the topic. |
| long | noteId (mandatory) | Is the identifier of an note. |
| integer | numberOfChildNotes | Number of all child notes. |
| integer | numberOfLikes | Number of users who like this note. |
| long | parentNoteId | Note identifier of the parent note. Is null when note is parent. |
| string[] | rights | Specifies the possibilities what the user can do with this note. Constant Values CAN_EDIT - Mark that the user can edit this note. CAN_REPLY - Mark that the user can reply this note. CAN_DELETE - Mark that the user can delete this note. |
| string | shortText | The short message of note. |
| TimelineNoteTag[] | tags | Tags of the note. |
| string | text | The message of the note. |
| TimelineTopic | topic | Contains the topic where the not was posted. |
| string[] | userNoteProperties | Specifies properties of the current user. Multiple markers can be set. Constant Values FAV - Mark for note is favor of current user. LIKE - Mark that the current user like this note. NOTIFY - Mark that the current user is notify in this note. |
| TimelineUser[] | usersToNotify | Contains all notifyed users. |
By sending a HTTP-GET request, the server returns a list of all requested timeline note resources with the following attributes Additional there are two meta datas in the response. First with the number of all found elements and secound whether there are more available elements.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking list requests on your server.
LIST - Url
.../timelineNotes/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | filterHtml | Specifies whether the timeline resources response is formatted as plain text or with HTML tags. |
| integer | maxTextLength | Specifies the length of the note text to retrieve a list of timeline resources with a cut off text for better list representation. |
| integer | offset | Specifies the offset of the list to return results for. Default Value is 0 |
| integer | maxCount | Specifies the maximum amount of items in the resulting list. Default Value is 10. Note: Using it for retrieving the topic list the following parameter is required: topicListType=LAST_MODIFIED! |
| integer | checkAtLeastMoreResults | With this parameter it is possible to define a number of additional entities, which should be loaded when requesting data. These will be used to build information for paging, endless scrolling etc.. |
| string[] | f_contentIds | Filters for notes with attachments with one of the given content identifiers. Since Communote version 3.3 |
| long | f_discussionId | Filters notes which are part of the specified discussion. If the discussion identifier is set the sort mode change from chronological (newest first) to threaded view style. Additional the discussion depth is set. |
| boolean | f_showFollowedItems | Filters notes which are followed by the user. |
| boolean | f_showNotesForMe | Filters notes which are addressed for the current user. |
| long[] | f_topicIds | Filters for notes with a topic being part of the given identifiers. |
| string[] | f_topicAliases | Filters for notes with topics being part of the given aliases. |
| long[] | f_topicIdsToExclude | Filters for notes NOT being part of the given topic identifiers. |
| long[] | f_tagIds | Filters for notes having all the tags assigned. The tag identifier refers to the tag database identifier. |
| string | f_tagPrefix | Filters for notes containing at least one tag starting with the given string. |
| long[] | f_userIds | Filters for notes with an author matching one of the given user identifiers. |
| string[] | f_userAliases | Filters for notes with an author matching one of the given user aliases. |
| date | f_startDate | Filters for notes being written after the specified date. |
| date | f_endDate | Filters for notes being written before or on the given date. Note: The specified day is included. If this day should be excluded, subtract 24 hours (86.400.000 ms) from f_endDate. |
| string | f_userSearchString | Filters for notes with an authors alias, last name or first name matching one of the given search string. |
| string | f_noteSearchString | Filters for notes containing the given string. Note: The results may vary depending on the Communote database used. |
| string | f_fullTextSearchString | Filters for notes where either the note content, the tags of the note or the name of the author contains the given string. |
| long | f_parentNoteId | Filters for notes with the specified parent's note id and the parent note itself. |
| string[] | f_repositoryIds | Filters for notes with attachments with the given repository identifiers. The order must match to the given f_contentIds parameter. Since Communote version 3.3 |
| boolean | f_showDirectMessages | Filters for notes which are direct messages. |
| boolean | f_showFavorites | Filters for notes which are marked as favorite. |
| boolean | f_includeComments | Specifies whether comments (or answers) of notes are included in the resulting list. |
| string | f_propertyFilter | Array of properties to filter for. The array is build like this: FILTER_1, FILTER_2, ..., FILTER_3 where every FILTER looks like {"name":"Example","value":[0:Property, 1:Group, 2:Key, 3:Value, 4:MatchMode, 5:Negate (Optional)]}, whereas Property can be one of Note, Entity, Dummy and MatchMode can be one of EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_EQUALS. Negate is optional (default = false) can be true or false. Note: Every filter value has to be escaped with double quotes ". Example: {"name":"Image","value":["Note","com.communote","contentTypes.image","image","EQUALS"]} |
| string | f_topicAccess | Filter for notes which can be accessed at least by the given access level. Constant Values manager - Lists all topics of which the user is the manager. read - Lists all topics of which the user has read access. write - Lists all topics of which the user has write access. |
| boolean | f_showOnlyDiscussions | Show only the discussion. |
| boolean | f_showOnlyRootNotes | Show only root notes. |
| boolean | f_showDiscussionParticipation | Filter for discussions, the current user has participated in. |
| long | f_targetTopicId | Id of the topic to filter for. |
| long | f_noteId | Id of the note to filter for. |
| boolean | f_topicRelated | Specifies whether the results have to be topic/utp related. |
| long | f_retrieveOnlyNotesBeforeId | Only retrieve notes with a smaller id. Can only be used in conjunction with f_retrieveOnlyNotesBeforeDate. |
| long | f_retrieveOnlyNotesBeforeDate | Only retrieve notes created before this date. Can only be used in conjunction with f_retrieveOnlyNotesBeforeId. |
| long | f_retrieveOnlyNotesAfterId | Only retrieve notes with a later id. Can only be used in conjunction with f_retrieveOnlyNotesAfterDate. |
| long | f_retrieveOnlyNotesAfterDate | Only retrieve notes created after this date. Can only be used in conjunction with f_retrieveOnlyNotesAfterId. |
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| Attachment[] | attachments | Contains all attachment resources. |
| TimelineUser | author | Contains the author of note. |
| date | creationDate | The date of creation of note. |
| TimelineNoteDiscussion | discussion | Contains information of the current discussion, where the note is parent or discussion part. |
| boolean | isDirectMessage | Indicates whether the note is a direct message or a normal message. |
| long | noteId | Is the identifier of an note. |
| integer | numberOfChildNotes | Number of all child notes. |
| integer | numberOfLikes | Number of users who like this note. |
| long | parentNoteId | Note identifier of the parent note. Is null when note is parent. |
| string[] | rights | Specifies the possibilities what the user can do with this note. Constant Values CAN_EDIT - Mark that the user can edit this note. CAN_REPLY - Mark that the user can reply this note. CAN_DELETE - Mark that the user can delete this note. |
| string | shortText | The short message of note. |
| TimelineNoteTag[] | tags | Tags of the note. |
| string | text | The message of the note. |
| TimelineTopic | topic | Contains the topic where the not was posted. |
| string[] | userNoteProperties | Specifies properties of the current user. Multiple markers can be set. Constant Values FAV - Mark for note is favor of current user. LIKE - Mark that the current user like this note. NOTIFY - Mark that the current user is notify in this note. |
| TimelineUser[] | usersToNotify | Contains all notifyed users. |
Property Resource
Resource for setting a property. It is a sub resource of a note.
Available HTTP-Methods for Property Resource
By sending a HTTP-POST request with all mandatory attributes, the server creates a new property resource and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../timelineNotes/ID/propertys/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | key (mandatory) | Key of the property. |
| string | keyGroup (mandatory) | KeyGroup of the property. |
| string | value | Value of property for specific key. |
GET - Url
.../timelineNotes/ID/propertys/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | key (mandatory) | Key of the property. |
| string | keyGroup (mandatory) | KeyGroup of the property. |
| long | propertyId | KeyGroup of the property. |
| string | value | Value of property for specific key. |
LIST - Url
.../timelineNotes/ID/propertys/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | key | Key of the property. |
| string | keyGroup | KeyGroup of the property. |
TimelineNoteDiscussion Resource
This resource represents an discussion of a timeline note. This resource conduce only for parsing of discussion in timeline note.
Available HTTP-Methods for TimelineNoteDiscussion Resource
GET - TimelineNoteDiscussion Resource
GET - Url
.../timelineNotes/ID/timelineNoteDiscussions/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| integer | depth | This is the depth of the current note in discussion. Is only set if timeline notes filtered for discussionId |
| long | discussionId | Is the identifier of the current discussion. |
| integer | numberOfDiscussionNotes | Number of all notes in the discussion. |
TimelineNoteTag Resource
This resource represents an tag of a timeline note. This resource conduce only for parsing of discussion in timeline note.
Available HTTP-Methods for TimelineNoteTag Resource
GET - TimelineNoteTag Resource
GET - Url
.../timelineNotes/ID/timelineNoteTags/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | name | This is the name of tag. |
| long | tagId | Is the identifier of tag. |
LIST - TimelineNoteTag Resource
LIST - Url
.../timelineNotes/ID/timelineNoteTags/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | name | This is the name of tag. |
| long | tagId | Is the identifier of tag. |