...
The excludeRelated and retainSysIds properties are specified as attributes in the <userGroup> element of XML web services.
...
Delete a Group: URI Parameters
...
Parameter
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
groupid
...
ID used within the Controller to identify this group.
...
String; URI parameter.
...
Y (unless groupname is specified)
...
groupname
...
groupname
...
Name used within the Controller to identify this group.
...
String; URI parameter.
...
Y (unless groupid is specified)
...
groupid
...
List Groups
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves information on all Groups.
...
Example URI
...
Authentication
...
HTTP Basic
...
Produces Content-Type
...
application/xml, application/json
...
Example
...
See Read a Group: XML and JSON Examples.
...
Group Properties
...
See Group Properties.
...
Group Member Properties
...
See Group Member Properties.
...
Group Permission Properties
...
See Group Permission Properties.
...
Group Role Properties
...
See Group Role Properties.
...
List Groups XML and JSON Examples
XML | JSON |
|---|
| Expand |
|---|
|
| Code Block |
|---|
| <userGroup retainSysIds="true">
<ctrlNavigationVisibility>true</ctrlNavigationVisibility>
<description>Description</description>
<email>test@stonebranch.com</email>
<groupMembers>
<groupMember>
<sysId>1fe28873315d4316ad8fec7c89477723</sysId>
<user>userc</user>
</groupMember>
<groupMember>
<sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
<user>userb</user>
</groupMember>
</groupMembers>
<groupRoles>
<groupRole>
<role>ops_report_admin</role>
<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
</groupRole>
</groupRoles>
<manager />
<name>test</name>
<navigationVisibility>
<navigationNode>Reports</navigationNode>
</navigationVisibility>
<parent />
<permissions>
<permission>
<allGroups>true</allGroups>
<commands />
<defaultGroup>true</defaultGroup>
<nameWildcard>*</nameWildcard>
<notGroups>false</notGroups>
<notGroups>false</notGroups>
<opCreate>true</opCreate>
<opDelete>true</opDelete>
<opExecute>false</opExecute>
<opRead>true</opRead>
<opUpdate>true</opUpdate>
<opswiseGroups />
<permissionType>Task</permissionType>
<sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
</permission>
<sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
</userGroup> |
| | Expand |
|---|
| | Code Block |
|---|
| {
"ctrlNavigationVisibility": true,
"description": "Description",
"email": "test@stonebranch.com",
"groupMembers": [ {
"sysId": "b6fd058ee3db424ea374109299949b18",
"user": "userc"
},{
"sysId": "c54e8898f3bb493e9f5ed7f030007e2e",
"user": "userb"
} ],
"groupRoles": [ {
"role": "ops_report_admin",
"sysId": "4112408600e947b89d051d36bf9cf6b3"
} ],
"manager": null,
"name": "test",
"navigationVisibility": [ "Reports" ],
"parent": null,
"permissions": [ {
"allGroups": true,
"commands": null,
"defaultGroup": true,
"nameWildcard": "*",
"notGroups": false,
"opCreate": true,
"opDelete": true,
"opExecute": false,
"opRead": true,
"opUpdate": true,
"opswiseGroups": [],
"permissionType": "Task",
"sysId": "48eb7ec0c0a8026e0da9406feb022f4e"
} ],
"retainSysIds": true,
"sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
} |
|
...
Delete a Group
...
Description
...
URI
...
HTTP Method
...
DELETE
...
Description
...
Deletes a Group.
...
URI Parameters
...
See Group Delete a Group URI Parameters, below.
...
Example URI
...
...
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.
| |
| Expand |
|---|
| | Code Block |
|---|
| | Expand |
|---|
| | Code Block |
|---|
language | text| Expand |
|---|
|
|
|
| Anchor |
|---|
| Delete a Group |
|---|
| Delete a Group |
|---|
|
Delete a Group
| 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 | - 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.
|
| Anchor |
|---|
| Delete a Group URI Parameters |
|---|
| Delete a Group URI Parameters |
|---|
|
Delete a Group: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
|---|
groupid
| ID used within the Controller to identify this group. | String; URI parameter. | Y (unless groupname is specified) | groupname
|
groupname
| Name used within the Controller to identify this group. | String; URI parameter. | Y (unless groupid is specified) | groupid
|
List Groups
| Anchor |
|---|
| List Groups XML and JSON Examples |
|---|
| List Groups XML and JSON Examples |
|---|
|
List Groups XML and JSON Examples
XML | JSON |
|---|
| Expand |
|---|
|
| Code Block |
|---|
| <userGroups>
<userGroup retainSysIds="true">
<ctrlNavigationVisibility>false</ctrlNavigationVisibility>
<description/>
<email/>
<groupMembers>
<groupMember>
<sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
<user name="stone b branch">stonebranch-user-02</user>
</groupMember>
<groupMember>
<sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
<user name="stone c branch">stonebranch-user-03</user>
</groupMember>
<groupMember>
<sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
<user name="stone a branch">stonebranch-user-01</user>
</groupMember>
</groupMembers>
<groupRoles>
<groupRole>
<role description="The administrator role.">ops_admin</role>
<sysId>b80e78a42589435f92f3e176af6dc542</sysId>
</groupRole>
</groupRoles>
<manager/>
<name>stonebranch-group-01</name>
<navigationVisibility/>
<parent/>
<permissions>
<permission>
<allGroups>true</allGroups>
<commands/>
<defaultGroup>true</defaultGroup>
<nameWildcard>*</nameWildcard>
<notGroups>false</notGroups>
<opCreate>false</opCreate>
<opDelete>false</opDelete>
<opExecute>false</opExecute>
<opRead>true</opRead>
<opUpdate>false</opUpdate>
<opswiseGroups/>
<permissionType>Task Instance</permissionType>
<sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
</permission>
</permissions>
<sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup>
</userGroups> |
|
| |
| Anchor |
|---|
| Modify a Group |
|---|
| Modify a Group |
|---|
|
...