Page Comparison

...

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 Properties, below.
Group Member Properties	See Web Services#Group Group Member Properties, below.
Group Permission Properties	See 63543896 Group Permission Properties, below.
Group Role Properties	See Web Services#Group Group Role Properties, below.
Example Response	Status 200 /OK Successfully created the group with sysId {sysId}.

...

	Description
URI	http://host_name/uc/resources/usergroup
HTTP Method	DELETE
Description	Deletes a Group.
URI Parameters	See 63543896 Delete a Group URI Parameters, below.
Example URI	http://localhost:9080/uc/resources/usergroup?groupname=Test_Group http://localhost:9080/uc/resources/usergroup?groupid=f93b9403aec546bcbef1c2c06cf26e3c
Example Response	Status 200 /OK User group {groupname} deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify groupid and groupname at the same time. Status 404 /Not Found User group with {groupname/groupid} does not exist.

...

	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	See Read a Group: XML and JSON Examples.
Group Properties	See Web Services#Group Group Properties.
Group Member Properties	See 63543896 Group Member Properties.
Group Permission Properties	See Web Services#Group Group Permission Properties.
Group Role Properties	See 63543896 Group Role Properties.

Anchor

	List Groups XML and JSON Examples
	List Groups XML and JSON Examples

...

	Description
URI	http://host_name/uc/resources/usergroup
HTTP Method	PUT
Description	Modifies the Group specified by the `sysId` in the request. To modify Group properties without modifying related records, see the excludeRelated property, below.
Example URI	http://localhost:8080/uc/resources/usergroup
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create and Modify a Group: XML and JSON Examples.
Group Properties	See Web Services#Group Group Properties.
Group Member Properties	See 63543896 Group Member Properties.
Group Permission Properties	See Group Permission Properties.
Group Role Properties	See Group Role Properties.
Example Response	Status 200 /OK Successfully updated the user group with sysId <sysId>.

...

Versions Compared