Actuate Information Delivery API operations : UpdateRoleOperation
 
UpdateRoleOperation
Specifies the tasks to perform during the UpdateRole operation.
Request schema
<xsd:complexType name="UpdateRoleOperation">
<xsd:sequence>
<xsd:choice>
<xsd:element name="SetAttributes" type="typens:Role"
minOccurs="0"/>
<xsd:element name="AssignedToUsersByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="DroppedFromUsersByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetBearingUsersByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="AddChildRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RemoveChildRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetChildRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="AddParentRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RemoveParentRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetParentRolesByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="AssignedToUsersById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="DroppedFromUsersById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetBearingUsersById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="AddChildRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RemoveChildRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetChildRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="AddParentRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RemoveParentRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SetParentRolesById"
type="typens:ArrayOfString" minOccurs="0"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
SetAttributes
The general attributes to update.
AssignedToUsersByName
The names of roles to which to assign users. Specify either AssignedToUsersByName or AssignedToUsersById.
DroppedFromUsersByName
The names of roles from which to delete users. Specify either DroppedFromUsersByName or DroppedFromUsersById.
SetBearingUsersByName
The names of roles to which to reassign users. Specify either SetBearingUsersByName or SetBearingUsersById.
AddChildRolesByName
The names of roles to add to the role as descendant roles. Specify either AddChildRolesByName or AddChildRolesById.
RemoveChildRolesByName
The names of descendant roles to remove from the role. Specify either RemoveChildRolesByName or RemoveChildRolesById.
SetChildRolesByName
The names of the role’s descendant roles. Specify either SetChildRolesByName or SetChildRolesById.
AddParentRolesByName
The names of roles to add to the role as its ascendant roles. Specify either AddParentRolesByName or AddParentRolesById.
RemoveParentRolesByName
The name of the parent role to remove. Specify either RemoveParentRolesByName or RemoveParentRolesById.
SetParentRolesByName
The names of the role’s ascendant roles. Specify either SetParentRolesByName or SetParentRolesById.
AssignedToUsersById
The IDs of roles to which to assign users. Specify either AssignedToUsersById or AssignedToUsersByName.
DroppedFromUsersById
The IDs of roles from which to delete users. Specify either DroppedFromUsersById or DroppedFromUsersByName.
SetBearingUsersById
The IDs of roles to which to reassign users. Specify either SetBearingUsersById or SetBearingUsersByName.
AddChildRolesById
The IDs of roles to add to the role as descendant roles. Specify either AddChildRolesByName or AddChildRolesById.
RemoveChildRolesById
The IDs of descendant roles to remove from the role. Specify either RemoveChildRolesById or RemoveChildRolesByName.
SetChildRolesById
The IDs of the role’s descendant roles. Specify either SetChildRolesById or SetChildRolesByName.
AddParentRolesById
The IDs of roles to add to the role as its ascendant roles. Specify either AddParentRolesById or AddParentRolesByName.
RemoveParentRolesById
The IDs of the ascendant roles to remove. Specify either RemoveParentRolesByName or RemoveParentRolesById.
SetParentRolesById
The IDs of the role’s ascendant roles. Specify either SetParentRolesById or SetParentRolesByName.