...
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.
...
...
XML | JSON |
---|
Expand |
---|
|
Code Block |
---|
| <userGroup retainSysIds="true">
<ctrlNavigationVisibility>true<<ctrlNavigationVisibility>false</ctrlNavigationVisibility>
<description>Description</description> <description <email>test@stonebranch.com</email>>
<groupMembers> <email />
<groupMember> <groupMembers>
<sysId>1fe28873315d4316ad8fec7c89477723</sysId> <groupMember>
<user>userc</user> <<sysId>386bf68d82a74a9e94eab18c1b1844c2</groupMember>sysId>
<groupMember> <user name="stone <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>b branch">stonebranch-user-02</user>
<user>userb<</user>groupMember>
</groupMember> <groupMember>
</groupMembers> <groupRoles> <groupRole> <role>ops_report_admin</role>
<sysId>9c0d5e987a5847668c0182abf03c01e7< <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
</groupRole> </groupRoles> <manager />
<name>test</name><user name="stone c branch">stonebranch-user-03</user>
<navigationVisibility> <navigationNode>Reports<</navigationNode>groupMember>
</navigationVisibility> <parent /> <groupMember>
<permissions> <permission> <allGroups>true</allGroups> <commands /> <defaultGroup>true</defaultGroup>
<nameWildcard>*</nameWildcard> <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
<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> <user name="stone a branch">stonebranch-user-01</user>
</permission>groupMember>
<sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId> </userGroup> |
| Expand |
---|
| Code Block |
---|
| {groupMembers>
"ctrlNavigationVisibility": true, <groupRoles>
"description": "Description", "email": "test@stonebranch.com", <groupRole>
"groupMembers": [ { "sysId": "b6fd058ee3db424ea374109299949b18", <role "user": "userc"description="The administrator role.">ops_admin</role>
},{ "sysId": "c54e8898f3bb493e9f5ed7f030007e2e", "user": "userb"<sysId>b80e78a42589435f92f3e176af6dc542</sysId>
} ], "groupRoles": [ {</groupRole>
</groupRoles>
"role": "ops_report_admin", "sysId": "4112408600e947b89d051d36bf9cf6b3"<manager />
} ], <name>stonebranch-group-01</name>
"manager": null, <navigationVisibility/>
"name": "test", "navigationVisibility": [ "Reports" ],
"parent": null,
"permissions": [ {
"allGroups": true,<parent />
<permissions>
<permission>
"commands": null, <allGroups>true</allGroups>
"defaultGroup": true, "nameWildcard": "*", "notGroups": false,<commands />
"opCreate": true, "opDelete": true, <defaultGroup>true</defaultGroup>
"opExecute": false, <nameWildcard>*</nameWildcard>
"opRead": true, "opUpdate": true, <notGroups>false</notGroups>
"opswiseGroups": [], "permissionType": "Task", <opCreate>false</opCreate>
"sysId": "48eb7ec0c0a8026e0da9406feb022f4e" } ], "retainSysIds": true, <opDelete>false</opDelete>
"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.
...
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 |
---|
Expand |
---|
| Code Block |
---|
| <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>
<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>
<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>
<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> <opExecute>false</opExecute>
<opRead>true</opRead>
<opUpdate>false</opUpdate>
<opswiseGroups/>
<permissionType>Task Instance</permissionType>
<sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
</permission>
</permissions>
<sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup> |
|
|
Expand |
---|
|
Code Block |
---|
| {
"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 | |
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>
<ctrlNavigationVisibility>false</ctrlNavigationVisibility>
<description/>
|
|
|
<permission></permissions> <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId></userGroup> Expand |
---|
|
Code Block |
---|
|
[{"ctrlNavigationVisibility":true, "description":"Description","email": "test@stonebranch.com", <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
|
|
|
"groupMembers":[{ <user name="stone b branch">stonebranch-user-02</user>
|
|
|
"sysId":"b6fd058ee3db424ea374109299949b18","user":{"name":"USERC", <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
|
|
|
"value":"userc"} <user name="stone c branch">stonebranch-user-03</user>
|
|
|
}],"groupRoles":[{"role":{ <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
|
|
|
"description":"Thereportadministratorrole.",
name="stone a branch">stonebranch-user-01</user>
|
|
|
"value": "ops_report_admin"</groupMember>
</groupMembers>
|
|
|
},"sysId":"4112408600e947b89d051d36bf9cf6b3"}],"manager": null,description="The administrator role.">ops_admin</role>
|
|
|
"name":"test1","navigationVisibility":[ "Reports" ], <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
|
|
|
"parent":null, "permissions": [],"sysId": "920ef061ff4d498abe6e7ef883b1b5e1"},{"ctrlNavigationVisibility":true, <name>stonebranch-group-01</name>
|
|
|
"description":"Description", "groupMembers": [],"groupRoles": [{"role":{"description": "The report administrator role.", <allGroups>true</allGroups>
|
|
|
"value": "ops_report_admin"}, <defaultGroup>true</defaultGroup>
|
|
|
"sysId":"4112408600e947b89d051d36bf9cf6b3" <nameWildcard>*</nameWildcard>
|
|
|
}],"manager":null, <notGroups>false</notGroups>
|
|
|
"name":"test2","navigationVisibility":["Reports"], <opCreate>false</opCreate>
|
|
|
"parent":null,"permissions":[ <opDelete>false</opDelete>
|
|
|
{"allGroups": true,<opExecute>false</opExecute>
|
|
|
"commands":null,"defaultGroup":true, <opUpdate>false</opUpdate>
|
|
|
"nameWildcard":"*", "notGroups": false, "opCreate":true, <permissionType>Task Instance</permissionType>
|
|
|
"opDelete":true, <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
|
|
|
"opExecute":false,"opRead":true,"opUpdate": true, <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup>
|
|
|
opswiseGroupsctrlNavigationVisibility" : |
|
|
[] permissionType"Task"null,
"groupMembers" : [ {
|
|
|
48eb7ec0c0a8026e0da9406feb022f4e386bf68d82a74a9e94eab18c1b1844c2",
"user" : {
|
|
|
}]sysId920ef061ff4d498abe6e7ef883b1b5e1}
]...
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
...
...
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 |
---|
|
Code Block |
---|
|
<userGroup retainSysIds="true">
<ctrlNavigationVisibility>true</ctrlNavigationVisibility>
<description>Description</description>
<email>test@stonebranch.com</email>
<groupMembers>
<groupMember>
<sysId>1fe28873315d4316ad8fec7c89477723</sysId> }
}, {
"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
Read a Group
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 |
---|
|
Code Block |
---|
| <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 />
<user name="User C">userc</user> <defaultGroup>true</defaultGroup>
<nameWildcard>*</groupMember>nameWildcard>
<groupMember> <notGroups>false</notGroups>
<sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId> <user name="User B">userb</user> <opCreate>false</opCreate>
</groupMember><opDelete>false</opDelete>
</groupMembers> <groupRoles> <opExecute>false</opExecute>
<groupRole> <role description="report admin role">ops_report_admin</role> <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId> <<opRead>true</groupRole>opRead>
</groupRoles> <manager /> <name>test</name> <navigationVisibility><opUpdate>false</opUpdate>
<navigationNode>Reports</navigationNode> </navigationVisibility> <parent <opswiseGroups/>
<permissions> <permission> <allGroups>true</allGroups> <commands />
<defaultGroup>true</defaultGroup>
<nameWildcard>*</nameWildcard>
<permissionType>Task Instance</permissionType>
<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>59e5565c9f6a45ed8633d05a91ac1019</sysId>
</permission>
... </permissions>
<sysId>920ef061ff4d498abe6e7ef883b1b5e1<<sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup> |
|
|
Expand |
---|
|
Code Block |
---|
| { | {
"ctrlNavigationVisibility" : false,
"description" : null,
"email" : null,
"groupMembers" : [ {
"sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
"ctrlNavigationVisibilityuser" : {
true, "descriptionname" : "Descriptionstone b branch",
"emailvalue" : "test@stonebranch.com",stonebranch-user-02"
"groupMembers": [}
}, {
"sysId" : "b6fd058ee3db424ea374109299949b18792aa1dc1a1b4decb0b02d82ed7e9422",
"user" : {
"name" : "USERCstone c branch",
"value" : "usercstonebranch-user-03"
}
}, {
"sysId" : "c54e8898f3bb493e9f5ed7f030007e2eb78079e1166d4c5180d7e42443de44a0",
"user" : {
"name" : "USERBstone a branch",
"value" : "userbstonebranch-user-01"
}
} ],
"groupRoles" : [ {
"role" : {
"description" : "The report administrator role.",
"value" : "ops_report_admin"
},
"sysId" : "4112408600e947b89d051d36bf9cf6b3b80e78a42589435f92f3e176af6dc542"
} ],
"manager" : null,
"name" : "teststonebranch-group-01",
"navigationVisibility" : [ "Reports" ],
"parent" : null,
"permissions" : [ {
"allGroups" : true,
"commands" : null,
"defaultGroup" : true,
"nameWildcard" : "*",
"notGroups" : false,
"opCreate" : truefalse,
"opDelete" : truefalse,
"opExecute" : false,
"opRead" : true,
"opUpdate" : truefalse,
"opswiseGroups" : [ ],
"permissionType" : "Task Instance",
"sysId" : "48eb7ec0c0a8026e0da9406feb022f4e59e5565c9f6a45ed8633d05a91ac1019"
} ],
"retainSysIds" : true,
"sysId" : "920ef061ff4d498abe6e7ef883b1b5e1b39b2b8eac644e068a68f92f325b0c74"
} |
|
|
...
Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| allGroups - PERM |
---|
| allGroups - PERM |
---|
|
allGroups | Member of Any Business Service or Unassigned Business Service Criteria | 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 Business Service Criteria | 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 |
notGroups | Not Member of Business Services Business Service Criteria | 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 | 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 |
| n/a | System ID field in the database for this record. | Persisted only if retainSysIds is set to true. | N |
...