Page Comparison

...

The excludeRelated and retainSysIds properties are specified as attributes in the <userGroup> element of XML web services.

XML

JSON

Expand

title	XML

Code Block

language	text

<userGroup retainSysIds="true">

<ctrlNavigationVisibility>true</ctrlNavigationVisibility>

<description>Description</description>

<description>Description</description>

<email>test@stonebranch

<email>test@stonebranch.com</

email>

email>

<groupMembers>
     <groupMember>
        <sysId>1fe28873315d4316ad8fec7c89477723</sysId>
        <user>userc</user>
     </groupMember>
     <groupMember>
        <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
        <user>userb</user>
     </groupMember>
  </

groupMembers>

groupMembers>

<groupRoles>
     <groupRole>

<role>ops

<role>ops_report_admin</

role>

role>

<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
     </groupRole>
  </

groupRoles>

groupRoles>

<manager

<manager />

<name>test</name>

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

navigationVisibility>

navigationVisibility>

<parent

<parent />

<permissions>
     <permission>

<allGroups>true</allGroups>

<commands

<commands />

<defaultGroup>true</defaultGroup>

<nameWildcard>*</

nameWildcard>

nameWildcard>
    <notGroups>false</notGroups>

<notGroups>false</notGroups> <opCreate>true</opCreate> <opDelete>true</opDelete> <opExecute>false</opExecute> <opRead>true</opRead> <opUpdate>true</opUpdate> <opswiseGroups

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

permissions>

sysId>

sysId>920ef061ff4d498abe6e7ef883b1b5e1<

sysId> </

userGroup>

Expand

title	JSON

Code Block

language	text

{
  "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"
}

Anchor

	Delete a Group
	Delete a Group

...

List Groups XML and JSON Examples

XML

JSON

Expand

title	XML

Code Block

language	text

<userGroups>
  <userGroup>

<ctrlNavigationVisibility>true</ctrlNavigationVisibility>

<description>Description</description>

<description>Description</description>

<email>test@stonebranch

<email>test@stonebranch.com</

email>

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>

groupMembers>

<groupRoles>
        <groupRole>

<role

<role description="report admin role">ops_report_admin</

role>

role>

<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </

groupRoles>

groupRoles>

<manager

<manager />

<name>test1</name>

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

navigationVisibility>

navigationVisibility>

<parent

<parent />

<permissions>
        <permission>

<allGroups>true</allGroups>

<commands

<commands />

<defaultGroup>true</defaultGroup>

<nameWildcard>*</

nameWildcard>

nameWildcard>
       <notGroups>false</notGroups>

<opCreate>true</opCreate>

<opDelete>true</opDelete>

<opExecute>false</opExecute>

<opExecute>false</opExecute>

<opRead>true</opRead>

<opUpdate>true</opUpdate>

<opswiseGroups

<opswiseGroups />

<permissionType>Task</permissionType>

<sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </

permissions>

permissions>

<sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>
   <userGroup>

<ctrlNavigationVisibility>true</ctrlNavigationVisibility>

<description>Description</description>

<description>Description</description>

<groupMembers

<groupMembers />

<groupRoles>
        <groupRole>

<role

<role description="report admin role">ops_report_admin</

role>

role>

<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </

groupRoles>

groupRoles>

<manager

<manager />

<name>test2</name>

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

navigationVisibility>

navigationVisibility>

<parent

<parent />

<permissions>
        <permission>

<allGroups>true</allGroups>

<commands

<commands />

<defaultGroup>true</defaultGroup>

<nameWildcard>*</

nameWildcard>

nameWildcard>
       <notGroups>false</notGroups>

<opCreate>true</opCreate>

<opDelete>true</opDelete>

<opExecute>false</opExecute>

<opExecute>false</opExecute>

<opRead>true</opRead>

<opUpdate>true</opUpdate>

<opswiseGroups

<opswiseGroups />

<permissionType>Task</permissionType>

<sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </

permissions>

permissions>

<sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>

Expand

title	JSON

Code Block

language	text

[ 
  {
     "ctrlNavigationVisibility": true,
     "description": "Description",
     "email": "test@stonebranch.com",
     "groupMembers": [ 
        {
          "sysId": "b6fd058ee3db424ea374109299949b18",
          "user": {
            "name": "USERC",
            "value": "userc"
          }
        } 
     ],
     "groupRoles": [ 
        {
           "role": {
              "description": "The report administrator role.",
              "value": "ops_report_admin"
           },
           "sysId": "4112408600e947b89d051d36bf9cf6b3"
        } 
     ],
     "manager": null,
     "name": "test1",
     "navigationVisibility": [ "Reports" ],
     "parent": null,
     "permissions": [], 
     "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
   },
   {
     "ctrlNavigationVisibility": true,
     "description": "Description",
     "groupMembers": [], 
     "groupRoles": [ 
        {
           "role": {
              "description": "The report administrator role.",
              "value": "ops_report_admin"
           },
           "sysId": "4112408600e947b89d051d36bf9cf6b3"
        } 
     ],
     "manager": null,
     "name": "test2",
     "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"
        } 
      ],
      "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
   }
]

Anchor

	Modify a Group
	Modify a Group

...

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>true</ctrlNavigationVisibility>

<description>Description</description>

<description>Description</description>

<email>test@stonebranch

<email>test@stonebranch.com</

email>

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>

groupMembers>

<groupRoles>
     <groupRole>

<role

<role description="report admin role">ops_report_admin</

role>

role>

<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
     </groupRole>
  </

groupRoles>

groupRoles>

<manager

<manager />

<name>test</name>

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

navigationVisibility>

navigationVisibility>

<parent

<parent />

<permissions>
     <permission>

<allGroups>true</allGroups>

<commands

<commands />

<defaultGroup>true</defaultGroup>

<nameWildcard>*</nameWildcard> <opCreate>true</opCreate> <opDelete>true</opDelete> <opExecute>false</opExecute> <opRead>true</opRead> <opUpdate>true</opUpdate> <opswiseGroups

<nameWildcard>*</nameWildcard>
    <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>
		...
  </

permissions>

permissions>

<sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
</userGroup>

Expand

title	JSON

Code Block

language	text

{
  "ctrlNavigationVisibility": true,
  "description": "Description",
  "email": "test@stonebranch.com",
  "groupMembers": [ {
    "sysId": "b6fd058ee3db424ea374109299949b18",
    "user": {
      "name": "USERC",
      "value": "userc"
    }
  }, {
    "sysId": "c54e8898f3bb493e9f5ed7f030007e2e",
    "user": {
      "name": "USERB",
      "value": "userb"
    }
  } ],
  "groupRoles": [ {
    "role": {
      "description": "The report administrator role.",
      "value": "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"
}

Anchor

	Properties
	Properties

...

Versions Compared

Old Version 5

New Version 6

Key

List Groups XML and JSON Examples