...
Universal Controller supports the following RESTful-based web services for User and Group operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Description | |
---|---|
URI | http://host_name/uc/resources/usergroup |
HTTP Method | POST |
Description | Creates a new User Group. |
Example URI | http://localhost:8080/uc/resources/usergroup |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Create and Modify a Group: XML and JSON Examples, below. |
Group Properties | See Web Services#Group Group Group Properties, below. |
Group Member Properties | See Web Services#Group Group Group Member Properties, below. |
Group Permission Properties | See Group Group Permission Properties, below. |
Group Role Properties | See Web Services#Group Group Group Role Properties, below. |
Example Response |
|
...
Create and Modify a Group: XML and JSON Examples
The excludeRelated and retainSysIds properties are specified as attributes in the <userGroup> element of XML web services.
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/usergroup |
HTTP Method | DELETE |
Description | Deletes a Group. |
URI Parameters | See Group Delete a Group URI Parameters, below. |
Example URI | |
Example Response |
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/usergroup/list |
HTTP Method | GET |
Description | Retrieves information on all Groups. |
Example URI | http://localhost:8080/uc/resources/usergroup/list |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | |
Group Properties | See Web Services#Group Group Group Properties. |
Group Member Properties | |
Group Permission Properties | See Web Services#Group Group Group Permission Properties. |
Group Role Properties |
Anchor | ||||
---|---|---|---|---|
|
...
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/usergroup |
HTTP Method | PUT |
Description | Modifies the Group specified by the |
Example URI | http://localhost:8080/uc/resources/usergroup |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Group Properties | See Web Services#Group Group Group Properties. |
Group Member Properties | |
Group Permission Properties | |
Group Role Properties | |
Example Response |
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/usergroup |
HTTP Method | GET |
Description | Retrieves information on a specific Group. |
URI Parameters | See Read a Group: URI Parameters, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response |
|
Response Group Member Properties | |
Response Group Permission Properties | |
Response Group Role Properties |
Anchor | ||||
---|---|---|---|---|
|
...
Read a Group XML and JSON Examples
The retainSysIds property is specified as an attribute in the <userGroup> element of the XML response.
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ctrlNavigationVisibility | Control Navigation Visibility | Indication of whether or not to control the visibility of navigation pane entries in the Controller Navigator, via the | Boolean. Valid values: true/false. Default is false. | N | |||||||||||||||
description | Description | Description of the group. | N | ||||||||||||||||
email | Email address of this group. | N | |||||||||||||||||
excludeRelated | n/a | For the Modify Group web service; specification for whether or not to exclude related records (Group Roles, Group Members, Group Permissions) from the update, even if they are provided in the request.
| Valid values: true/false (default is false). | N | |||||||||||||||
groupMembers | n/a | Users in this group.
| Format:
| N | |||||||||||||||
groupRoles | n/a | Roles assigned to this group. | Format:
| N | |||||||||||||||
manager | Manager | ID of the Universal Controller user that is the manager of this group. | N | ||||||||||||||||
name | Name | Name of the group. | Y | ||||||||||||||||
navigationVisibility | Navigation Visibility | List of all Controller Navigator entries. | Format:
To include all values, set the
| N | |||||||||||||||
parent | Parent | Name of this group's parent group, if any. | N | ||||||||||||||||
permissions | n/a | Permissions assigned to this group. | N | ||||||||||||||||
retainSysIds | n/a | For Create and Read web services; specification for whether or not the web service should persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||||||
sysId | n/a | System ID field in the database for this record. | Persisted only if retainSysIds is set to true. | N |
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allGroups | Member of Any Business Service or Unassigned | Specification for whether or not this permission applies both to records that belong to any Business Service and to records that do not belong to any Business Service. | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||
commands | Commands | Commands that are associated with each permission. | Valid values: see Group Command Permissions, below. | N | ||||||||||
defaultGroup | Unassigned to Business Service | Specification for whether or not this permission applies to records that do not belong to any Business Service. | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||
nameWildcard | Name | Specification to apply this permission to records whose name matches the string specified here. | Wildcards (*'s) can be used. | Y | ||||||||||
opCreate | Create | Allows members of the group to create records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||
opDelete | Delete | Allows members of the group to delete records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||
opExecute | Execute | Allows the user to execute records of the specified | Boolean. Valid Values: true/false. Default is false.
If the Strict Connection Execute Constraints Universal Controller system property is true:
| N | ||||||||||
opRead | Read | Allows the user to read records of the specified | Boolean. Valid Values: true/false. Default is false.
| N | ||||||||||
opUpdate | Update | Allows members of the group to update records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||
opswiseGroups | Member of Business Services | Applies this permission to records that are members of the selected Business Service(s). | Format:
| N | ||||||||||
permissionType | Type | Type of permission for this group. | Valid values:
| Y | ||||||||||
sysId | n/a | System ID field in the database for this record. | Persisted only if retainSysIds is set to true. | N |
...