Resources
User Resource
This is the resource to define the users within the system.
Available HTTP-Methods for User Resource
POST - Url
.../users/
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.. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| Property[] | properties | Properties of user. Properties are key value pairs. |
By sending a HTTP-PUT request with edited attributes, the server edits the user resource and returns the userId.
PUT - Url
.../users/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | firstName | This is the firstname of the user. |
| string | lastName | This is the surname of the user. |
| Property[] | properties | Properties of user. Properties are key value pairs. |
| Tag[] | tags | Indicates whether the tags with witch the user is taged. |
| long | userId (mandatory) | The identifier of the user. |
By sending a HTTP-GET request, the server returns the requested user 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
.../users/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | alias | This is the alias of the user. It is also used for authentication. |
| string | company | The users company. |
| string | faxAreaCode | Area code of the user fax number. |
| string | faxCountryCode | Country code of the user fax number. |
| string | faxNumber | Number of the user fax number. |
| string | firstName | This is the firstname of the user. |
| boolean | isFollow | Indicates whether the author is followed by the user. |
| string | languageLocale | This is the locale of the user. |
| date | lastModificationDate | This is the date on which the user change some personal profil information. |
| string | lastName | This is the surname of the user. |
| date | lastPhotoModificationDate | Deprecated: use profileImageVersion instead. The date of the last modification of the user profile image. |
| string | phoneAreaCode | Area code of the user phone number. |
| string | phoneCountryCode | Country code of the user phone number. |
| string | phoneNumber | Number of the user phone number. |
| string | position | The users position. |
| string | profileImageVersion | A string reflecting the version of the profile image. The string will change when the profile image is updated or another image provider is used. This value could for instance be used in the URL to the image to get the latest version from the server and not an outdated one from the client's cache. Since Communote version 3.2 |
| string | salutation | The salutation of the user will be used within notification messages. |
| Tag[] | tags | Indicates whether the tags with witch the user is taged. |
| string | timeZoneId | This is the identifier of the time zone where the user is. |
| long | userId (mandatory) | The identifier of the user. |
By sending a HTTP-GET request, the server returns a list of all requested user 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
.../users/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | searchString | Searching users information for a substring. Searching in alias, lastname and firstname. |
| string | f_userAlias | Get user information by alias. When get user by alias is set, there no meta datas in the response |
| 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.. |
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | alias | This is the alias of the user. It is also used for authentication. |
| string | company | The users company. |
| string | faxAreaCode | Area code of the user fax number. |
| string | faxCountryCode | Country code of the user fax number. |
| string | faxNumber | Number of the user fax number. |
| string | firstName | This is the firstname of the user. |
| boolean | isFollow | Indicates whether the author is followed by the user. |
| string | languageLocale | This is the locale of the user. |
| date | lastModificationDate | This is the date on which the user change some personal profil information. |
| string | lastName | This is the surname of the user. |
| date | lastPhotoModificationDate | Deprecated: use profileImageVersion instead. The date of the last modification of the user profile image. |
| string | phoneAreaCode | Area code of the user phone number. |
| string | phoneCountryCode | Country code of the user phone number. |
| string | phoneNumber | Number of the user phone number. |
| string | position | The users position. |
| string | profileImageVersion | A string reflecting the version of the profile image. The string will change when the profile image is updated or another image provider is used. This value could for instance be used in the URL to the image to get the latest version from the server and not an outdated one from the client's cache. Since Communote version 3.2 |
| string | salutation | The salutation of the user will be used within notification messages. |
| Tag[] | tags | Indicates whether the tags with witch the user is taged. |
| string | timeZoneId | This is the identifier of the time zone where the user is. |
| long | userId | The identifier of the user. |
ExternalLogin Resource
This resource can be used to handle the external logins. Since Communote version 3.3
Available HTTP-Methods for ExternalLogin Resource
LIST - Url
.../users/ID/externalLogins/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | databaseId | Backend database id |
| string | externalLoginId | The login id for the user in the external system. |
| string | externalSystemId | The identifier of the external system this login belongs to, e.g. DefaultLDAP, DefaultConfluence |
| string | permanentId | The permanent identifier of the external login. |
| ExternalProperty[] | properties | Properties for the external login. |
ExternalProperty Resource
Resource for setting a property. It is a sub resource of a external login, cannot be set, only returned with ExternalLogin resource. Since Communote version 3.3
Available HTTP-Methods for ExternalProperty Resource
GET - ExternalProperty Resource
GET - Url
.../users/ID/externalLogins/ID/externalPropertys/ID
GET - 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. |
| long | propertyId | Dummy Id of the property. |
| string | value | Value of property for specific key. |
Follow Resource
Resource for setting a follow. It is a sub resource of a user.
Available HTTP-Methods for Follow Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets the follow status for specified user and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../users/ID/follows/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | follow | follow status of the user for the current user. Default Value is false. |
LIST - Url
.../users/ID/follows/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | follow | follow status of the user for the current user. Default Value is false. |
DELETE - Url
.../users/ID/follows/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
Image Resource
This is an image resource. It is a sub resource of a user.
Available HTTP-Methods for Image Resource
By sending a HTTP-GET request, the server returns a stream containing the image as binary.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking get requests on your server.
GET - Url
.../users/ID/images/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | size (mandatory) | This is the size of of the image. Constant Values SMALL - Returns an image of small size (25x25). MEDIUM - Returns an image of medium size (50x50). LARGE - Returns an image of large size (100x100). |
NavigationItem Resource
This resource can be used to handle navigation items.
Available HTTP-Methods for NavigationItem Resource
POST - NavigationItem Resource
POST - Url
.../users/ID/navigationItems/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | data | Paylod of the item. Note: this is a JSON object formatted as string |
| integer | index | Index of the item |
| long | lastAccessDate | The last access date as long. |
| string | name | Name of the item |
PUT - Url
.../users/ID/navigationItems/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | data | Paylod of the item. Note: this is a JSON object formatted as string |
| integer | index | Index of the item |
| long | lastAccessDate | The last access date as long. |
| string | name | Name of the item |
| long | navigationItemId | Id of the navigation item |
GET - Url
.../users/ID/navigationItems/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | navigationItemId | Id of the navigation item |
LIST - NavigationItem Resource
LIST - Url
.../users/ID/navigationItems/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| long[] | f_navigationItemIds | Observations to get results for, If null or empty all observations will be checked. |
DELETE - NavigationItem Resource
DELETE - Url
.../users/ID/navigationItems/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | navigationItemId | Id of the navigation item |
Observation Resource
This resource can be used to check the state if the users observations.
Available HTTP-Methods for Observation Resource
GET - Url
.../users/ID/observations/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | checkDate | Date the check was done. |
| long | count | Number of notes written since the last check date for this observation |
| long | observationId | Id of the observation |
LIST - Url
.../users/ID/observations/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| long[] | f_observations | Observations to get results for, If null or empty all observations will be checked. |
| long | f_lastCheckDate | Date the last check was done. |
Property Resource
Resource for setting a property. It is a sub resource of a user.
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
.../users/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
.../users/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
.../users/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. |
UserPreference Resource
Resource for retrieving and setting user preferences. Whatever user id or preference id you use, this will always return results for the current user.
Available HTTP-Methods for UserPreference Resource
PUT - Url
.../users/ID/userPreferences/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | className (mandatory) | Name of the implementing class. |
| long | preferenceId | Id of the preference, this can be ignored as it is ignored from backend. |
| Preference[] | preferences | The values of the preferences |
Method to get values of a specific preference.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking get requests on your server.
GET - Url
.../users/ID/userPreferences/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | f_className | Filter for this preferences. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | className | Name of the implementing class. |
| long | preferenceId | Id of the preference, this can be ignored as it is ignored from backend. |
| Preference[] | preferences | The values of the preferences |
Preference Resource
Resource for preference maps. It is a sub resource of Preferences, but can't be called directly.
Available HTTP-Methods for Preference Resource
POST - Url
.../users/ID/userPreferences/ID/preferences/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | key | Key of the preference. |
| string | value | Value of peference for specific key. |
PUT - Url
.../users/ID/userPreferences/ID/preferences/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | key | Key of the preference. |
| long | preferenceEntryId (mandatory) | Id of the preference, this can be ignored. |
| string | value | Value of peference for specific key. |
GET - Url
.../users/ID/userPreferences/ID/preferences/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | preferenceEntryId (mandatory) | Id of the preference, this can be ignored. |
DELETE - Url
.../users/ID/userPreferences/ID/preferences/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | preferenceEntryId (mandatory) | Id of the preference, this can be ignored. |