Resources

TimelineTopic Resource

This resource represents a topic of a note.

Available HTTP-Methods for TimelineTopic Resource


POST - TimelineTopic Resource

POST - Url

.../timelineTopics/

POST - Parameters

Parameters are generally used to filter the result and are not part of the result set.

TypeNameDescription
integeroffsetSpecifies the offset of the list to return results for. Default Value is 0
integermaxCountSpecifies 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!
integercheckAtLeastMoreResultsWith 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_contentIdsFilters for notes with attachments with one of the given content identifiers. Since Communote version 3.3
longf_discussionIdFilters 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.
booleanf_showFollowedItemsFilters notes which are followed by the user.
booleanf_showNotesForMeFilters notes which are addressed for the current user.
long[]f_topicIdsFilters for notes with a topic being part of the given identifiers.
string[]f_topicAliasesFilters for notes with topics being part of the given aliases.
long[]f_topicIdsToExcludeFilters for notes NOT being part of the given topic identifiers.
long[]f_tagIdsFilters for notes having all the tags assigned. The tag identifier refers to the tag database identifier.
stringf_tagPrefixFilters for notes containing at least one tag starting with the given string.
long[]f_userIdsFilters for notes with an author matching one of the given user identifiers.
string[]f_userAliasesFilters for notes with an author matching one of the given user aliases.
datef_startDateFilters for notes being written after the specified date.
datef_endDateFilters 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.
stringf_userSearchStringFilters for notes with an authors alias, last name or first name matching one of the given search string.
stringf_noteSearchStringFilters for notes containing the given string. Note: The results may vary depending on the Communote database used.
stringf_fullTextSearchStringFilters for notes where either the note content, the tags of the note or the name of the author contains the given string.
longf_parentNoteIdFilters for notes with the specified parent's note id and the parent note itself.
string[]f_repositoryIdsFilters for notes with attachments with the given repository identifiers. The order must match to the given f_contentIds parameter. Since Communote version 3.3
booleanf_showDirectMessagesFilters for notes which are direct messages.
booleanf_showFavoritesFilters for notes which are marked as favorite.
booleanf_includeCommentsSpecifies whether comments (or answers) of notes are included in the resulting list.
stringf_propertyFilterArray 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"]}
stringf_topicAccessFilter 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. 
booleanf_showOnlyDiscussionsShow only the discussion.
booleanf_showOnlyRootNotesShow only root notes.
booleanf_showDiscussionParticipationFilter for discussions, the current user has participated in.
longf_targetTopicIdId of the topic to filter for.
longf_noteIdId of the note to filter for.
booleanf_topicRelatedSpecifies whether the results have to be topic/utp related.
longf_retrieveOnlyNotesBeforeIdOnly retrieve notes with a smaller id. Can only be used in conjunction with f_retrieveOnlyNotesBeforeDate.
longf_retrieveOnlyNotesBeforeDateOnly retrieve notes created before this date. Can only be used in conjunction with f_retrieveOnlyNotesBeforeId.
longf_retrieveOnlyNotesAfterIdOnly retrieve notes with a later id. Can only be used in conjunction with f_retrieveOnlyNotesAfterDate.
longf_retrieveOnlyNotesAfterDateOnly retrieve notes created after this date. Can only be used in conjunction with f_retrieveOnlyNotesAfterId.

LIST - TimelineTopic Resource

By sending a HTTP-GET request, the server returns a list of all requested timeline topic resources with the following attributes. The list will contain all topics which are part of the last 1000 notes matching the filter parameters. 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

.../timelineTopics/

LIST - Parameters

Parameters are generally used to filter the result and are not part of the result set.

TypeNameDescription
integeroffsetSpecifies the offset of the list to return results for. Default Value is 0
integermaxCountSpecifies 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!
integercheckAtLeastMoreResultsWith 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_contentIdsFilters for notes with attachments with one of the given content identifiers. Since Communote version 3.3
longf_discussionIdFilters 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.
booleanf_showFollowedItemsFilters notes which are followed by the user.
booleanf_showNotesForMeFilters notes which are addressed for the current user.
long[]f_topicIdsFilters for notes with a topic being part of the given identifiers.
string[]f_topicAliasesFilters for notes with topics being part of the given aliases.
long[]f_topicIdsToExcludeFilters for notes NOT being part of the given topic identifiers.
long[]f_tagIdsFilters for notes having all the tags assigned. The tag identifier refers to the tag database identifier.
stringf_tagPrefixFilters for notes containing at least one tag starting with the given string.
long[]f_userIdsFilters for notes with an author matching one of the given user identifiers.
string[]f_userAliasesFilters for notes with an author matching one of the given user aliases.
datef_startDateFilters for notes being written after the specified date.
datef_endDateFilters 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.
stringf_userSearchStringFilters for notes with an authors alias, last name or first name matching one of the given search string.
stringf_noteSearchStringFilters for notes containing the given string. Note: The results may vary depending on the Communote database used.
stringf_fullTextSearchStringFilters for notes where either the note content, the tags of the note or the name of the author contains the given string.
longf_parentNoteIdFilters for notes with the specified parent's note id and the parent note itself.
string[]f_repositoryIdsFilters for notes with attachments with the given repository identifiers. The order must match to the given f_contentIds parameter. Since Communote version 3.3
booleanf_showDirectMessagesFilters for notes which are direct messages.
booleanf_showFavoritesFilters for notes which are marked as favorite.
booleanf_includeCommentsSpecifies whether comments (or answers) of notes are included in the resulting list.
stringf_propertyFilterArray 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"]}
stringf_topicAccessFilter 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. 
booleanf_showOnlyDiscussionsShow only the discussion.
booleanf_showOnlyRootNotesShow only root notes.
booleanf_showDiscussionParticipationFilter for discussions, the current user has participated in.
longf_targetTopicIdId of the topic to filter for.
longf_noteIdId of the note to filter for.
booleanf_topicRelatedSpecifies whether the results have to be topic/utp related.
longf_retrieveOnlyNotesBeforeIdOnly retrieve notes with a smaller id. Can only be used in conjunction with f_retrieveOnlyNotesBeforeDate.
longf_retrieveOnlyNotesBeforeDateOnly retrieve notes created before this date. Can only be used in conjunction with f_retrieveOnlyNotesBeforeId.
longf_retrieveOnlyNotesAfterIdOnly retrieve notes with a later id. Can only be used in conjunction with f_retrieveOnlyNotesAfterDate.
longf_retrieveOnlyNotesAfterDateOnly 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.

TypeNameDescription
stringaliasThis is the alias of the topic.
stringtitleThis is the title of the topic.
longtopicIdIs the Id of the topic.