Resources
Group Resource
This resource represents a group. Groups have a set of members which can be a user or another group. Since Communote version 3.3
Available HTTP-Methods for Group Resource
By sending a HTTP-GET request, the server returns the requested group 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
.../groups/ID
GET - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | groupIdentifier | Define the type the group id is send, using one of the defined constant values. Default Value is "ID" Constant Values ID - Group Identifier is an Id ALIAS - Group 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 group. |
| string | description | What is this group about. |
| string | externalId | If the group is imported from an external repository this value identifies the id within the external system. The actual value depdens on the configuration of the external system. |
| string | externalSystemId | If the group is imported from an external repository this value identifies the system the group is from, e.g. DefaultLDAP. |
| string | groupId (mandatory) | The key value to identify a group. |
| string | name | Is the name of the group. |
Member Resource
Members of the group. Only returns the members for local groups. Since Communote version 3.3
Available HTTP-Methods for Member Resource
LIST - Url
.../groups/ID/members/
LIST - Parameters
Parameters are generally used to filter the result and are not part of the result set.
| Type | Name | Description |
|---|---|---|
| string | groupIdentifier | Define the type the group id is send, using one of the defined constant values. Default Value is "ID" Constant Values ID - Group Identifier is an Id ALIAS - Group Identifier is an Alias. |
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | entityId | Id of entity. |
| boolean | isGroup | true if it is a group or false if it is a user. |