Resources
Topic Resource
This resource represents a topic. Topics are used for categorising notes into different topics. Topics have a right managment. That means that not everybody can read the notes of a topic. After creation of a topic the user can set the read and write rights to the topic.
Available HTTP-Methods for Topic Resource
By sending a HTTP-POST request with all mandatory attributes, the server creates a new topic resource and returns the topicId.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../topics/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
| 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 |
|---|---|---|
| string | alias | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Default Value is the formatted title. |
| boolean | allCanRead | Indicates whether everybody is allowed to read notes from this topic or not. Default Value is false. |
| boolean | allCanWrite | Indicates whether everybody is allowed to publish a note within this topic or not. Default Value is false. |
| string | description | What is this topic about. |
| ExternalObject[] | externalObjects | External objects of topic. |
| Property[] | properties | Properties of topic. Properties are key value pairs. |
| RoleExternal[] | roleExternals | External roles of topic. |
| Role[] | roles | Roles of topic. |
| Tag[] | tags | These tags are uses for searching with a tag cloud. |
| string | title (mandatory) | Is the name of the topic. |
By sending a HTTP-PUT request with edited attributes, the server edits the topic resource and returns the topicId.
PUT - Url
.../topics/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | alias | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Default Value is the formatted title. |
| boolean | allCanRead | Indicates whether everybody is allowed to read notes from this topic or not. Default Value is false. |
| boolean | allCanWrite | Indicates whether everybody is allowed to publish a note within this topic or not. Default Value is false. |
| string | description | What is this topic about. |
| ExternalObject[] | externalObjects | External objects of topic. |
| Property[] | properties | Properties of topic. Properties are key value pairs. |
| RoleExternal[] | roleExternals | External roles of topic. |
| Role[] | roles | Roles of topic. |
| Tag[] | tags | These tags are uses for searching with a tag cloud. |
| string | title | Is the name of the topic. |
| string | topicId (mandatory) | The key value to identify a topic. |
By sending a HTTP-GET request, the server returns the requested topic 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
.../topics/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | alias | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Default Value is the formatted title. |
| string | bannerImageId | Identifier of the banner image of the topic |
| string | bannerImageVersion | A string reflecting the version of the banner image. The string will change each time the banner image is updated. 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. |
| ChildTopic[] | children | List of direct children |
| date | crawlLastModificationDate | The timestamp of the last modification of the topic which in contrast to lastModificationDate does also take changes to the access rights into account. Since Communote version 3.3 |
| boolean | createSystemNotes | Denotes whether system notes will be created in this topic. If true special activity notes are created automatically in this topic if the access rights are changed. |
| string | description | What is this topic about. |
| boolean | isFollow | Indicates whether the topic is followed by the user. |
| date | lastBannerImageModificationDate | Deprecated: use bannerImageVersion instead. Timestamp of the last modification of the banner image. Can be used in the image URL to get the latest image and an old one from the client's cache. |
| date | lastModificationDate | The timestamp of the last modification of the topic. This only reflects changes to the title, alias, description, the createSystemNotes flag and the assigned tags. |
| date | lastProfileImageModificationDate | Deprecated: use profileImageVersion instead. Timestamp of the last modification of the profile image. Can be used in the image URL to get the latest image and an old one from the client's cache. |
| string | profileImageId | Identifier of the profile image of the topic |
| string | profileImageVersion | A string reflecting the version of the profile image. The string will change each time the profile image is updated. 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 |
| Tag[] | tags | These tags are uses for searching with a tag cloud. |
| string | title | Is the name of the topic. |
| string | topicEmail | This is the mailing address of a topic, which enables the user to send regular e-mail to a topic |
| string | topicId (mandatory) | The key value to identify a topic. |
| string | userRole | Indicates the rule of the user within this topic. |
By sending a HTTP-GET request, the server returns a list of all requested topic 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
.../topics/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicListType | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. When topicListType is MOST_USED or LAST_USED there are no meta data in the response. Constant Values MANAGER - Lists all topics of which the user is the manager. READ - Lists all topics of which the user has the read access. WRITE - Lists all topics of which the user has the write access. MOST_USED - Lists all topics which are used mostly by the user. LAST_USED - Lists all topics chronical depending one the time of the last usage by the user. LAST_MODIFIED - Lists all topics chronical depending one the time of the last modification by the user. |
| string[] | f_topicAliases | Filters topics which contain the specified aliases |
| long[] | f_topicIds | Filters topics which contain the specified identifier. |
| long[] | f_topicIdsToExclude | Filters topics whose identifier is specified to be excluded. |
| boolean | f_showFollowedItems | Filters topics which are followed. |
| string[] | f_tags | Filters topics which contain every single tag. |
| string | f_tagPrefix | Filters topics whose tags start with the specified string. |
| string | f_titleSearchString | Filters topics with string in title. |
| string | f_externalObjectSystemId | Filters topics which have an external object with the given system id. If f_externalObjectId is also set both must match the same external object. Only works for topicListType=READ, WRITE or MANAGE. |
| string | f_externalObjectId | Filters topics which have an external object with the given external id. If f_externalObjectSystemId is also set both must match the same external object. Only works for topicListType=READ, WRITE or MANAGE. |
| 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 | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Default Value is the formatted title. |
| string | bannerImageId | Identifier of the banner image of the topic |
| string | bannerImageVersion | A string reflecting the version of the banner image. The string will change each time the banner image is updated. 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. |
| ChildTopic[] | children | List of direct children |
| date | crawlLastModificationDate | The timestamp of the last modification of the topic which in contrast to lastModificationDate does also take changes to the access rights into account. Since Communote version 3.3 |
| boolean | createSystemNotes | Denotes whether system notes will be created in this topic. If true special activity notes are created automatically in this topic if the access rights are changed. |
| string | description | What is this topic about. |
| boolean | isFollow | Indicates whether the topic is followed by the user. |
| date | lastBannerImageModificationDate | Deprecated: use bannerImageVersion instead. Timestamp of the last modification of the banner image. Can be used in the image URL to get the latest image and an old one from the client's cache. |
| date | lastModificationDate | The timestamp of the last modification of the topic. This only reflects changes to the title, alias, description, the createSystemNotes flag and the assigned tags. |
| date | lastProfileImageModificationDate | Deprecated: use profileImageVersion instead. Timestamp of the last modification of the profile image. Can be used in the image URL to get the latest image and an old one from the client's cache. |
| string | profileImageId | Identifier of the profile image of the topic |
| string | profileImageVersion | A string reflecting the version of the profile image. The string will change each time the profile image is updated. 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 |
| Tag[] | tags | These tags are uses for searching with a tag cloud. |
| string | title | Is the name of the topic. |
| string | topicEmail | This is the mailing address of a topic, which enables the user to send regular e-mail to a topic |
| string | topicId | The key value to identify a topic. |
| string | userRole | Indicates the rule of the user within this topic. |
By sending a HTTP-DELETE request, the server deletes the specified topic resource.
DELETE - Url
.../topics/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | topicId (mandatory) | The key value to identify a topic. |
ChildTopic Resource
This resource can be used to add or remove direct child topics for the given topic.
Available HTTP-Methods for ChildTopic Resource
POST - Url
.../topics/ID/childTopics/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | parentTopicIdentifier | Define the type the topics id is send, using one of the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | childTopicId (mandatory) | Id of the child topic. |
DELETE - Url
.../topics/ID/childTopics/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | parentTopicIdentifier | Define the type the topics id is send, using one of the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | childTopicId (mandatory) | Id of the child topic. |
ExternalObject Resource
Resource to assign external object privileges to an internal topic.
Available HTTP-Methods for ExternalObject Resource
POST - ExternalObject Resource
POST - Url
.../topics/ID/externalObjects/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalId (mandatory) | Identifier of the external object in external system. |
| long | externalObjectId | Internal identifier of external object. |
| string | externalSystemId (mandatory) | Identifier of the external system. |
| string | name | Name of external object. |
| string | topicAliasOfExternalObject | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Only set if topic independent filtering is used (topicId=0 in url). |
| long | topicIdOfExternalObject | The key value to identify a topic. Only set if topic independent filtering is used (topicId=0 in url). |
PUT - Url
.../topics/ID/externalObjects/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalId | Identifier of the external object in external system. |
| long | externalObjectId (mandatory) | Internal identifier of external object. |
| string | externalSystemId | Identifier of the external system. |
| string | name | Name of external object. |
| string | topicAliasOfExternalObject | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Only set if topic independent filtering is used (topicId=0 in url). |
| long | topicIdOfExternalObject | The key value to identify a topic. Only set if topic independent filtering is used (topicId=0 in url). |
GET - Url
.../topics/ID/externalObjects/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalId | Identifier of the external object in external system. |
| long | externalObjectId (mandatory) | Internal identifier of external object. |
| string | externalSystemId | Identifier of the external system. |
| string | name | Name of external object. |
| string | topicAliasOfExternalObject | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Only set if topic independent filtering is used (topicId=0 in url). |
| long | topicIdOfExternalObject | The key value to identify a topic. Only set if topic independent filtering is used (topicId=0 in url). |
LIST - ExternalObject Resource
By sending a HTTP-GET request, the server returns a list of all external object of the topic is returned. If topicId 0 is used and the parameters f_externalSystemId and f_externalObjectId are provided, ExternalObjects over all topics are considered (even if no access is allowed).
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking list requests on your server.
LIST - Url
.../topics/ID/externalObjects/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalId | Identifier of the external object in external system. |
| long | externalObjectId | Internal identifier of external object. |
| string | externalSystemId | Identifier of the external system. |
| string | name | Name of external object. |
| string | topicAliasOfExternalObject | Is the alias to identify the topic. It is needed for the topic creation and can be used on a change request. Only set if topic independent filtering is used (topicId=0 in url). |
| long | topicIdOfExternalObject | The key value to identify a topic. Only set if topic independent filtering is used (topicId=0 in url). |
DELETE - ExternalObject Resource
DELETE - Url
.../topics/ID/externalObjects/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalId | Identifier of the external object in external system. |
| long | externalObjectId | Internal identifier of external object. |
| string | externalSystemId | Identifier of the external system. |
Follow Resource
Resource for setting a follow. It is a sub resource of a topic.
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
.../topics/ID/follows/
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | follow | follow status of the topic for the user. Default Value is false. |
LIST - Url
.../topics/ID/follows/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | follow | follow status of the topic for the user. Default Value is false. |
DELETE - Url
.../topics/ID/follows/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 topic.
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
.../topics/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
.../topics/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
.../topics/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. |
Right Resource
Resource for setting a right. It is a sub resource of a topic.
Available HTTP-Methods for Right Resource
By sending a HTTP-PUT request with edited attributes, the server edits the rights of topic and returns null.
PUT - Url
.../topics/ID/rights/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | allCanRead | Indicates whether everybody is allowed to read notes from this topic or not. Default Value is false. |
| boolean | allCanWrite | Indicates whether everybody is allowed to publish a note within this topic or not. Default Value is false. |
| boolean | publicAccess | Specifies whether this topic is public accessibly. Default Value is false. |
GET - Url
.../topics/ID/rights/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | allCanRead | Indicates whether everybody is allowed to read notes from this topic or not. Default Value is false. |
| boolean | allCanWrite | Indicates whether everybody is allowed to publish a note within this topic or not. Default Value is false. |
| long[] | managingUserIds | User identifier with managing access to topic. |
| boolean | publicAccess | Specifies whether this topic is public accessibly. Default Value is false. |
| long[] | readingUserIds | User identifier with reading access to topic. |
| long[] | writingUserIds | User identifier with writing access to topic. |
Role Resource
Resource for setting a topic role. It is a sub resource of a topic.
Available HTTP-Methods for Role Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets the role of topic for an user or group and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../topics/ID/roles/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | entityId | The identifier of the user or a group. |
| string | groupAlias | The alias of the group. |
| string | role (mandatory) | Role for the user access to a topic. Default Value is "NONE". Constant Values NONE - A topic member with the NONE role has no access to the topic. MANAGER - A topic member with the MANAGER role has read, write and management access to a topic. MEMBER - A topic member with the MEMBER role has read and write access to a topic. VIEWER - A topic member with the VIEWER role only has read access to a topic. |
| string | userAlias | The alias of the user. |
PUT - Url
.../topics/ID/roles/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Url
.../topics/ID/roles/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
By sending a HTTP-GET request the server will return a list of all roles for the topic. Since Communote version 3.3
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking list requests on your server.
LIST - Url
.../topics/ID/roles/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | displayName | The display name for the user or group, includes both the full name and alias. Since Communote version 3.3 |
| long | entityId | The identifier of the user or a group. |
| string | groupAlias | The alias of the group. |
| boolean | isGroup | True if the entity is a group, false if it is a user. Since Communote version 3.3 |
| string | shortDisplayName | A shorter version of the display name for the user or group, includes only the name, or if not set only the alias. Since Communote version 3.3 |
| string | userAlias | The alias of the user. |
DELETE - Url
.../topics/ID/roles/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
RoleBulkExternal Resource
Resource for setting a bulk of topic roles for an external system in combination with an external object. It is a sub resource of a topic.
Available HTTP-Methods for RoleBulkExternal Resource
POST - RoleBulkExternal Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets roles of topic for an external system in combination with an external object and an external users or groups and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../topics/ID/roleBulkExternals/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
| RoleBulkExternalTopicRight[] | topicRights (mandatory) | rights for user or group as array with json objects |
| string | externalSystemId (mandatory) | Identifier for the external system (like "DefaultLDAP", "DefaultSharePoint", "DefaultConfluence"). |
| string | externalId (mandatory) | The identifier of external object. |
PUT - RoleBulkExternal Resource
PUT - Url
.../topics/ID/roleBulkExternals/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - RoleBulkExternal Resource
GET - Url
.../topics/ID/roleBulkExternals/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
DELETE - RoleBulkExternal Resource
DELETE - Url
.../topics/ID/roleBulkExternals/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
RoleBulkExternalTopicRight Resource
Resource for setting a bulk of topic roles for an external system. It is a sub resource of a RoleBulkExternal and is used only as container for serial- and deserialization.
Available HTTP-Methods for RoleBulkExternalTopicRight Resource
GET - RoleBulkExternalTopicRight Resource
GET - Url
.../topics/ID/roleBulkExternals/ID/roleBulkExternalTopicRights/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalGroupId | rights for user or group as array with json objects |
| string | externalUserId | rights for user or group as array with json objects |
| string | role (mandatory) | Role for the user access to a topic. Constant Values MANAGER - A topic member with the MANAGER role has read, write and management access to a topic. MEMBER - A topic member with the MEMBER role has read and write access to a topic. VIEWER - A topic member with the VIEWER role only has read access to a topic. |
RoleExternal Resource
Resource for setting a topic role for an external system in combination with an external object. It is a sub resource of a topic. Default Value is "NONE".
Available HTTP-Methods for RoleExternal Resource
By sending a HTTP-POST request with all mandatory attributes, the server sets the role of topic for an external system in combination with an external object and an external user or group and returns null.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking post requests on your server.
POST - Url
.../topics/ID/roleExternals/
POST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
POST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | externalGroupId | The identifier of the external group. |
| string | externalId (mandatory) | The identifier of external object. |
| string | externalSystemId (mandatory) | The external system identifier. |
| string | externalUserId | The identifier of the external user. |
| string | role (mandatory) | Role for the user access to a topic. Constant Values NONE - A topic member with the NONE role has no access to the topic. MANAGER - A topic member with the MANAGER role has read, write and management access to a topic. MEMBER - A topic member with the MEMBER role has read and write access to a topic. VIEWER - A topic member with the VIEWER role only has read access to a topic. |
PUT - Url
.../topics/ID/roleExternals/ID?_method=PUT
PUT - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Url
.../topics/ID/roleExternals/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|
LIST - Url
.../topics/ID/roleExternals/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |
DELETE - RoleExternal Resource
DELETE - Url
.../topics/ID/roleExternals/ID?_method=DELETE
DELETE - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | topicIdentifier | Topic lists have different views. These view can result from rights issues or usage issues. This requires a value to specify the type of list you want to request, using the defined constant values. Default Value is "ID" Constant Values ID - Topic Identifier is an Id ALIAS - Topic Identifier is an Alias. |