Resources
Note Resource
This is the resource for a note.
Available HTTP-Methods for Note Resource
By sending a HTTP-POST request with all mandatory attributes, the server creates a new note resource and returns the noteId.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../notes/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | isHtml | Depracated. Use TimelineNote Resource List instead. |
| integer | maxTextLength | Depracated. Use TimelineNote Resource List instead. |
| boolean | publish | Should note publish or is an auto saved note draft. Default Value is true. |
| long | autosaveNoteId | Identifier of auto save note draft. |
| string[] | crossPostTopicAliases | Topic aliases to save note in different topics as cross post. |
| string | attachmentUploadSessionId | Session identifier of an session attribute witch contains attachmentIds to upload. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long[] | attachmentIds | Identifier of the note's attachments |
| boolean | isDirectMessage | Indicates whether the note is a direct message or a normal message. Default Value is false. |
| long | noteId | Identifier of the note |
| long | noteVersion | Current version of note. |
| long | parentNoteId | The identifier of the parent note. |
| Property[] | properties | Properties of note. Properties are key value pairs. |
| Tag[] | tags | Tags with witch the note is tagged. |
| string | text | The message text of the note. |
| long | topicId (mandatory) | Is the identifier of the topic where this note will be published |
| string[] | usersToNotify | Specifies the aliases of users which are @-addressed in this message. |
By sending a HTTP-PUT request with edited attributes, the server edits the note resource and returns the noteId.
PUT - Url
.../notes/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | isHtml | Depracated. Use TimelineNote Resource List instead. |
| integer | maxTextLength | Depracated. Use TimelineNote Resource List instead. |
| boolean | publish | Should note publish or is an auto saved note draft. Default Value is true. |
| long | autosaveNoteId | Identifier of auto save note draft. |
| string[] | crossPostTopicAliases | Topic aliases to save note in different topics as cross post. |
| string | attachmentUploadSessionId | Session identifier of an session attribute witch contains attachmentIds to upload. |
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long[] | attachmentIds | Identifier of the note's attachments |
| long | noteId (mandatory) | Identifier of the note |
| long | noteVersion | Current version of note. |
| Property[] | properties | Properties of note. Properties are key value pairs. |
| Tag[] | tags | Tags with witch the note is tagged. |
| string | text | The message text of the note. |
| long | topicId (mandatory) | Is the identifier of the topic where this note will be published |
| string[] | usersToNotify | Specifies the aliases of users which are @-addressed in this message. |
By sending a HTTP-GET request, the server returns the requested 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
.../notes/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| boolean | filterHtml | Depracated. Use TimelineNote Resource List instead. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long[] | attachmentIds | Identifier of the note's attachments |
| Attachment[] | attachments | Contains all attachment resources of the note. |
| date | crawlLastModificationDate | The timestamp of the last modification of the note which in contrast to lastModificationDate is also updated when the access rights of the topic are changed or the note is moved into another topic. Since Communote version 3.3 |
| date | creationDate | Creation date of a note |
| integer | discussionDepth | It the amount of replies within a discussion. |
| long | discussionId | Is the id of the whole discussion. |
| string | discussionPath | Returns the path of the discussions. |
| string | firstName | This is the firstname of the author. |
| string[] | followedItems | Indicates whether the note is part of a followed author, topic or discussion. |
| boolean | isDirectMessage | Indicates whether the note is a direct message or a normal message. Default Value is false. |
| boolean | isFavorite | Specifies whether the note is marked as a favorite. |
| boolean | isLike | Specifies whether the note is marked as a like. |
| 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. |
| boolean | isNoteForMe | Indicates whether the note is a addressed to the current user. |
| date | lastModificationDate | The timestamp when a note was last modified by the author. Modification covers changes to the content, mentions, the added tags and attachments. |
| string | lastName | This is the surname of the author. |
| long | noteId (mandatory) | Identifier of the note |
| long | noteVersion | Current version of note. |
| integer | numberOfComments | Number of comments (also called replys or children). |
| long | parentNoteId | The identifier of the parent note. |
| Tag[] | tags | Tags with witch the note is tagged. |
| string | text | The message text of the note. |
| long | topicId | Is the identifier of the topic where this note will be published |
| string | topicName | This is the name of the topic in witch the note was posted. |
| long | userId | It the identifier of the author. |
| string | userName | This is the alias of the author. |
| string[] | usersToNotify | Specifies the aliases of users which are @-addressed in this message. |
| long[] | usersToNotifyIds | Specifies the user ids of users which are @-addressed in this message. Since Communote version 3.3 |
LIST - Url
.../notes/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| date | crawlLastModificationDate | The timestamp of the last modification of the note which in contrast to lastModificationDate is also updated when the access rights of the topic are changed or the note is moved into another topic. Since Communote version 3.3 |
DELETE - Url
.../notes/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | noteId (mandatory) | Identifier of the note |
Favorite Resource
Resource for setting a favorite. It is a sub resource of a note.
Available HTTP-Methods for Favorite Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets the favorite status for specified note and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../notes/ID/favorites/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | favorite | favorite status of the note for the user. Default Value is false. |
LIST - Url
.../notes/ID/favorites/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | favorite | favorite status of the note for the user. Default Value is false. |
DELETE - Url
.../notes/ID/favorites/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
Like Resource
Resource for setting a like. It is a sub resource of a note.
Available HTTP-Methods for Like Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets the like status for specified note and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../notes/ID/likes/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | like | like status of the note for the user. Default Value is false. |
LIST - Url
.../notes/ID/likes/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | like | like status of the note for the user. Default Value is false. |
| TimelineUser[] | users | Specifies the users who likes the note inclusive the current user when he likes the note. |
DELETE - Url
.../notes/ID/likes/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
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
.../notes/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
.../notes/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
.../notes/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. |