Operation | Description |
CopyFile | Copies a file or folder in the working directory to a specified target directory. The request must specify whether to copy a single file or folder, a file or folder list, or all files or folders that match specific conditions. CopyFile is accessed through the Administrate operation. |
CreateFileType | Creates a new file type in BIRT iHub. CreateFileType is accessed through the Administrate operation. |
CreateFolder | Creates a folder in an Encyclopedia volume. CreateFolder is accessed through the Administrate operation. |
DeleteFile | Deletes files or folders from the Encyclopedia volume. The request must specify whether to delete a single file or folder, a list of files or folders, or files or folders that match specific conditions. DeleteFile is accessed through the Administrate operation. |
DeleteFileType | Deletes file types. The request must specify whether to delete a single file type, a list of file types, or file types that match specific conditions. DeleteFileType is accessed through the Administrate operation. |
DownloadFile | Downloads a persistent file. File content streams to the client as a MIME attachment or is embedded in the response. |
DownloadTransientFile | Downloads a transient file. The request requires a FileId and can also indicate whether to decompose a compound document. File content can be attached or embedded in the response. |
GetDataExtraction Formats | Retrieves a list of DataExtractionFormat objects for a specific file type. |
GetFileDetails | Retrieves the properties of a file or folder, including the FileId, the file’s ACL, and its autoarchive rules. |
GetFileTypeParameter Definitions | Retrieves the definitions of parameters for a specific file type on the target Encyclopedia volume. |
GetFolderItems | Retrieves a list of files or folders in an Encyclopedia volume folder. |
MoveFile | Moves a file or folder from the working directory to a specified target directory in the Encyclopedia volume. The request must specify whether to move a single file or folder, a file or folder list, or all files or folders that match specific conditions. MoveFile is accessed through the Administrate operation. |
SaveTransientReport | Saves a transient report to a specified file. |
UpdateFile, UpdateFileOperation, UpdateFileOperation Group | Updates file or folder properties in the Encyclopedia volume. The request must specify the update task to apply, such as updating general properties, adding or removing dependencies, or changing parameters. UpdateFile must also specify whether the task applies to a single file or folder, a file or folder list, or files or folders that match specific conditions. Write privilege is required on a file or folder to update its properties. Grant privilege is required to update privileges on a file or folder. UpdateFile is accessed through the Administrate operation. |
UpdateFileType, UpdateFileTypeOperation, UpdateFileTypeOperation Group | Updates file type properties in the Encyclopedia volume. The request must specify the update task to apply, such as updating general properties, and adding file type parameters. UpdateFileType must also specify whether the task applies to a single file type, a list of file types, or file types that match specific conditions. UpdateFileType is accessed through the Administrate operation. |
UploadFile | Uploads a file to an Encyclopedia volume. The client can specify a version name and can indicate whether to create a new version of the file. Content can upload to BIRT iHub as a MIME attachment or an object embedded in the request. |