...

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

...

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

{
  "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": "*",
    "opCreate": true,
    "opDelete": true,
    "opExecute": false,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Task",
    "sysId": "48eb7ec0c0a8026e0da9406feb022f4e"
  } ],
  "retainSysIds": true,
  "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
}

Expand

title	XML

Code Block

language	text

<userGroup retainSysIds="true">

  <ctrlNavigationVisibility>false</ctrlNavigationVisibility>

<description>Description</description>

  <description

<email>test@stonebranch.com<

email

  <email />

  <groupMembers>

  <groupMember>

<user>userc</user>

<

<sysId>386bf68d82a74a9e94eab18c1b1844c2</

groupMember>

sysId>

       <user

name="stone b branch">stonebranch-user-02</user>

<user>userb<

</

user>

groupMember>

</groupMember>

  <groupMember>

</groupMembers>

<role>ops_report_admin</role> <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>

 <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>

</groupRole>

</groupRoles>

<manager

/> <name>test</name>

<user name="stone c branch">stonebranch-user-03</user>

<navigationNode>Reports<

</

navigationNode>

groupMember>

</navigationVisibility>

<parent

/>

<groupMember>

<commands

/> <defaultGroup>true</defaultGroup> <nameWildcard>*</nameWildcard> <opCreate>true</opCreate> <opDelete>true</opDelete> <opExecute>false</opExecute> <opRead>true</opRead> <opUpdate>true</opUpdate> <opswiseGroups /> <permissionType>Task</permissionType> <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId> </permission> ... </permissions> <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId> </userGroup>

Expand

title	JSON

...

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.

...

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 Group Properties.

...

Group Member Properties

...

See Group Group Member Properties.

...

Group Permission Properties

...

See Group Group Permission Properties.

...

Group Role Properties

...

See Group Group Role Properties.

...

List Groups XML and JSON Examples

XML

JSON

<userGroups>
  <userGroup>
     <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
     <description>Description</description>
     <email>test@stonebranch.com</email>
     <groupMembers>
        <groupMember>
           <sysId>1fe28873315d4316ad8fec7c89477723</sysId>
           <user name="User C">userc</user>
        </groupMember>
        <groupMember>
           <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
           <user name="User B">userb</user>
        </groupMember>
     </groupMembers>
     <groupRoles>
        <groupRole>
	   <role description="report admin role">ops_report_admin</role>
	   <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </groupRoles>
     <manager />
     <name>test1</name>
     <navigationVisibility>
        <navigationNode>Reports</navigationNode>
     </navigationVisibility>
     <parent />
     <permissions>
        <permission>
	   <allGroups>true</allGroups>
	   <commands />
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>true</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>false</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Task</permissionType>
	   <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </permissions>
     <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>
   <userGroup>
     <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
     <description>Description</description>
     <groupMembers />
     <groupRoles>
        <groupRole>
	   <role description="report admin role">ops_report_admin</role>
	   <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </groupRoles>
     <manager />
     <name>test2</name>
     <navigationVisibility>
        <navigationNode>Reports</navigationNode>
     </navigationVisibility>
     <parent />
     <permissions>
        <permission>
	   <allGroups>true</allGroups>
	   <commands />
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>true</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>false</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Task</permissionType>
	   <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </permissions>
     <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>

Expand

title	XML

Expand

title	JSON

[ { "ctrlNavigationVisibility": true, "description": "Description", "email": "test@stonebranch.com", "groupMembers": [ { "sysId": "b6fd058ee3db424ea374109299949b18", "user": {

 <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>

Expand

title	JSON

Code Block

language	text

{
  "ctrlNavigationVisibility" : false,
  "description" : null,
  "email" : null,
  "groupMembers" : [ {
    "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
    "user" : {
      "name" : "stone b branch",
      "value" : "stonebranch-user-02"
    }
  }, {
    "sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
    "user" : {
      "name" : "stone c branch",
      "value" : "stonebranch-user-03"
    }
  }, {
    "sysId" : "b78079e1166d4c5180d7e42443de44a0",
    "user" : {
      "name" : "stone a branch",
      "value" : "stonebranch-user-01"
    }
  } ],
  "groupRoles" : [ {
    "role" : {
      "description" : "The administrator role.",
      "value" : "ops_admin"
    },
    "sysId" : "b80e78a42589435f92f3e176af6dc542"
  } ],
  "manager" : null,
  "name" : "stonebranch-group-01",
  "navigationVisibility" : [ ],
  "parent" : null,
  "permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" : false,
    "opDelete" : false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" : false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "retainSysIds" : true,
  "sysId" : "b39b2b8eac644e068a68f92f325b0c74"
}

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	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.

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`

Anchor

	List Groups
	List Groups

List Groups

	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 Group Properties.
Group Member Properties	See Group Member Properties.
Group Permission Properties	See Group Permission Properties.
Group Role Properties	See Group Role Properties.

Anchor

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

List Groups XML and JSON Examples

XML

JSON

Expand

title	XML

Code Block

language	text

<userGroups>
    <userGroup>
        <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
        <description/>
        <email/>
        <groupMembers>
            <groupMember>

"name": "USERC",

 <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>

"value":

"userc"

   <user name="stone b branch">stonebranch-user-02</user>

}

        </groupMember>

}

],

     <groupMember>

"groupRoles":

[

{

     <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>

"role":

{

"description": "The report administrator role.",

<user name="stone c branch">stonebranch-user-03</user>
            </groupMember>

"value":

"ops_report_admin"

          <groupMember>

},

"sysId":

"4112408600e947b89d051d36bf9cf6b3"

  <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>

}

],

   <user name="stone a

"manager": null,

branch">stonebranch-user-01</user>

"name":

"test1",

"navigationVisibility": [ "Reports" ],

</groupMember>
        </groupMembers>

"parent":

null,

     <groupRoles>

"permissions":

[],

"sysId":

"920ef061ff4d498abe6e7ef883b1b5e1"

   <groupRole>

},

{

"ctrlNavigationVisibility":

true,

     <role

"

description="

:

The administrator

"Description",

role.">ops_admin</role>

"groupMembers":

[],

"groupRoles":

[

  <sysId>b80e78a42589435f92f3e176af6dc542</sysId>

{

     </groupRole>

"role":

{

 </groupRoles>
        <manager />

"description": "The report administrator role.",

     <name>stonebranch-group-01</name>
        <navigationVisibility/>

"value":

"ops_report_admin"

  <parent />

},

<permissions>

"sysId": "4112408600e947b89d051d36bf9cf6b3"

 <permission>

}

],

 <allGroups>true</allGroups>

"manager":

null,

"name":

"test2",

    <commands/>

"navigationVisibility":

[

"Reports"

],

"parent":

null,

"permissions": [

<defaultGroup>true</defaultGroup>

{

     <nameWildcard>*</nameWildcard>

"allGroups":

true,

         <notGroups>false</notGroups>

"commands":

null,

"defaultGroup": true,

 <opCreate>false</opCreate>

"nameWildcard":

"*",

    <opDelete>false</opDelete>

"opCreate":

true,

        <opExecute>false</opExecute>

"opDelete":

true,

"opExecute": false,

<opRead>true</opRead>

"opRead":

true,

   <opUpdate>false</opUpdate>

"opUpdate": true,

        <opswiseGroups/>

"opswiseGroups":

[],

 <permissionType>Task Instance</permissionType>

"permissionType":

"Task",

      <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>

"sysId":

"48eb7ec0c0a8026e0da9406feb022f4e"

      </permission>

}

      </permissions>

],

"sysId": "920ef061ff4d498abe6e7ef883b1b5e1"

<sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>

} ]

...

Modify a Group

...

Description

...

URI

...

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

...

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 Group Group Properties.

...

Group Member Properties

...

See Group Group Member Properties.

...

Group Permission Properties

...

See Group Group Permission Properties.

...

Group Role Properties

...

See Group Group Role Properties.

...

Example Response

...

Status 200 /OK
Successfully updated the user group with sysId <sysId>.

...

Read a Group

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on a specific Group.

...

URI Parameters

...

See Read a Group: URI Parameters, below.

...

Example URI

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

Status 200 /OK
(See Read a Group: Example XML and JSON Examples, below.)
Status 404 /Not Found
A user group with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...

Response Group Member Properties

...

See Group Group Member Properties.

...

Response Group Permission Properties

...

See Group Group Permission Properties.

...

Response Group Role Properties

...

See Group Group Role Properties.

...

Read 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

...

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

Expand

title	XML

<userGroup retainSysIds="true"> <ctrlNavigationVisibility>true</ctrlNavigationVisibility> <description>Description</description> <email>test@stonebranch.com</email> <groupMembers> <groupMember>

</userGroup>
</userGroups>

Expand

title	JSON

Code Block

language	text

[ {
  "ctrlNavigationVisibility" : false,
  "description" : null,
  "email" : null,
  "groupMembers" : [ {
    "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
    "user" : {
      "name" : "stone b branch",
      "value" : "stonebranch-user-02"
    }
  }, {
    "sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
    "user" : {
      "name" : "stone c branch",
      "value" : "stonebranch-user-03"
    }
  }, {
    "sysId" : "b78079e1166d4c5180d7e42443de44a0",
    "user" : {
      "name" : "stone a branch",
      "value" : "stonebranch-user-01"
    }
  } ],
  "groupRoles" : [ {
    "role" : {
      "description" : "The administrator role.",
      "value" : "ops_admin"
    },
    "sysId" : "b80e78a42589435f92f3e176af6dc542"
  } ],
  "manager" : null,
  "name" : "stonebranch-group-01",
  "navigationVisibility" : [ ],
  "parent" : null,
  "permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" : false,
    "opDelete" : false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" : false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "sysId" : "b39b2b8eac644e068a68f92f325b0c74"
} ]

Anchor

	Modify a Group
	Modify a Group

Modify a Group

	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 Group Properties.
Group Member Properties	See 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>.

Anchor

	Read a Group
	Read a Group

Read a Group

	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	http://localhost:8080/uc/resources/usergroup?groupname=test.group http://localhost:8080/uc/resources/usergroup?groupid=c489750500d444eca9325559d0ef9673
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Status 200 /OK (See Read a Group: Example XML and JSON Examples, below.) Status 404 /Not Found A user group with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Response Group Member Properties	See Group Member Properties.
Response Group Permission Properties	See Group Permission Properties.
Response Group Role Properties	See Group Role Properties.

Anchor

	Read a Group URI Parameters
	Read a Group URI Parameters

Read 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`

Anchor

	Read a Group XML and JSON Examples
	Read a Group XML and JSON Examples

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

Expand

title	XML

Code Block

language	text

<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>

<user

name="User C">userc</user>

 <notGroups>false</notGroups>

</groupMember>

<opCreate>false</opCreate>

    <opDelete>false</opDelete>

<user

name="User

B">userb</user>

<

<opExecute>false</

groupMember>

opExecute>

</groupMembers>

     <opRead>true</opRead>

<role

description="report

admin

role">ops_report_admin</role> <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>

</groupRole>

<opUpdate>false</opUpdate>

</groupRoles>

<manager

/>

<name>test<

<opswiseGroups/

name

<navigationNode>Reports</navigationNode>

  <permissionType>Task

<

Instance</

navigationVisibility>

permissionType>

<allGroups>true</allGroups> <commands /> <defaultGroup>true</defaultGroup> <nameWildcard>*</nameWildcard> <opCreate>true</opCreate> <opDelete>true</opDelete> <opExecute>false</opExecute> <opRead>true</opRead> <opUpdate>true</opUpdate> <opswiseGroups /> <permissionType>Task</permissionType> <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId> </permission> ... </permissions> <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId> </userGroup>

Expand

title	JSON

{ "ctrlNavigationVisibility": true, "description": "Description", "email": "test@stonebranch.com", "groupMembers": [

<sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
        </permission>
    </permissions>
    <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup>

Expand

title	JSON

Code Block

language	text

{
  "ctrlNavigationVisibility" : false,
  "description" : null,
  "email" : null,
  "groupMembers" : [ {
    "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
    "user" : {
      "name" : "stone b branch",
      "value" : "stonebranch-user-02"
    }
  }, {
    "sysId" : "

b6fd058ee3db424ea374109299949b18

792aa1dc1a1b4decb0b02d82ed7e9422",
    "user" : {
      "name" : "

USERC

stone c branch",
      "value" : "

userc

stonebranch-user-03"
    }
  }, {
    "sysId" : "

c54e8898f3bb493e9f5ed7f030007e2e

b78079e1166d4c5180d7e42443de44a0",
    "user" : {
      "name" : "

USERB

stone a branch",
      "value" : "

userb

stonebranch-user-01"
    }
  } ],
  "groupRoles" : [ {
    "role" : {
      "description" : "The

report

 administrator role.",
      "value" : "ops_

report_

admin"
    },
    "sysId" : "

4112408600e947b89d051d36bf9cf6b3

b80e78a42589435f92f3e176af6dc542"
  } ],
  "manager" : null,
  "name" : "

test

stonebranch-group-01",
  "navigationVisibility" : [

"Reports"

 ],
  "parent" : null,
  "permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" :

true

false,
    "opDelete" :

true

false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" :

true

false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "

48eb7ec0c0a8026e0da9406feb022f4e

59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "retainSysIds" : true,
  "sysId" : "

920ef061ff4d498abe6e7ef883b1b5e1

b39b2b8eac644e068a68f92f325b0c74"
}

Anchor

	Properties
	Properties

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	ctrlNavigationVisibility - GR
	ctrlNavigationVisibility - GR

ctrlNavigationVisibility

Control Navigation Visibility

Indication of whether or not to control the visibility of navigation pane entries in the Controller Navigator, via the navigationVisibility property, for members of this Group. If ctrlNavigationVisibility is false, all entries are visible.

Boolean. Valid values: true/false. Default is false.

N

Anchor

	description - GR
	description - GR

description

Description

Description of the group.

N

Anchor

	email - GR
	email - GR

email

Email

Email address of this group.

N

Anchor

	excludeRelated - GR
	excludeRelated - GR

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.

Note

title	Note

In XML, excludeRelated is specified as an attribute in the <userGroup> element.

Valid values: true/false (default is false).

N

Anchor

	groupMembers - MEM
	groupMembers - MEM

groupMembers

n/a

Users in this group.

Note

title	Note

Universal Controller only supports a user being a member of 1,000 groups or less.

Format:
XML

Panel
<groupMembers> <groupMember> <user>userc</user> </groupMember> </groupMembers>

JSON

Panel
"groupMembers": [ { "user": "userc" } ]

N

Anchor

	groupRoles - ROLE
	groupRoles - ROLE

groupRoles

n/a

Roles assigned to this group.

Format:
XML

Panel
<groupRoles> <groupRole> <role>ops_report_admin</role> </groupRole> </groupRoles>

JSON

Panel
"groupRoles": [ { "role": "ops_report_global" } ]

N

Anchor

	manager - GR
	manager - GR

manager

Manager

ID of the Universal Controller user that is the manager of this group.

N

Anchor

	name - GR
	name - GR

name

Name

Name of the group.

Y

Anchor

	navigationVisibility - GR
	navigationVisibility - GR

navigationVisibility

Navigation Visibility

List of all Controller Navigator entries.

Format:
XML

Panel
<navigationVisibility> <navigationNode>Reports</navigationNode> </navigationVisibility>

To include all values, set the navigationNode to All

Panel
<navigationVisibility> <navigationNode>All</navigationNode> </navigationVisibility>

JSON

Panel
"navigationVisibility": [ "Reports", "Support Portal" ]

Valid values: (see navigationNode Valid Values, below)

N

Anchor

	parent - GR
	parent - GR

parent

Parent

Name of this group's parent group, if any.

N

Anchor

	permissions - PERM
	permissions - PERM

permissions

n/a

Permissions assigned to this group.

N

Anchor

	retainSysIds - GR
	retainSysIds - GR

retainSysIds

n/a

For Create and Read web services; specification for whether or not the web service should persist the sysId property.

If retainSysIds is true and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds is false and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller. |

Note

title	Note

In XML, retainSysIds is specified as an attribute in the <userGroup> element.

Valid values: true/false (default is true).

N

Anchor

	sysId - GR
	sysId - GR

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

Anchor

	allGroups - PERM
	allGroups - PERM

allGroups

Member of Any Business Service or Unassigned

Business Service Criteria

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.

Note
If `allGroups` is specified as true, `defaultGroup` is set to true, `notGroups` is set to false, and `opswiseGroups` is cleared, regardless of what you specify in the payload.

Boolean. Valid Values: true/false. Default is false.

N

Anchor

	commands - PERM
	commands - PERM

commands

Commands

Commands that are associated with each permission.

Valid values: see Group Command Permissions, below.

N

Anchor

	defaultGroup - PERM
	defaultGroup - PERM

defaultGroup

Unassigned to Business Service

defaultGroup

Unassigned to Business Service

Business Service Criteria

Member of Specific Business Services or Unassigned
Unassigned
Not Member of Specific Business Services or Unassigned

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

Anchor

	nameWildcard - PERM
	nameWildcard - PERM

nameWildcard

Name

Specification to apply this permission to records whose name matches the string specified here.

Wildcards (*'s) can be used.

Y

 Anchor
notGroups
notGroups
notGroups

Not Member of Business Services

Business Service Criteria

Not Member of Specific Business Services or Unassigned
Not Member of Specific Business Services

Specification for whether or not this permission applies to records that are a member of opswiseGroups or not a member of opswiseGroups.

Boolean. Valid Values: true/false. Default is false.

N

Anchor

	opCreate - PERM
	opCreate - PERM

opCreate

Create

Allows members of the group to create records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

Cannot be set to true if permissionType is Agent or Task Instance.

N

Anchor

	opDelete - PERM
	opDelete - PERM

opDelete

Delete

Allows members of the group to delete records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

Cannot be set to true if permissionType is Agent.

N

Anchor

	opExecute - PERM
	opExecute - PERM

opExecute

Execute

Allows the user to execute records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

If the Strict Connection Execute Constraints Universal Controller system property is false:

opExecute can be set to true only if permissionType is Agent, Credential, Script, or Virtual Resource.

If the Strict Connection Execute Constraints Universal Controller system property is true:

opExecute can be set to true only if permissionType is Agent, Credential, Database Connection, Email Connection, SAP Connection, Script, SNMP Manager, or Virtual Resource.

N

Anchor

	opRead - PERM
	opRead - PERM

opRead

Read

Allows the user to read records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

If the Strict Business Service Membership Read Constraints Universal Controller system property is false:

opRead must be set to true if permissionType is Agent, Agent Cluster, Calendar, Credential, Database Connection, Email Connection, SAP Connection, Email Template, SNMP Manager, or Virtual Resource.

N

Anchor

	opUpdate - PERM
	opUpdate - PERM

opUpdate

Update

Allows members of the group to update records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

Must be set to true if opCreate is set to true.

N

Anchor

	opswiseGroups - PERM
	opswiseGroups - PERM

opswiseGroups

Member of Specific Business Services

Applies this permission to records that are members of the selected Business Service(s).

Format:
XML

Panel
<opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups>

JSON

Panel
"opswiseGroups": ["test"]

N

Anchor

	permissionType - PERM
	permissionType - PERM

permissionType

Type

Type of permission for this group.

Valid values:

As String = Agent, As Value = 1
As String = Calendar, As Value = 2
As String = Credential, As Value = 3
As String = Task, As Value = 4
As String = Task Instance, As Value = 5
As String = Trigger, As Value = 6
As String = Application, As Value = 7
As String = Script, As Value = 8
As String = Variable, As Value = 9
As String = Virtual Resource, As Value = 10
As String = Agent Cluster, As Value = 11
As String = Email Template, As Value = 12
As String = Email Connection, As Value = 13
As String = Database Connection, As Value = 14
As String = SAP Connection, As Value = 15
As String = SNMP Manager, As Value = 16
As String = PeopleSoft Connection, As Value = 17
As String = Bundle, As Value = 18
As String = Promotion Target, As Value = 19
As String = OMS Server, As Value = 20

Y

Anchor

	sysId - PERM
	sysId - PERM

sysId

n/a

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

...

Versions Compared

Old Version 3

New Version Current

Key

Create and Modify a Group: XML and JSON Examples

Delete a Group

Delete a Group: URI Parameters

List Groups

List Groups XML and JSON Examples

Delete a Group

Delete a Group: URI Parameters

List Groups

List Groups XML and JSON Examples

Modify a Group

Read a Group

Read a Group: URI Parameters

Read a Group XML and JSON Examples

Modify a Group

Read a Group

Read a Group: URI Parameters

Read a Group XML and JSON Examples

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Create and Modify a Group: XML and JSON Examples

Delete a Group

Delete a Group: URI Parameters

List Groups

List Groups XML and JSON Examples

Delete a Group

Delete a Group: URI Parameters

List Groups

List Groups XML and JSON Examples

Modify a Group

Read a Group

Read a Group: URI Parameters

Read a Group XML and JSON Examples

Modify a Group

Read a Group

Read a Group: URI Parameters

Read a Group XML and JSON Examples