AdminOperation
Controls the ability to create, delete, update, copy, and move items within an Encyclopedia volume. An AdminOperation request represents a single unit of work within an Administrate operation. Only an Encyclopedia volume administrator or a user in the Administrator role uses these operations.
Request schema
<xsd:complexType name="AdminOperation">
<xsd:sequence>
<xsd:choice>
<xsd:element name="Transaction" type="typens:Transaction"
minOccurs="0" />
<xsd:element name="CreateUser" type="typens:CreateUser"
minOccurs="0" />
<xsd:element name="DeleteUser" type="typens:DeleteUser"
minOccurs="0" />
<xsd:element name="UndeleteUser"
type="typens:UndeleteUser" minOccurs="0"/>
<xsd:element name="UpdateUser" type="typens:UpdateUser"
minOccurs="0" />
<xsd:element name="CreateGroup" type="typens:CreateGroup"
minOccurs="0" />
<xsd:element name="DeleteGroup" type="typens:DeleteGroup"
<xsd:element name="UpdateGroup" type="typens:UpdateGroup"
minOccurs="0" /> <xsd:element name="CreateChannel"
type="typens:CreateChannel" minOccurs="0" />
<xsd:element name="DeleteChannel"
type="typens:DeleteChannel" minOccurs="0" />
<xsd:element name="UpdateChannel"
type="typens:UpdateChannel" minOccurs="0" />
<xsd:element name="CreateRole" type="typens:CreateRole"
minOccurs="0" />
<xsd:element name="DeleteRole" type="typens:DeleteRole"
minOccurs="0" />
<xsd:element name="UpdateRole" type="typens:UpdateRole"
minOccurs="0" />
<xsd:element name="CreateFileType"
type="typens:CreateFileType" minOccurs="0" />
<xsd:element name="DeleteFileType"
type="typens:DeleteFileType" minOccurs="0" />
<xsd:element name="UpdateFileType"
type="typens:UpdateFileType" minOccurs="0" />
<xsd:element name="CreateFolder"
type="typens:CreateFolder" minOccurs="0" />
<xsd:element name="DeleteFile" type="typens:DeleteFile"
minOccurs="0" />
<xsd:element name="MoveFile" type="typens:MoveFile"
minOccurs="0" />
<xsd:element name="CopyFile" type="typens:CopyFile"
minOccurs="0" />
<xsd:element name="UpdateFile" type="typens:UpdateFile"
minOccurs="0" />
<xsd:element name="DeleteJob" type="typens:DeleteJob"
minOccurs="0" />
<xsd:element name="DeleteJobNotices"
type="typens:DeleteJobNotices" minOccurs="0" />
<xsd:element name="DeleteJobSchedule"
type="typens:DeleteJobSchedule" minOccurs="0"/>
<xsd:element name="UpdateJobSchedule"
type="typens:UpdateJobSchedule" minOccurs="0" />
<xsd:element name="UpdateVolumeProperties"
type="typens:UpdateVolumeProperties" minOccurs="0" />
<xsd:element name="UpdateOpenSecurityCache"
type="typens:UpdateOpenSecurityCache" minOccurs="0" />
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
Transaction
A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.
CreateUser
Creates a user in the Encyclopedia volume.
DeleteUser
Deletes one or more users.
UndeleteUser
Undeletes one or more previously deleted users within the unit of work.
UpdateUser
Updates user properties in the Encyclopedia volume.
CreateGroup
Creates a notification group in an Encyclopedia volume.
DeleteGroup
Deletes one or more notification groups.
UpdateGroup
Updates notification group properties in the Encyclopedia volume.
CreateChannel
Creates a channel in an Encyclopedia volume.
DeleteChannel
Deletes channels from the Encyclopedia volume.
UpdateChannel
Updates channel properties in the Encyclopedia volume.
CreateRole
Creates a security role in the Encyclopedia volume.
DeleteRole
Deletes one or more security roles.
UpdateRole
Updates security role properties in the Encyclopedia volume.
CreateFileType
Creates a new file type in BIRT iHub.
DeleteFileType
Deletes file types.
UpdateFileType
Updates file type properties in the Encyclopedia volume.
CreateFolder
Creates a folder in an Encyclopedia volume.
DeleteFile
Deletes files or folders from the Encyclopedia volume.
MoveFile
Moves a file or folder from the working directory to a specified target directory in the Encyclopedia volume.
CopyFile
Copies a file or folder in the working directory to a specified target directory.
UpdateFile
Updates file or folder properties in the Encyclopedia volume.
DeleteJob
Deletes one or more jobs.
DeleteJobNotices
Deletes one or more job notices.
DeleteJobSchedule
Deletes a job schedule.
UpdateJobSchedule
Updates a job schedule.
UpdateVolumeProperties
Updates the properties of a specific Encyclopedia volume.
UpdateOpenSecurityCache
Flushes the Encyclopedia volume’s open security cache and retrieves new data from an external security source.