Resources
TimelineTag Resource
This resource represents a tag of a note.
Available HTTP-Methods for TimelineTag Resource
POST - Url
.../timelineTags/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| 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. |
By sending a HTTP-GET request, the server returns a list of all requested timeline tag resources with the following attributes. The resulting list of tags will contain all tags of the last 1000 notes matching the filter parameters. The list can be used to show a tag cloud. 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
.../timelineTags/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | hideSelectedTags | If set, the selected tags will be excluded from the result. |
| string | tagCloudMode | Mode of the tag cloud. Must be one of 'PopularTags', 'MyTags' or 'SomeTags' |
| integer | numberOfLastDays | Parameter for the number of last days to consider (e.g. only retrieve the tags of the last 7 days). |
| 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 |
|---|---|---|
| string | name | This is the name of the file. |
| integer | rank | This is the name of the file. |
| long | tagId | Is the Id of the tag. |