IDAPI operations quick reference

Table 2‑1 lists the Actuate IDAPI Operations. For more information about IDAPI Operation WSDL definitions, see Integrating Applications into BIRT iHub.Understanding the Information Delivery API and schema.

Table 2‑1 IDAPI operations summary
Operation	Description
Administrate	Performs file and user administrative operations
CallOpenSecurityLibrary	Executes an RSSE operation
CancelJob	Cancels a job
CancelReport	Cancels a report execute operation
CreateParameterValuesFile	Creates a parameter values file
CreateResourceGroup	Creates a resource group
CubeExtraction	Extracts data from a cube
DataExtraction	Extracts data from a non-cube resource or file
DeleteResourceGroup	Removes a resource group
DownloadFile	Downloads a file
ExecuteReport	Generates a temporary report
ExecuteVolumeCommand	Executes predefined volume control commands
ExtractParameterDefinitionsFromFile	Extracts parameter definitions from a report file
ExportParameterDefinitionsToFile	Exports parameter definitions from a report file
GetAllCounterValues	Returns the values for all counters
GetBookmarks	Returns a list of bookmarks from a report
GetCapabilities	Returns a list of capabilities for a user group
GetCapabilitiesByCategory	Returns a sorted list of capabilities for a group
GetCapabilityCategories	Returns capability categories
GetCounterValues	Returns the IDs, names, and values of a counter.
GetCubeMetaData	Returns cube result set schema details
GetDataExtractionFormats	Returns a list of the output format and MIME types for each file type
GetDocumentConversionOptions	Returns a list of the document conversion options for each file type
GetFactoryServiceInfo	Returns details about a Factory service
GetFactoryServiceJobs	Returns a list of jobs pending and running for a Factory service
GetFileACL	Returns the access control list for a file
GetFileCreationACL	Returns the access control list for a template
GetFileDetails	Returns details about a file
GetFileTypeParameterDefinitions	Returns parameters for the specified file type
GetFolderItems	Returns a list for folder contents
GetJavaReportEmbededComponent	Returns an embedded component, such as an image or graph
GetJavaReportTOC	Returns the table of contents
GetJobDetails	Returns the detail information for a job
GetMetaData	Returns metadata for the result set schema
GetNoticeJobDetails	Returns the details of a job notice
GetPageCount	Returns the number of pages in a report file
GetPageNumber	Returns the current page number
GetParameterPickList	Returns a parameter pick list
GetReportParameters	Returns the list of report parameters
GetResourceGroupInfo	Returns the resource group details
GetResourceGroupList	Returns a list of resource groups
GetServerResourceGroupConfiguration	Returns a resource group configuration
GetSyncJobInfo	Returns information about an immediate job
GetSystemMDSInfo	Returns Message Distribution service details
GetSystemPrinters	Returns a list of printers
GetSystemServerList	Returns a list of servers in a cluster
GetTOC	Obsolete
GetUserExtendedProperties	Returns the extended properties for a user
GetUserGroupExtendedProperties	Returns the extended properties for a user group
GetUserGroupProductAccess	Returns the product family access for a user group
GetUserLicenseOptions	Returns a list of licensed options for a user
GetUserPreference	Returns user preferences
GetUserPrinterOptions	Returns user printing options
GetVolumeProperties	Returns volume properties
GrantUserGroupCapabilities	Adds user group capabilities
GrantUserGroupProductAccess	Adds user group product access
InstallApp	Installs an application
IsSSOEnabled	Determines whether single-sign-on is enabled
Login	Authenticates a user
Ping	Pings the server
PrintReport	Prints a document
RevokeUserGroupCapabilities	Removes user group capabilities
RevokeUserGroupProductAccess	Removes user group product access
SaveTransientReport	Saves a report produced by an immediate job
SelectFiles	Sets selected files
SelectFileTypes	Sets selected file types
SelectJavaReportPage	Sets selected report page
SelectJobNotices	Sets selected job notices
SelectJobs	Sets selected jobs
SelectJobSchedules	Sets selected job schedules
SelectUserGroups	Sets selected user groups
SelectUsers	Sets selected users
SetServerResourceGroupConfiguration	Sets the resource group configuration
SetUserExtendedProperties	Sets extended properties for a user
SetUserGroupExtendedProperties	Sets extended properties for a user group
SetUserPreference	Sets user preferences
SubmitJob	Creates a job
SystemLogin	Authenticates the administrator user
UpdateResourceGroup	Refreshes the resource group list
UploadFile	Copies a file to the volume
VerifyAuthId	Checks for the existence of an AuthID
WaitForExecuteReport	Returns the status of a cancel request for an immediate report job

Administrate

Specifies the AdminOperation element which controls abilities to modify a volume. Only a volume administrator or a user in the Administrator role uses Administrate operations.

Request element

AdminOperation

Any sequence of CopyFile, CreateFileType, CreateFolder, CreateUser, CreateUserGroup, DeleteFile, DeleteFileType, DeleteJob, DeleteJobNotices, DeleteJobSchedule, DeleteUser, DeleteUserGroup, MoveFile, Transaction, UndeleteUser, UpdateFile, UpdateFileType, UpdateJobSchedule, UpdateOpenSecurityCache, UpdateUser, UpdateUserGroup, or UpdateVolumeProperties. Specifies a set of operations and their execution order for an Administrate operation. AdminOperation is a set of complex data types which details how to create, delete, update, copy, and move items within a volume. Each AdminOperation element represents a single unit of work within an Administrate operation. Only a volume administrator or a user in the Administrator role uses these operations. The valid AdminOperation values are listed and described in Table 2‑2.

Table 2‑2 Administrative operations
Value	Purpose
CopyFile	Copies a file or folder in the working directory to a specified target directory.
CreateFileType	Creates a new file type in the volume.
CreateFolder	Creates a folder in a volume.
CreateUser	Creates a user in the volume.
CreateUserGroup	Creates a user group.
DeleteFile	Deletes files or folders from the volume.
DeleteFileType	Deletes file types from the volume.
DeleteJob	Deletes one or more jobs.
DeleteJobNotices	Deletes one or more job notices.
DeleteJobSchedule	Deletes a job schedule.
DeleteUser	Deletes one or more users.
DeleteUserGroup	Deletes one or more user groups.
MoveFile	Moves a file or folder from the working directory to a specified target directory in the volume.
Transaction	A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.
UndeleteUser	Restores a previously deleted user.
UpdateFile	Updates file or folder properties in the volume.
UpdateFileType	Updates file type properties in the volume.
UpdateJobSchedule	Updates a job schedule.
UpdateOpenSecurityCache	Flushes the volume’s open security cache and retrieves new data from an external security source.
UpdateUser	Updates user properties.
UpdateUserGroup	Updates user group properties.
UpdateVolumeProperties	Updates the properties of a specific volume.

CallOpenSecurityLibrary

Calls the Report Server Security Extension (RSSE) API AcRSSEPassThrough function or PassThrough message, which calls the RSSE for general purposes. The application then interprets the value AcRSSEPassThrough or PassThrough returns, along with the return code. The RSSE library registered with BIRT iHub determines the returned value.

Request element

InputParameter

String. The input parameter string.

Response elements

OutputParameter

String. The output parameter.

ReturnCode

Int. The return code.

CancelJob

Terminates a job.

Request element

JobId

String. The id of the job to be cancelled.

Response elements

Status

CancelJobStatus. The status of the cancelled job.

ErrorDescription

String. An error message regarding the cancelled job.

CancelReport

Stops synchronous report execution. Synchronous report execution can be cancelled only after the connection handle is received. ConnectionHandle is a session ID of the object.

The job submitter can cancel a report. Only the system administrator can cancel or get the information about the report of another user.

Request element

ObjectId

String. The object ID of the report to cancel.

Response elements

Status

String. The status of the request. One of the following values:

Succeeded

The synchronous report generation was successfully cancelled.

Failed

The request failed.

InActive

The synchronous report generation is complete and cannot be cancelled.

ErrorDescription

String. A description of any error that occurred.

CloseInfoObject

Closes an information object.

Request element

DataFetchHandle

String. The handle to the information object.

CreateDatabaseConnection

Obsolete since iHub Release 2.

CreateIOCache

Obsolete since iHub Release 2.

CreateParameterValuesFile

Creates a report object value (.rov) file. To create the ROV based on specified parameters, specify ParameterList. To create the ROV based on an executable file, specify BasedOnFileName or BasedOnFileId. To create the ROV based on another ROV, specify ParameterFile. If you create the ROV based on either an executable or ROV, all parameters must be defined in the based‑on file.

CreateParameterValuesFile ignores parameters not defined in the based‑on file.

Request elements

BasedOnFileName

String. The name of the executable file on which to base the ROV. Specify either BasedOnFileName or BasedOnFileId.

BasedOnFileId

String. The ID of the executable file on which to base the ROV. Specify either BasedOnFileId or BasedOnFileName.

ParameterFile

NewFile. The existing ROV on which to base the ROV.

ParameterValueList

ArrayOfParameterValue. The list of parameters on which to base the ROV.

FileProperties

ArrayOfString. The file properties to return.

Response element

ParameterValuesFile

File. The ROV attributes.

CreateQuery

Obsolete since iHub Release 2.

CreateResourceGroup

Creates a resource group and specifies its properties.

Request elements

ResourceGroup

ResourceGroup. The resource group details.

ResourceGroupSettingsList

ArrayOfResourceGroupSettings. The resource group settings.

CubeExtraction

Extracts data from a specified data cube object.

Request elements

Object

ObjectIdentifier. The ID of the object from which to extract the data.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

Properties

ArrayOfNameValuePair. The properties to retrieve.

Columns

ArrayOfString. The list of column names.

FilterList

ArrayOfDataFilterCondition. The list of available filters.

SortColumnList

ArrayOfDataSortColumn. The list of columns on which to sort the query.

Response elements

ResultSetSchema

ResultSetSchema. The complex data type that describes the result set schema.

DataExtractionRef

The reference to the complex data type that describes the object in the attachment Attachment. and contains the attachment as binary data.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

DataExtraction

Extracts data from a specified object. DataExtraction does not support extraction from multiple components. If multiple components are specified, DataExtraction only extracts the data of the last component.

Request elements

Object

ObjectIdentifier. The ID of the object from which to extract the data.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

Properties

ArrayOfNameValuePair. The properties to retrieve.

Columns

ArrayOfString. The list of column names.

FilterList

ArrayOfDataFilterCondition. The list of available filters.

SortColumnList

ArrayOfDataSortColumn. The list of columns on which to sort the query.

StartRowNumber

Int. The row number from which to start data extraction.

Response elements

ResultSetSchema

ResultSetSchema. The complex data type that describes the result set schema.

DataExtractionRef

Attachment. The reference to the complex data type that describes the object in the attachment and contains the attachment as binary data.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

DeleteDatabaseConnection

Obsolete since iHub Release 2.

DeleteIOCache

Obsolete since iHub Release 2.

DeleteResourceGroup

Deletes a resource group. You cannot delete a default resource group. If a scheduled job is assigned to a resource group that you delete, the job remains in a pending state when BIRT iHub runs the job. If job is running on a Factory assigned to a resource group that you delete, the job completes.

Element

Name

String. The name of the resource group to delete.

DownloadFile

Downloads a file from a volume. An attachment is included in the response packet, which refers to file content. The file content is streamed back using SOAP attachment.

Request elements

FileName

String. The name of the file to download. Specify either FileName or FileId.

FileId

String. The ID of the file to download. Specify either FileId or FileName.

DecomposeCompoundDocument

Boolean. Specifies whether to download a compound document as one file or multiple attachments. If False, you can download the file as a single file. If True, and the file is a compound document, BIRT iHub splits the file into several attachments. The default value is False.

DownloadEmbedded

Boolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

FileProperties

ArrayOfString. The file properties to return.

Response elements

File

File. The file properties.

Content

Attachment.The downloaded file in an embedded or chunked file operation.

ContainedFiles

ArrayOfAttachment. The downloaded set of files in a decomposed compound document operation.

DownloadTransientFile

Obsolete since iHub Release 2.

ExecuteQuery

Obsolete since iHub Release 2.

ExecuteReport

Triggers the execution of a report in synchronous mode. If you specify WaitTime, BIRT iHub sends a response within the specified time. Otherwise, BIRT iHub sends a response when the request is complete or, if progressive viewing is enabled, when the first page is complete. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.

Request elements

JobName

String. The name of the job.

InputFileName

String. The name of the input executable file. Specify either InputFileName or InputFileId.

InputFileId

String. The ID of the input executable file. Specify either InputFileId or InputFileName.

InputFile

Attachment. Specifies that the input executable file is an attachment in the response. Valid only if the value of SaveOutputFile is False.

OutputFormat

String. The display format for the output file.

SaveOutputFile

Boolean. Specifies whether to use the RequestedOutputFile setting. If False, BIRT iHub ignores RequestedOutputFile. If True and RequestedOutputFile is missing, BIRT iHub reports an error.

RequestedOutputFile

NewFile. The name to use for the output file. Required for persistent jobs.

ParameterValues

ArrayOfParameterValue. The array of parameter values choice with which to overwrite the default parameter values:

ParameterValuesFileName

The name of the report object value (.rov) file to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileName or ParameterValuesFileId.

ParameterValuesFileId

The ID of the ROV to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileId or ParameterValuesFileName.

IsBundled

Boolean. Specifies whether the report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

OpenServerOptions

OpenServerOptions. The open server options to use. Valid options are:

KeepWorkingSpace

DriverTimeout

PollingInterval

ProgressiveViewing

Boolean. Specifies whether to enable progressive viewing. True enables progressive viewing. The default value is True.

WaitTime

Int. The number of seconds BIRT iHub waits before sending a response to the report generation request. Use WaitTime to provide the ability to cancel a synchronous report generation request. The default value is 150 seconds.

Response elements

Status

ExecuteReportStatus. Indicates the execution status of a synchronous job. One of the following values:

Done

Failed

FirstPage

Pending

ErrorDescription

String. The description of the error. Returned if Status is Failed.

OutputFileType

String. Sets the file type for the output file.

ObjectId

String. The object ID of the report.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

ExecuteVolumeCommand

Executes predefined volume control commands.

Request elements

VolumeName

String. The volume on which to execute the commands.

Command

String. One or more of the following commands to execute:

StartPartitionPhaseOut

Starts the storage location phase out.

StartArchive

Starts an archive pass.

StopArchive

Stops an archive pass if one is currently running. If an archive pass is not currently running, this command returns a Failed status. This command is asynchronous. This means that the call returns without waiting for the archive pass to stop. To find out the status of the archive pass after sending this command, use GetVolumeProperties.

Only a user with the Operator or Administrator role can issue this command.

Response elements

Status

String. The status of command execution. One of the following values:

Succeeded

The command succeeded.

Failed

The command failed.

ExtractParameterDefinitionsFromFile

Retrieves the parameter definitions from the specified file.

Request element

Content

Attachment. The parameter definitions to retrieve.

Response element

ParameterList

ArrayOfParameterDefinition. The requested parameter definitions.

ExportParameterDefinitionsToFile

Exports parameter definitions associated with the specified file to a new file.

Request elements

ParameterList

ArrayOfParameterDefinition. The parameters to export.

DownloadEmbedded

Response element

Content

Attachment. The exported parameter definitions.

FetchInfoObjectData

Obsolete since iHub Release 2.

GetAllCounterValues

Retrieves the values of all counters.

Response element

CounterInfoList

ArrayOfCounterInfo. The values of all counters.

GetBookmarks

Retrieves the bookmarks in a report design.

Request element

Object

ObjectIdentifier. The object from which to retrieve the bookmarks.

Response element

BookmarkList

ArrayOfBookMark. The array of bookmarks

GetCapabilities

Requests the array of capabilities available for a user group.

Request elements

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

UserName

String. The user name.

UserId

String. The user ID.

Categories

ArrayOfString. The categories list.

GetChannelACL

Obsolete since iHub Release 3.

GetConnectionProperties

Retrieves the connection properties for a file, including user, role, or user group lists.

Request elements

FileName

String. The name of the file.

FileId

String. The file ID of the file.

UserNames

String. The user names attached to the file.

UserId

String. The user ID attached to the file.

RoleName

String. The role names attached to the file.

RoleId

String. The role ID attached to the file.

UserGroup Names

String. The user group names attached to the file.

UserGroupId

String. The user group ID attached to the file.

Effective

Boolean. The user group ID attached to the file.

Response element

ConnectionProperties

ArrayOfPropertyValue. The list of user, role, and user groups attached to the file, and which properties are effective.

GetConnectionPropertyAssignees

Retrieves the users and user groups for a file.

Request elements

FileName

String. The name of the file.

FileId

String. The file ID of the file.

Response elements

UserNames

ArrayOfString. The user names associated with the file.

RoleNames

ArrayOfString. The roles names associated with the file.

UserGroupNames

ArrayOfString. The user group names associated with the file.

GetContent

Obsolete since iHub Release 2.

GetCounterValues

Retrieves the IDs, names, and values of specific counters.

Request element

CounterIDList

ArrayOfLong. The list of counters for which to retrieve information.

Response element

CounterInfoList

ArrayOfCounterInfo. The IDs, names, and values of the specified counters

GetCubeMetaData

Retrieves cube metadata describing a result set schema.

Request elements

Object

ObjectIdentifier. The object from which to retrieve the metadata.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the metadata.

Response element

ArrayOfResultSetSchema

ArrayOfResultSetSchema. The complex data type that represents an array of ResultSetSchema objects.

GetCustomFormat

Obsolete since iHub Release 2.

GetDatabaseConnectionDefinition

Obsolete since iHub Release 2.

GetDatabaseConnectionParameters

Obsolete since iHub Release 2.

GetDatabaseConnectionTypes

Obsolete since iHub Release 2.

GetDataExtractionFormats

Retrieves a list of DataExtractionFormat objects for a specific file type. These objects consist of an output format and a mime type.

Request element

FileType

String. The name of the file type about which to retrieve information.

Response element

DataExtractionFormats

ArrayOfDataExtractionFormat. The list of DataExtractionFormat objects.

GetDocumentConversionOptions

Retrieves a list of DocumentConversionOptions. A document conversion option includes a file type, output format, mime type and parameter definitions.

Request elements

FileType

String. The file type about which to retrieve the conversion options. When FileType is not set, the response includes options for all the Java report documents. In this case, GetDocumentConversionOptions ignores OutputFormat.

When a FileType is set, GetDocumentConversionOptions returns the options for the conversion to the specified OutputFormat.

OutputFormat

String. The display format about which to retrieve the conversion options. When OutputFormat is not specified, the response includes parameters for all output formats.

If the FileType or OutputFormat fields specify unsupported formats, GetDocumentConversionOptions returns a SOAP fault.

Response element

ConversionOptions

ArrayOfDocumentConversionOptions. The list of DocumentConversionOptions.

GetDynamicData

Obsolete since iHub Release 2.

GetEmbeddedComponent

Obsolete since iHub Release 2.

GetFactoryServiceInfo

Retrieves general information about a Factory service. The node name is specified in the TargetServer element of the SOAP header.

GetFactoryServiceInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

To retrieve a list of servers for which you can obtain information, use GetSystemServerList.

Request element

GetFactoryServiceInfo

Information about the Factory service.

Response elements

ServerName

String. The node for which information is returned.

PendingSyncJobs

Long. The number of synchronous jobs in queue.

SyncJobQueueSize

Long. The maximum number of synchronous jobs allowed in the queue.

RunningSyncJobs

Long. The number of synchronous jobs currently running.

RunningJobs

Long. The total number of jobs currently running.

SyncFactoryProcesses

Long. The number of Factories reserved for running synchronous jobs.

MaxFactoryProcesses

Long. The maximum number of Factories that can run on the system.

TransientReportCacheSize

Long. The maximum disk space available for transient reports, in megabytes.

PercentTransientReportCacheInUse

Long. The currently used percentage of disk space available for transient reports.

CurrentTransientReportTimeout

Long. The number of minutes after which transient reports are deleted from the synchronous cache adjusted according to disk space currently available in the synchronous cache.

TransientReportTimeout

Long. Time after which transient reports are deleted from the synchronous cache, in minutes.

SyncJobQueueWait

Long. The maximum time a job remains in the synchronous queue, in seconds.

MaxSyncJobRuntime

Long. The maximum job execution time, in seconds.

GetFactoryServiceJobs

Retrieves information about pending synchronous jobs and all running jobs on the node. The node is specified in the TargetServer element of the SOAP header.

For pending synchronous jobs, GetFactoryServiceJobs always returns the following information in addition to any values you specify:

ConnectionHandle

ObjectId

IsTransient

Volume

For running jobs, GetFactoryServiceJobs always returns the following information in addition to any values you specify:

IsSyncJob

Volume

ConnectionHandle

ObjectId

IsTransient for synchronous jobs or JobId for asynchronous jobs

To retrieve all information, specify All.

GetFactoryServiceJobs is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Request elements

PendingSyncJobsResultDef

ArrayOfString. Requests the following information about pending synchronous jobs:

Default

ConnectionHandle, ObjectId, IsTransient, and Volume

All

All information

ServerName

The node on which the job originated

Owner

The name of the user who submitted the job

ExecutableFileName

The fully qualified name of the executable file

ExecutableVersionNumber

The fully qualified version number of the executable file

ExecutableVersionName

The fully qualified version name of the executable file

SubmissionTime

The time the job was submitted to the server

QueueTimeout

The number of seconds remaining before the job is deleted from the queue

QueuePosition

The job’s position in the queue

RunningJobsResultDef

ArrayOfString. Requests the following information about all running jobs:

Default

IsSyncJob, Volume, ConnectionHandle, ObjectId, IsTransient for synchronous jobs or JobId for asynchronous jobs.

All

All information.

ServerName

The node on which the job originated.

Owner

The name of the user who submitted the job.

ExecutableFileName

The fully qualified name of the executable file.

ExecutableVersionNumber

The fully qualified version number of the executable file.

ExecutableVersionName

The fully qualified version name of the executable file.

SubmissionTime

The time the job was submitted to the server.

StartTime

The time at which the job execution started.

ExecutionTimeout

The number of seconds remaining before the job execution expires. Always zero (infinite) for asynchronous reports.

IsSyncFactory

True if the Factory is running synchronous jobs, False if the Factory is running asynchronous jobs.

FactoryPid

The Process ID of the Factory.

Response elements

PendingSyncJobs

ArrayOfPendingSyncJob. Information about pending synchronous jobs on the node.

RunningJobs

ArrayOfRunningJob. Information about all running jobs on the node.

GetFileACL

Retrieves the ACL of the specified file or folder.

Request elements

FileId

String. The ID of the file or folder for which to retrieve the ACL. Specific either FileId or FileName.

FileName

String. The full name of the file or folder for which to retrieve the ACL. Specify either FileName or FileId.

GrantedUserId

String. The user ID.

GrantedUserName

String. The user name.

GrantedRoleId

String. The role ID.

GrantedRoleName

String. The role name.

GrantedUserGroupId

String. The user group ID.

GrantedRoleName

String. The user group name.

FetchSize

Int. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirection

Boolean. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimit

Int. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.

FetchHandle

String. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.

Response elements

ACL

ArrayOfPermission. The ACL of the file or folder.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Int. The number of entries in the search result set.

GetFileCreationACL

Retrieves the specified user FileCreationACL. The FileCreationACL is the template applied to all new files the user creates.

Request elements

CreatedByUserName

String. The name of the user whose template to retrieve. Specify either CreatedByUserName or CreatedByUserId.

CreatedByUserId

String. The ID of the user whose template to retrieve. Specify either CreatedByUserId or CreatedByUserName.

GrantedUserId

String. The user ID. Specify either GrantedUserId or GrantedUserName.

GrantedUserName

String. The user name. Specify either GrantedUserName or GrantedUserId.

GrantedRoleId

String. The role ID. Specify either GrantedRoleId or GrantedRoleName.

GrantedRoleName

String. The role name. Specify either GrantedRoleName or GrantedRoleId.

FetchSize

Int. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirection

Boolean. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimit

Int. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.

FetchHandle

String. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.

Response elements

ACL

ArrayOfPermission. The user ACL.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Int. The number of entries in the search result set.

GetFileDetails

Retrieves the properties of the specified file.

Request elements

FileName

String. The full name of the file for which to retrieve properties. Specify either FileName or FileId.

FileId

String. The ID of the file for which to retrieve properties. Specify either FileId or FileName.

ResultDef

ArrayOfString. The properties to retrieve. The file properties are always returned. In addition, you can specify one or more of the following:

ACL

The access control list (ACL) of the file

ArchiveRules

The archive rules of the file

AccessType

The access rights to the file, private or shared

Response elements

File

File. The file properties.

ACL

ArrayOfPermission. The ACL. Returned only if ACL is specified in ResultDef.

ArchiveRules

ArrayOfArchiveRule. The archive rules. Returned only if ArchiveRules is specified in ResultDef.

GetFileTypeParameterDefinitions

Retrieves parameters of the specified file type on the BIRT iHub to which the user is logged in.

Request element

FileType

String. The name of the file type for which to retrieve information.

Response element

ParameterList

ArrayOfParameterDefinition. The list of parameters.

GetFolderItems

Retrieves all specified objects in a specified folder, such as all files or folders, a list of files or folders, or all users.

To search all files or folders that match the specified conditions, specify Search.

Request elements

FolderName

String. The full path and the name of the folder from which to retrieve objects. Specify either FolderName or FolderId.

FolderId

String. The ID of the folder from which to retrieve objects. Specify either FolderId or FolderName.

ResultDef

ArrayOfString. The properties to retrieve. By default, the Id and Name are always returned. In addition, you can specify the following properties:

Description

FileType

Owner

PageCount

Size

TimeStamp

Version

VersionName

UserPermissions

LatestVersionOnly

Boolean. Specifies whether only the latest version is returned. If True, only the latest version is returned. The default value is False.

The search condition. If conditions apply to multiple fields, use ConditionArray. FileSearch.

Response elements

ItemList

ArrayOfFile. The objects matching the search criteria.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Int. The number of entries in the search result set.

GetFormats

Obsolete since iHub Release 2.

GetInfoObject

Obsolete since iHub Release 2.

GetJavaReportEmbededComponent

Retrieves an embedded component in the document such as an image or a graph.

Request elements

Object

ObjectIdentifier. The ID of the object from which to retrieve an embedded component in a document.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component to retrieve.

Attributes

ArrayOfNameValuePair. Currently not used by BIRT reports.

DownloadEmbedded

Response elements

EmbeddedRef

Attachment. Contains the following properties of the attachment:

MimeType

ContentEncoding

ContentLength

Locale

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetJavaReportTOC

Retrieves the table of contents (TOC) of the document.

Request elements

Object

ObjectIdentifier. The ID of the object from which to retrieve the TOC.

DownloadEmbedded

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the TOC.

Recursive

Boolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

Response elements

TocRef

Attachment. The details of the attachment such as contentId, contentType, contentLength, contentEncoding, locale, and contentData.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetJobDetails

Retrieves the properties of a specified job.

Request elements

JobId

String. The ID of the job from which to retrieve properties.

ResultDef

ArrayOfString. The properties to retrieve. You can specify the following properties:

JobAttributes

The general job properties

InputDetail

The job input parameters

Schedules

The job schedule information

PrinterOptions

The printer settings, if available

NotifyUsers

The names of users to receive notifications about the job

NotifyGroups

Obsolete since iHub Release 3

NotifyChannels

Obsolete since iHub Release 3

DefaultOutputFileACL

The output file ACL templates

Status

The job status

ReportParameters

The report parameters from the report parameters value file associated with the job

ResourceGroup

The name of the resource group to which the job is assigned

GroupingEnabled

Obsolete since iHub Release 2.

SupportedQueryFeatures

Obsolete since iHub Release 2.

Response elements

JobAttributes

JobProperties. The general job attributes.

InputDetail

JobInputDetail. The job input parameters.

Schedules

JobSchedule. The job schedule information.

PrinterOptions

PrinterOptions. The job printer settings.

NotifyUsers

ArrayOfString. The names of users to receive notifications about the job.

NotifyGroups

Obsolete since iHub Release 3.

NotifyChannels

Obsolete since iHub Release 3.

DefaultOutputFileACL

ArrayOfPermission. The output file access control list (ACL) templates.

Status

String. The job status.

ReportParameters

ArrayOfParameterValue. The report parameters associated with the job.

Query

Obsolete since iHub Release 2.

OutputFileAccessType

FileAccess. The access rights to the output file. One of the following values:

Private

Only the owner of the file and an administrator can access the file.

Shared

All users and roles specified in the access control list (ACL) for the file can access the file.

WaitForEvent

Event. An event that must complete before processing the response.

GetMetaData

Retrieves the metadata describing a result set schema.

Request elements

Object

ObjectIdentifier. The object from which to retrieve the metadata.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the metadata.

Response element

ArrayOfResultSetSchema

ArrayOfResultSetSchema. The complex data type that represents an array of ResultSetSchema objects.

GetNoticeJobDetails

Retrieves the properties of the specified job notice.

Request elements

JobId

String. The ID of the job from which to retrieve properties.

ResultDef

ArrayOfString. The properties to retrieve. You can specify the following properties:

InputDetail

The job input parameters

Schedules

The job schedule information

PrinterOptions

The printer settings, if available

NotifyUsers

The names of users to receive notifications about the job

NotifyGroups

Obsolete since iHub Release 3

NotifyChannels

Obsolete since iHub Release 3

DefaultOutputFileACL

The output file access control list (ACL) templates

Status

The job status

ReportParameters

The report parameters from the report object value (.rov) file associated with the job

ResourceGroup

The name of the resource group to which the job is assigned

NotifiedChannelId

Obsolete since iHub Release 3.

NotifiedChannelName

Obsolete since iHub Release 3.

GroupingEnabled

Obsolete since iHub Release 2.

SupportedQueryFeatures

Obsolete since iHub Release 2.

Response elements

JobAttributes

JobProperties. The general job attributes.

InputDetail

JobInputDetail. The job input parameters.

Schedules

JobSchedule. The job schedule information.

PrinterOptions

JobPrinterOptions. The job printer settings.

NotifyUsers

ArrayOfString. The names of users to receive notifications about the job.

NotifyGroups

Obsolete since iHub Release 3.

NotifyChannels

Obsolete since iHub Release 3.

DefaultOutputFileACL

ArrayOfPermission. The output file access control list (ACL) templates.

Status

String. The job status.

ReportParameters

ArrayOfParameterValue. The report parameters from report object value (.rov) file associated with the job.

OutputFileAccessType

FileAccess. The access rights to the output file. One of the following values:

Private

Only the owner of the file and an administrator can access the file.

Shared

All users and roles specified in the ACL for the file can access the file.

WaitForEvent

Event. An event that must be completed before the response is processed.

GetPageCount

Retrieves the number of pages in a report in a report generated by iHub.

Request element

Object

ObjectIdentifier. The object from which to retrieve page count.

Response elements

PageCount

String. The number of pages. If the report was uploaded to the volume and not generated by iHub, PageCount is 0.

IsReportCompleted

Boolean. True if report generation is complete, False otherwise.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetPageNumber

Retrieves the page number of a bookmark component in a report.

Request elements

Object

ObjectIdentifier. The object from which to retrieve the page number.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the page number. The page number is a bookmark value in a report.

Response element

PageNumber

String. The component element specifies ArrayOfNameValuePair as the data type. If multiple valid bookmarks are present inside a report, a response only returns the page number for first bookmark. Actuate IDAPI does not support getting the page number for multiple components. If you specify multiple components, the response only returns the page number for the first component.

GetParameterPickList

Retrieves the parameters names from a pick list in a report.

Request elements

Object

ObjectIdentifier. The identifier of the object from which to retrieve the parameter pick list.

CascadingGroupName

String. The cascading group name in the pick list containing the target list.

ParameterName

String. The name of the parameter. Each parameter name is unique within a report even between execution and view parameters.

PrecedingParameterValues

ArrayOfParameterValue. The values of the parameters that precede the specified parameter.

Filter

String. A string prefix to be applied to the overall selection list.

StartIndex

Long. The index where the fetch operation starts.

FetchSize

Long. The maximum number of records to retrieve and return in a result set. The default value is 500.

CountLimit

Long. The Number of entries to be counted after FetchSize is reached. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.

Response elements

ParameterPickList

ArrayOfNameValuePair. List of parameters.

TotalCount

Long. The number of parameters in the list.

GetReportParameters

Retrieves report parameter values. GetReportParameters requires execute or read privileges when executed against a BIRT design, BIRT data design, or BIRT 360 dashboard file. When executed against a BIRT document file, GetReportParameters requires execute, secure read, or read privileges.

Request elements

JobId

String. The ID of the job from which to retrieve the parameter values. Specify JobId to retrieve the parameter values from the report file associated with the job.

ReportFileId

String. The ID of the file from which to retrieve the parameter values. Specify ReportFileId or Report FileName to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.

ReportFileName

String. The name of the file from which to retrieve the parameter values. Specify ReportFileName or Report FileId to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.

ReportParameterType

ReportParameterType. Optional parameter type can include Execution, View, and All. If not specified, only execution parameters return to maintain backward compatibility.

WithoutDynamicPickList

Boolean. If set to True, parameters will be returned without a dynamic pick list.

Response elements

ParameterList

ArrayOfParameterDefinition. The list of parameter definition values such as group, cascading parent name, name, data type, default value, display name, help text, and so forth.

ViewParameterList

ArrayOfParameterDefinition. The list of view parameter definition values such as format, user agent, scaling factor, accept encoding, view operation, path information, embedded object path, redirect path, and PDF quality.

GetResourceGroupInfo

Retrieves information about a specific resource group.

Request element

Name

String. The name of the resource group for which to retrieve information.

Response elements

ResourceGroup

ResourceGroup. Contains the following information about the resource group:

Name

Disabled

Description

Type

MinPriority

Applies only to an asynchronous resource group

MaxPriority

Applies only to an asynchronous resource group

Reserved

Applies only to a synchronous resource group

ResourceGroupSettingsList

ResourceGroupSettings. Contains the following information about the resource group:

ServerName

Activate

MaxFactory

FileTypes

GetResourceGroupList

Retrieves a list of resource groups available to a BIRT iHub. GetResourceGroupList returns two lists, one for asynchronous resource groups and one for synchronous resource groups.

Response elements

AsyncResourceGroupList

ArrayOfResourceGroup. The list of available asynchronous resource groups and the properties of each of those resource groups.

SyncResourceGroupList

ArrayOfResourceGroup. The list of available synchronous resource groups and the properties of each of those resource groups.

ViewResourceGroupList

ArrayOfResourceGroup. The list of available synchronous resource groups and the properties of each of those resource groups.

WorkUnitTypes

ArrayOfString. The list of available work unit types and properties.

GetSavedSearch

Obsolete since iHub Release 2.

GetServerResourceGroupConfiguration

Retrieves information about resource groups available to the specified BIRT iHub.

Request element

ServerName

String. The name of the BIRT iHub from which to retrieve information.

Response element

ServerResourceGroupSettingList

ArrayOfServerResourceGroupSetting. Contains the following information about each resource group:

ResourceGroupName

Activate

Type

MaxFactory

FileTypes

GetStaticData

Obsolete since iHub Release 2.

GetStyleSheet

Obsolete since iHub Release 2.

GetSyncJobInfo

Retrieves information about a synchronous job.

GetSyncJobInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Request element

ObjectId

String. The ID of the synchronous job for which to retrieve information.

Response elements

Status

String. The status of the job. Valid values are:

Pending

Running

Completed

Failed

ErrorDescription

String. The description of the error. Returned if Status is Failed.

Pending

PendingSyncJob. The properties of the pending synchronous job.

Running

RunningJob. The properties of the running synchronous job.

GetSystemMDSInfo

Retrieves the names and properties of an MDS in a cluster or stand-alone server without authenticating the client. Use GetSystemMDSInfo to route requests to an alternate MDS if the one to which the client connects fails.

Request element

OnlineOnly

Boolean. If True, information is retrieved only for an online MDS.

Response element

MDSInfoList

ArrayOfMDSInfo. The information about each MDS.

GetSystemPrinters

Retrieves all system printer information on the BIRT iHub to which the user is logged in.

If GetSystemPrinters cannot retrieve the printer information, for example if the printer is temporarily unavailable, and you specified the PrinterName, the response contains empty or incomplete attributes. If GetSystemPrinters cannot retrieve the printer information and you did not specify PrinterName, a SOAP fault is generated.

Request elements

PrinterName

String. The name of the printer for which to retrieve information. If not specified, information is retrieved for all printers configured for the volume.

GetAllPaperSizes

Boolean. Indicates whether to retrieve all available paper sizes for the printer. If True, all paper sizes are retrieved. If False, only a subset of paper sizes are retrieved. The default value is False.

Response element

Printers

ArrayOfPrinter. The printer information.

GetSystemServerList

Retrieves the list of BIRT iHubs and their states.

GetSystemServerList can retrieve information about cluster servers and online stand-alone servers. GetSystemServerList cannot retrieve information about stand-alone servers that are offline.

GetSystemServerList is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Response element

ServerList

ArrayOfServerInformation. Contains the following information about the server:

Server name

Server state

Error code of a failed server

Error description of a failed server

GetSystemVolumeNames

Obsolete since iHub Release 2.

GetTOC

Obsolete since iHub Release 2.

GetUserExtendedProperties

Gets list of user extended properties, such as property name, ID, and product family.

Request elements

PropertyName

String. The extended user property name.

PropertyNameList

ArrayOfString. The list of extended user property names.

UserName

String. The user name.

UserId

String. The user ID.

ProductFamily

String. The product family.

Response element

Properties

ArrayOfNameValuePair. The list of name-value pairs specifying the user extended properties.

GetUserGroupExtendedProperties

Gets list of user group extended properties, such as property name, user group name, ID, and product family.

Request elements

PropertyName

String. The user group extended property name.

PropertyNameList

ArrayOfString. The list of user group extended property names.

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

ProductFamily

String. The product family.

Response element

Properties

ArrayOfNameValuePair. The user group extended properties list.

GetUserGroupProductAccess

Gets list of product family access by user group name or ID.

Request elements

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

Response element

ProductFamilies

ArrayOfString. The list of accessible product families.

GetUserLicenseOptions

Retrieves the specified user license options.

Request elements

UserId

String. The ID of the user for whom to retrieve the printer settings. Specify either UserId or UserName.

UserName

String. The name of the user for whom to retrieve the printer settings. Specify either UserName or UserId.

Response element

LicenseOptions

ArrayOfString. The license options list.

GetUserPreference

Gets list of user preferences, including preference name and product family.

Request elements

UserId

String. The user ID.

UserName

String. The user name.

PreferenceName

String. The preference name.

PreferenceNameList

ArrayOfString. The preference name list.

ProductFamily

String. The product family.

Response element

Preference

ArrayOfNameValuePair. The user preferences option list.

GetUserPrinterOptions

Retrieves the specified user printer settings.

If GetUserPrinterOptions cannot retrieve the printer information, for example if the printer is temporarily unavailable, and you specified the PrinterName, the response contains empty or incomplete attributes. If GetUserPrinterOptions cannot retrieve the printer information and you did not specify PrinterName, a SOAP fault is generated.

Request elements

UserId

String. The ID of the user for whom to retrieve the printer settings. Specify either UserId or UserName.

UserName

String. The name of the user for whom to retrieve the printer settings. Specify either UserName or UserId.

PrinterName

String. The name of the printer for which to retrieve the settings.

Response element

PrinterOptions

ArrayOfPrinterOptions. The printer settings.

GetVolumeProperties

Retrieves properties of a specific volume.

Request element

ResultDef

ArrayOfString. The properties to retrieve. By default, VolumeProperties are always returned. In addition, you can specify the following properties:

ArchiveLibrary

AutoArchiveSchedule

ExternalUserPropertyNames

OnlineBackupSchedule

TranslatedRoleNames

PrinterOptions

VolumeProperties

Response elements

VolumeProperties

Volume. The volume properties.

TranslatedRoleNames

ExternalTranslatedRoleNames. The translated role names.

ExternalUserPropertyNames

ArrayOfString. The external user property names list.

PrinterOptions

ArrayOfPrinterOptions. The printer options.

AutoArchiveSchedule

JobSchedule. The autoarchive schedule.

ArchiveLibrary

String. The name of the archive application for the volume.

ArchiveServiceCmd

String. The archive service command for the volume.

LicenseOptions

ArrayOfLicenseOption. The license options for the volume.

GrantUserGroupCapabilities

Grants listed user group capabilities by name or ID.

Request elements

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

Capabilities

ArrayOfCapabilities. The array of user group capabilities.

Response element

GrantUserGroupCapabilitiesResponse

The response is empty.

GrantUserGroupProductAccess

Grants listed user group product family access by user group name or ID.

Request elements

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

ProductFamilies

ArrayOfString. The list of accessible product families.

Response element

GrantUserGroupProductAccessResponse

The response is empty.

InstallApp

Installs application using name, ZIP file path, and description.

Request elements

Name

String. The application name.

ZipFilePath

String. The ZIP file path.

Description

String. The application description.

Response element

FolderId

String. The folder ID.

IsSSOEnabled

Determines whether Single-sign-on (SSO) is enabled.

Request elements

RelayState

String. The relay state.

EntityID

String. The entity ID.

Response elements

Enabled

Boolean. Indicates whether SSO is enabled.

DestinationURL

String. The destination URL.

SAMLRequest

String. The SAML request.

RelayState

String. The relay state.

Authenticates a user to the iHub System.

Request elements

User

String. The name of the user to log in.

Password

String. The password of the user to log in. You must specify either Password or Credentials.

EncryptedPwd

String. The password in encrypted.

Credentials

Base64Binary. Extended credentials data. Used for Report Server Security Extension (RSSE) integration. You must specify Either Credentials or Password.

Domain

String. The volume to which to log in. In Release 11 and iHub 2, the Login message must specify the volume name using TargetVolume in the SOAP header and Domain in the SOAP message body. In iHub 3, specifying the volume name using TargetVolume and Domain in the SOAP message body are optional.

UserSetting

Boolean. Specifies whether the response includes detailed user information. If True, the response includes all user attributes. If False, the response does not include detailed user information. The default value is False.

ValidateUserGroups

ArrayOfString. Checks whether the user is in the specified user groups.

RunAsUser

String. Specifies the user name in the run-time environment.

SAMLToken

String. The SAML token.

GetVolumeList

Boolean. Indicates whether to get the volume list.

CapabilityCategories

ArrayOfString. The capability categories list.

ClientVersion

String. Specify the enumeration value ihub3 or actuate11.

Response elements

AuthId

String. The system-generated, encrypted, and authenticated token that the application uses in all subsequent requests.

AdminRights

String. Returned if the user has either Administrator or Operator rights.

User

User. All user attributes except the user password.

LoginVolume

String. The login volume.

FeatureOptions

ArrayOfString. The features available to the user:

ReportGeneration

PageSecureViewing

BIRT Page Level Security option

ValidUserGroups

ArrayOfString. The user roles from the ValidateRoles list. Does not return the user roles that ValidateRoles does not specify. For example, if ValidateRoles specifies Sales, Marketing, and Engineering and the user has Sales and Accounting roles, the response contains only Sales.

Volumes

ArrayOfString. The specified volumes.

Capabilities

The specified capabilities.

SAMLSessionIndex

String. The specified SAML session index.

OpenInfoObject

Obsolete since iHub Release 2.

Ping

Tests whether a specific component of BIRT iHub is operational and retrieves other diagnostic information about the component.

Request elements

Destination

String. The component to test. Valid values are:

MDS

A Message Distribution service

An Encyclopedia engine

A Factory service

A View service

OSD

An open server driver

AIS

An Actuate Integration service

ACS

Obsolete since iHub Release 3

Action

String. The optional action to take. Valid values are:

Echo

Echoes the data specified in Payload.

ReadFile

Opens the specified volume file, reads the file’s contents, then closes the file. Applies only if the value of Destination is EE, FS, or VS. Ping returns the timing of the read operation. Specify the file name in FileName.

WriteFile

Creates a temporary file in a storage location, writes a specified number of bytes to the file, closes the file, then deletes the file. Applies only if the value of Destination is EE or FS. Ping returns the timing information for each step. Specify the storage location in PartitionName. Specify the number of bytes to read in NumBytes.

Connect

Connects to a data source. Specify the connection parameters in ConnectionProperties.

Mode

String. The level of detail to return. Valid values are:

Normal

Returns the names of components in the test path and the timestamps of the request entering and leaving each component. This is the default mode.

Trace

Returns the timestamp of the request entering and leaving major subcomponents of the component being tested.

Concise

Returns the elapsed time between a component’s receipt of the request and the time the component sends a reply.

Server

String. Specifies which instance of a Factory service or View service to test. Applies only if the value of Destination is FS or VS. Use Server in conjunction with the ProcessID element. To test all available instances of the Factory or View service, specify an asterisk (*). If not specified, the BIRT iHub load‑balancing mechanism allocates an available instance of the requested service to respond to the request.

ProcessID

String. Specifies the process ID of the Factory or View service to test. Use in conjunction with the Server element. Applies only if the value of Destination is FS or VS.

FileName

String. If the value of Action is ReadFile, indicates the volume file to read. If the value of Destination is OSD, specifies the executable file to prepare for execution.

PartitionName

String. Specifies the name of the storage location on which to create the temporary file. Applies only if the value of Action is WriteFile.

NumBytes

Long. Specifies the number of bytes to read or write. Applies only if the value of Action is ReadFile or WriteFile. If NumBytes is not specified or 0, the default value of 10 KB is used.

ConnectionProperties

ArrayOfParameterValue. An array of property name and value pairs that specify the parameter values for establishing a data source connection. Applies only if the value of Action is Connect. To establish a connection, you must specify a property with a name DBType and a value that specifies the type of database. You must also specify any other properties that the specific database interface requires. Table 2‑3 lists the valid property names.

Table 2‑3 Valid connection properties
Property name	Applicable database interface	Description
DBType	All	The type of database. Valid values are: DB2, Informix, MSSQL ODBC, Oracle, Sybase, Progress, Progress SQL92
DllPath	DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase	The name of the DLL providing the client database.
UserName	DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase	The database user name.
Password	DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase	The database password.
DataSource	DB2, ODBC	The name of the data source.
ConnectionString	ODBC	Any additional text that ODBC needs to establish the connection.
HostString	Oracle	The Oracle server name for the connection.
DatabaseEnvironment	Informix	The name of the database server, the database, or both database server and database to which to connect.
DatabaseList	Progress	The name of the database.
StartUpParameters	Progress	The Progress Open Interface Broker parameters.
Database	Progress SQL92	The name of the database.
Host	Progress SQL92	The host computer name for a remote database. Not used for a local database. Required if you are connecting to a database running on a database server.
ServiceOrPort	Progress SQL92	The database service name or port number on the database server. Not used for a local database. The port number is an unsigned 16‑bit integer in the range 1–65535.

Payload

String. Specifies the payload data. Applies only if the value of Action is Echo. Payload is binary data attached to the request.

Response elements

String. The Ping reply, in plain text format. The information depends on the value of Mode.

Payload

String. If a value is specified for Payload in the request, the payload data as a string.

PrintReport

Prints a document. PrintReport requests are always executed in asynchronous mode.

The document prints to the specified printer. If a printer is not specified, the document prints to the user default printer.

Both PrintReport and SubmitJob support printing. Use PrintReport to print an existing document. Use SubmitJob to schedule execution and printing from a design executable.

Request elements

JobName

String. The job name.

Priority

Int. The job priority. Limited by the user Max job priority setting.

InputFileName

String. The name of the file to print. Specify either InputFileName or InputFileId.

InputFileId

String. The ID of the file to print. Specify either InputFileId or InputFileName.

Schedules

JobSchedule. The schedule for the print job. If not specified, the print request is sent immediately.

PrinterOptions

JobPrinterOptions. The job printer settings. The printer settings have the following precedence:

Job printer settings

User printer settings

System printer settings

NotifyUsersByName

ArrayOfString. The names of users to receive job completion notice. Specify either NotifyUsersByName or NotifyUsersById.

NotifyGroupsByName

Obsolete since iHub Release 3.

NotifyChannelsByName

Obsolete since iHub Release 3.

NotifyUsersById

ArrayOfString. The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.

NotifyGroupsById

Obsolete since iHub Release 3.

NotifyChannelsById

Obsolete since iHub Release 3.

SendSuccessNotice

Boolean. Specifies whether notices are sent if report printing succeeds.

SendFailureNotice

Boolean. Specifies whether notices are sent if report printing fails.

SendEmailForSuccess

Boolean. Specifies whether an e‑mail is sent when report printing succeeds.

SendEmailForFailure

Boolean. Specifies whether an e‑mail is sent when report printing fails.

OverrideRecipientPref

Boolean. Specifies whether recipient preferences are overridden.

RecordSuccessStatus

Boolean. Specifies whether the job status is kept if report printing succeeds.

RecordFailureStatus

Boolean. Specifies whether the job status is kept if report printing fails.

RetryOptions

RetryOptions. Specifies how to retry printing if the previous attempt failed. Used only if Retryable is specified.

Response element

JobId

String. The ID of the print job. Returned after the job is created.

RevokeUserGroupCapabilities

Revokes list of user group capabilities using group name or ID.

Request elements

UserGroupId

String. The user group ID.

UserGroupName

String. The user group name.

Capabilities

ArrayOfCapabilities. The array of user capabilities.

Response element

RevokeUserGroupCapabilitiesResponse

The revoke user group capabilities response. Data type undefined.

RevokeUserGroupProductAccess

Revokes user group product access using group name, ID, and list of product families.

Request elements

UserGroupId

String. The user group ID.

UserGroupName

String. The user group name.

ProductFamilies

ArrayOfString. The product families list.

Response element

RevokeUserGroupProductAccessResponse

The revoke user group product access response. Data type undefined.

SaveSearch

Obsolete since iHub Release 2.

SaveTransientReport

Saves a report to a specified file.

Request elements

Object

ObjectIdentifier. The object identifier of the report.

NewFile

NewFile. The file to which the report is saved.

Response element

FileId

String. File ID of created report file.

SearchReport

Obsolete since iHub Release 2.

SelectChannels

Obsolete since iHub Release 2.

SelectFiles

Retrieves information about a specified file.

To retrieve a single file or folder, specify Name or Id. To retrieve a list of files or folders, specify NameList or IdList. To search all file or folders that match specific condition, specify Search.

Request elements

WorkingFolderId

String. The ID of the working folder in which to search for the file. Specify either WorkingFolderId or WorkingFolderName.

WorkingFolderName

String. The absolute path and the name of the working folder in which to search for the file. Specify either WorkingFolderName or WorkingFolderId.

Recursive

Boolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

LatestVersionOnly

Boolean. Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.

ResultDef

ArrayOfString. The properties to retrieve.

FileSearch. The search condition. If conditions apply to multiple fields, use ConditionArray.

NameList

ArrayOfString. The name of the file or folder list to retrieve. Specify either IdList or NameList.

IdList

ArrayOfString. The ID of the file or folder list to retrieve. Specify either IdList or NameList.

Name

String. The name of a single file or folder to retrieve. Specify either Name or Id.

String. The ID of a file or folder to retrieve. Specify either Id or Name.

Content

String. Specifies whether the file is embedded in or attached to the response. Valid values are:

Embed

The file is embedded.

Attach

The file is attached.

Response elements

ItemList

ArrayOfFile. The list of attached items that match the search criteria.

ContentItemList

ArrayOfFileContent. The list of embedded items that match the search criteria.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set.

SelectFileTypes

Searches file types for specified information.

To search a single file type, specify Name. To search a list of file types, specify NameList. To search file types matching the specified conditions, specify Search. File names are case sensitive, and file type extensions are stored in uppercase. Specify uppercase for all file type extensions, for example, use RPTDESIGN instead of rptdesign.

Request elements

ResultDef

ArrayOfString. The properties to retrieve.

ArrayOfString. The search conditions. If conditions apply to multiple fields, use ConditionArray.

NameList

ArrayOfString. The list of file types to search.

Name

String. The name of a single file type to search.

Response element

FileTypes

ArrayOfFileType. The specified file types.

SelectGroups

Obsolete since iHub Release 2.

SelectJavaReportPage

Returns a report page formatted in the specified display format indicated by the Page or Component element.

Request elements

Object

ObjectIdentifier. The ID of the object from which to select the report page.

Page

PageIdentifier. The identifier of the page to retrieve.

Component

ArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

ViewParameterValues

ArrayOfParameterValue. Include view parameters if defined in the document. This feature is not currently supported for a BIRT report.

OutputFormat

String. For a BIRT report, the output format can be HTML, rptdocument, or PDF. The default is rptdocument.

ViewProperties

ArrayOfNameValuePair. Specifies the layout and contents of a report such as the name of a bookmark name, table of contents, or an object ID. ViewProperties is available to the BIRT render task as the java.util.Map object in the Engine AppContext under the key ServerViewProperties.

DownloadEmbedded

Response elements

PageRef

Attachment. Contains the following properties of the attachment:

MimeType

ContentEncoding

ContentLength

Locale

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

OutputProperties

ArrayOfNameValuePair. Applies only if Format is CSV. The properties to include in the search result are:

EnableColumnHeaders

If True, column headers are included in the search result. The default value is True.

UseQuoteDelimiter

If True, each data item in the search result is enclosed in double quotes (" "). The default value is True.

SelectJobNotices

Retrieves job notices matching the specified criteria.

Request elements

ResultDef

ArrayOfString. The properties to retrieve. You can specify the following properties:

JobId

JobName

ActualHeadline

CompletionTime

ActualOutputFileId

ActualOutputFileName

VersionName

OutputFileSize

JobNoticeSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

Response elements

JobNotices

ArrayOfJobNotice. The selected job notices.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set.

SelectJobs

Selects all jobs matching the specified conditions. SelectJobs returns states and information for job instances.

In Release 11 or iHub, use SelectJobSchedules to obtain job schedule information. In Release 10 Service Pack 1 and earlier, use SelectJobs with JobCondition, specifying Scheduled, Expired, or Cancelled, to obtain designated job schedule information.

Release 11 Service Pack 4 and later support backward compatibility for all pre‑Release 11 applications that send a SelectJobs request. However, all Release 11 and iHub applications must implement the new SelectJobSchedules API to request schedule information.

Request elements

ResultDef

ArrayOfString. The properties to retrieve.

JobSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList

ArrayOfString. The list of job IDs to search.

String. The ID of a single job to search.

Response elements

Jobs

ArrayOfJobProperties. The selected jobs.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set.

SelectJobSchedules

Selects all scheduled jobs matching the specified criteria. SelectJobSchedules also retrieves information for expired and cancelled jobs.

Release 11 Service Pack 4 and iHub support backward compatibility for all pre‑Release 11 applications that send a SelectJobs request. However, all Release 11 and iHub applications must implement the new SelectJobSchedules API to request schedule information.

Request elements

ResultDef

ArrayOfString. The properties to retrieve.

JobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList

ArrayOfString. The list of job IDs to search.

String. The ID of a single job to search.

Response elements

Jobs

ArrayOfJobProperties. The selected jobs.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set.

SelectPage

Obsolete since iHub Release 2.

SelectRoles

Deprecated since iHub Release 3. Replaced by SelectUserGroups.

SelectUserGroups

Searches user groups for specified information.

To search a single user group, specify Name or Id. To search a list of user groups, specify NameList or IdList. To search user groups matching the specified conditions, specify Search.

ResultDef

ArrayOfString. The properties to retrieve.

UserGroupSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectUserGroups allows only one search condition.

In the following example, <Condition> and <AssignedToUserName> are search conditions:

<Match>roleA</Match>

</Condition>

<AssignedToUserName>Administrator</AssignedToUserName>

</Search>

When using RSSE external registration, the previous search pattern is invalid, generating the following response:

<Message>The search pattern is too long or is incorrect.

</Message>

<Parameter1>More than one search condition is invalid under External Registration

</Parameter1>

</Description>

IdList

ArrayOfString. The list of user IDs to search. Specify either IdList or NameList.

NameList

ArrayOfString. The list of user names to search. Specify either NameList or IdList.

String. The ID of the single user to search. Specify either Id or Name.

Name

String. The name of the single user to search. Specify either Name or Id.

Response elements

Roles

ArrayOfRole. The selected roles.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set.

SelectUsers

Searches users for specified information.

To search a single user, specify Name or Id. To search a list of users, specify NameList or IdList. To search users matching the specified conditions, specify Search.

Request elements

ResultDef

ArrayOfString. The properties to retrieve.

UserSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectUsers allows only one search condition.

IdList

ArrayOfString. The list of user IDs to search. Specify either IdList or NameList.

NameList

ArrayOfString. The list of user names to search. Specify either NameList or IdList.

String. The ID of the single user to search. Specify either Id or Name.

Name

String. The name of the single user to search. Specify either Name or Id.

Response elements

Users

ArrayOfUser. The selected users.

FetchHandle

String. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCount

Long. The number of entries in the search result set. Not used when querying a volume that uses Open Security. In this case, TotalCount returns Null. To retrieve the number of entries from a volume that uses Open Security, use an array length. For example, the following code returns Null:

com.actuate.schemas.SelectUsersResponse userSrchResponse = proxy.selectUsers( userSel );

com.actuate.schemas.ArrayOfUser userArr = userSrchResponse.getUsers();

com.actuate.schemas.User []user = userArr.getUser();

userSrchResponse.getTotalCount();

int noOfUsers1 = userSrchResponse.getTotalCount().intValue();

The following code returns the correct value:

com.actuate.schemas.SelectUsersResponse userSrchResponse = proxy.selectUsers( userSel );

com.actuate.schemas.ArrayOfUser userArr = userSrchResponse.getUsers();

com.actuate.schemas.User []user = userArr.getUser();

userSrchResponse.getTotalCount();

int noOfUsers2 = user.length;

SetConnectionProperties

Sets the connection properties for a file based on user or role.

Request elements

FileName

String. The name of the file.

FileId

String. The file ID.

UserName

String. User name for which to set property values.

UserId

String. User ID for which to set property values.

RoleName

String. The role name for which to set property values.

RoleId

String. The role ID for which to set property values.

UserGroupName

String. The user group name for which to set property values.

UserGroupId

String. The user group ID for which to set property values.

ConnectionProperties

ArrayOfPropertyValue. An array of name-value pairs containing the connection properties being set.

SetServerResourceGroupConfiguration

Sets or updates properties of all resource groups on a BIRT iHub. SetServerResourceGroupConfiguration is available only to a volume administrator or a user with an Administrator role.

Request elements

ServerName

String. The name of the BIRT iHub.

ServerResourceGroupSettingList

ArrayOfServerResourceGroupSetting. Contains one or more of the following properties to set or update:

Activate

MaxFactory

FileTypes

Cannot be set or updated for a default resource group

Response element

SetServerResourceGroupConfigurationResponse

The SetServerResourceGroupConfigurationResponse. Data type undefined.

SetUserExtendedProperties

Sets list of user extended properties using user name or ID and product family.

Request elements

UserName

String. The user name.

UserId

String. The user ID.

Properties

ArrayOfNameValuePair. The user extended properties list.

ProductFamily

String. The product family.

Response element

SetUserExtendedPropertiesResponse

The SetUserExtendedPropertiesResponse. Data type undefined.

SetUserGroupExtendedProperties

Sets list of user group extended properties using user group name or ID.

Request elements

UserGroupName

String. The user group name.

UserGroupId

String. The user group ID.

Properties

ArrayOfNameValuePair. The user group extended property list.

ProductFamily

String. The product family.

Response element

SetUserGroupExtendedPropertiesResponse

The SetUserGroupExtendedPropertiesResponse. Data type undefined.

SetUserPreference

Sets user preference using user name, ID, and product family.

Request elements

UserId

String. The user ID.

UserName

String. The user name.

Preference

ArrayOfNameValuePair. The user preference list.

ProductFamily

String. The product family.

Response element

SetUserPreferenceResponse

The SetUserPreferenceResponse. Data type undefined.

SubmitJob

Generates and prints a report or information object in asynchronous mode. BIRT iHub sends a response after completing the request.

After generating a document in asynchronous mode, you can convert the document to one of the following formats:

Comma-separated values (CSV)

Excel XLS

Excel XLSX

PDF

PostScript

PowerPoint (PPT)

PowerPoint (PPTX)

PSV

Tab-separated values (TSV)

Word (DOC)

Word (DOCX)

When converting a document, the properties of the converted file are the same as the original document properties.

BIRT iHub only supports converting document output for asynchronous generation. Conversion is not supported for the following types of document output:

Synchronous generation

Report bursting

Page-level security

Both SubmitJob and PrintReport support printing. Use SubmitJob to schedule execution and printing from design executables. Use PrintReport to print an existing document.

Request elements

JobName

String. The name of the job.

Headline

String. The job headline.

Priority

Int. The job priority. Job priority is limited by the user Max job priority setting. Valid values are 0–1,000, where 1,000 is the highest priority.

ResourceGroup

String. The resource group to which to assign the job. Available only to a volume administrator or a user with the Administrator role.

InputFileName

String. The full path, name, and version number of the file to use as input. If RunLatestVersion is specified, the version number is ignored.

InputFileId

String. The ID of the file to use as input.

RunLatestVersion

Boolean. Specifies whether to run or print the most recent version of the executable file. If True, the latest version of the file is used. If True, the version number in InputFileName is ignored.The default value is True.

RequestedOutputFile

NewFile. The file name and extension for the output.

Operation

String. Specifies the type of task to perform, RunReport, RunAndPrintReport, ConvertReport, or PrintReport.

ParameterValues

ArrayOfParameterValue. A list of parameter values to use. Specify either ParameterValues, ParameterValueFileId, ParameterValueFileName.

ParameterValueFileName

String. The name of the parameter value file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

ParameterValueFileId

String. The ID of the report object values file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

Schedules

JobSchedule. Specifies the schedule on which to run the report. If not specified, the job runs immediately.

PrinterOptions

ArrayOfPrinterOptions. If the job is to be printed, specifies the job printer settings. If the job is not to be printed, PrinterOptions is ignored. The printer settings have the following precedence:

Job printer settings

User printer settings

System printer settings

NotifyUsersByName

ArrayOfString. The names of users to receive the job completion notice. Specify either NotifyUsersByName or NotifyUsersById.

NotifyGroupsByName

Obsolete since iHub Release 3.

NotifyChannelsByName

Obsolete since iHub Release 3.

NotifyUsersById

ArrayOfString. The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.

NotifyGroupsById

Obsolete since iHub Release 3.

NotifyChannelsById

Obsolete since iHub Release 3.

SendSuccessNotice

Boolean. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendSuccessNotice is True, notices are sent.

SendFailureNotice

Boolean. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True. If SendFailureNotice is True, failure notices are sent to specified users and groups if the job fails.

SendEmailForSuccess

Boolean. Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If True, e-mail notifications are sent to specified users and groups if the job succeeds. The default value is False.

SendEmailForFailure

Boolean. Specifies whether e-mail notifications are sent to specified users and groups if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e-mail notifications are sent. The default value is False.

AttachReportInEmail

Boolean. Specifies whether to attach a report to an e-mail completion notice. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e-mail notification if the job succeeds. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat parameter. The default value is False.

OverrideRecipientPref

Boolean. Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e-mail notifications and output attachments are sent according to job settings. If False, e-mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:

AttachReportInEmail

SendEmailForSuccess

SendEmailForFailure

SendSuccessNotice

SendFailureNotice

EmailFormat

String. Specifies the output format of the report attached to the e-mail notification. Table 2‑4 lists the valid format codes.

Table 2‑4 E-mail attachment formats
Format code	File type description
DOC	Microsoft Word
DOCX	Microsoft Word 2010
PDF	Adobe PDF
PPT	Microsoft PowerPoint
PPTX	Microsoft PowerPoint 2010
PS	Adobe Postscript
XLS	Microsoft Excel
XLSX	Microsoft Excel 2010

RecordSuccessStatus

Boolean. Specifies whether to keep the job status for successful jobs. If True, the job status is kept if job execution succeeds.

RecordFailureStatus

Boolean. Specifies whether to keep the job status for failed jobs. If True, the job status is kept if job execution fails.

IsBundled

Boolean. Specifies whether a report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

RetryOptions

RetryOptions. Specifies how to retry the job if the previous attempt failed. Used only if Retryable is specified.

OpenServerOptions

OpenServerOptions. Contains the following open server options:

KeepWorkingSpace

Specifies whether the workspace directory is removed after the job completes.

DriverTimeout

The time for the driver to return from executing a job.

PollingInterval

The time interval for the open server to get status messages. The minimum value is 10 seconds.

KeepOutputFile

Boolean. Specifies whether the generated output file remains in the volume if the generation request succeeds but the printing request fails. Used if Operation is RunAndPrintReport. If True, the output file remains in the volume if the printing request fails. If False, the output file is deleted if the printing request fails. The default value is False.

ConversionOptions

Obsolete since iHub Release 2.

WaitForEvent

Event. An event that must be completed before the response is processed.

DataACL

ArrayOfString. Specifies the access control list (ACL) restricting data privileges.

Response element

JobId

String. The job ID. Use the job ID to refer to the job in subsequent requests during the current session.

SystemLogin

Logs the user in as the BIRT iHub administrator.

Request elements

SystemPassword

String. The password.

SystemPasswordEncryptLevel

Long. The encryption level of the SystemPassword. Valid values are:

0 - No encryption

1 - Two way encryption

2 - Hash encryption

The default is hash encryption.

Response element

AuthId

String. The system-generated, encrypted authenticated string all subsequent requests use.

UpdateDatabaseConnection

Obsolete since iHub Release 2.

UpdateIOCache

Obsolete since iHub Release 2.

UpdateResourceGroup

Updates resource group properties. You cannot update the resource group name, type, or the name of the BIRT iHub on which the resource group runs.

Request elements

ResourceGroup

ResourceGroup. Contains one or more of the following properties to update:

Disabled

Description

MinPriority

MaxPriority

Reserved

ResourceGroupSettingsList

ArrayOfResourceGroupSettings. Contains one or more of the following properties to update:

Activate

MaxFactory

FileTypes

UploadFile

Uploads a file to a volume. You can upload the file as a MIME attachment or embed it in the request. To embed the file in the request, specify the ContentData element of the attachment.

Request elements

NewFile

NewFile. The file to upload.

CopyFromLatestVersion

ArrayOfString. Copies one or more of the following properties from the latest version of the file, if one exists, to the version of the file that you upload:

Description

The description of the file

Permissions

Access control list (ACL) specifying the users and roles that can access the file

ArchiveRule

The autoarchive rules for the file

Content

Attachment. The information about the file, such as the encoding the file uses and the data to upload.

Response element

FileId

String. The ID of the uploaded file.

VerifyAuthId

Checks the validity of an AuthID string with a target volume.

Request elements

AuthID

String. An authentication ID.

Volume

String. The volume with which to verify the AuthID.

UserName

String. The user name.

Response element

isValid

A boolean value for the validity of the AuthID with the target volume and user name.

WaitForExecuteReport

Retrieves the status of the report generation request after receiving the Pending status. Send WaitForExecuteReport after sending CancelReport.

If progressive viewing is enabled, WaitForExecuteReport retrieves the status after the first page generates. Otherwise, WaitForExecuteReport waits until the report is complete.

If the current job status is Pending, WaitForExecuteReport waits for the report to generate.

Request element

ObjectId

String. The ID of the job.

Response elements

Status

String. The status of the request. One of the following values:

Done

Failed

FirstPage

ErrorDescription

String. The description of the error. Returned if Status is Failed.

OutputFileType

String. The type of the output file.

ObjectId

String. The object ID of the report.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.