Actuate Information Delivery API operations

Table 11‑1 The
Operation	Description
Administrate	Performs file and user administrative operations
CallOpenSecurityLibrary	Executes an RSSE operation
CancelJob	Cancels a job
CancelReport	Cancels a report execute operation
CloseInfoObject	Closes an information object
CreateDatabaseConnection	Creates a database connection
CreateFileType	Creates a file type
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
DeleteDatabaseConnection	Removes a database connection
DeleteFileType	Removes a file type
DeleteResourceGroup	Removes a resource group
DownloadFile	Downloads a file
DownloadTransientFile	Downloads a temporary report
ExecuteReport	Generates a temporary report
ExecuteVolumeCommand	Executes predefined Encyclopedia volume control commands
ExtractParameterDefinitionsFromFile	Extracts parameter definitions from a report file
ExportParameterDefinitionsToFile	Exports parameter definitions from a report file
FetchInfoObjectData	Extracts data from an information object
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
GetConnectionProperties	Returns connection properties for a file
GetConnectionPropertyAssignees	Returns the connection properties for a file as assigned to specific users and groups
GetContent	Returns the content of a report element
GetCounterValues	Returns the IDs, names, and values of a counter.
GetCubeMetaData	Returns cube result set schema details
GetCustomFormat	Returns custom data format for a report
GetDatabaseConnectionDefinition	Returns ACS database connection details
GetDatabaseConnectionParameters	Returns ACS database connection parameters
GetDatabaseConnectionTypes	Returns ACS database connection categories
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
GetDynamicData	Returns dynamic data from a report.
GetEmbeddedComponent	Returns the embedded components from a report
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
GetFormats	Returns a list of locales and formats
GetInfoObject	Returns an BIRT information object
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
GetSavedSearch	Returns a saved search
GetServerResourceGroupConfiguration	Returns a resource group configuration
GetSPMetadata	Returns the SP metadata
GetStaticData	Returns static objects from a report
GetStyleSheet	Returns the style sheet for a file
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
GetSystemVolumeNames	Returns a list of Encyclopedia volume names
GetTOC	Returns a table of contents
GetUserExtendedProperties	Returns the extended properties for a user
GetUserGroupExtendedProperties	Returns the extended properties for a user group
GrantUserGroupCapabilities	Returns a list of capabilities assigned to a user group
GetUserLicenseOptions	Returns a list of licensed options for a user
GetUserPreference	Returns user preferences
GetUserPrinterOptions	Returns user printing options
GetVolumeProperties	Returns Encyclopedia volume properties
GrantUserGroupCapabilities	Adds user group capabilities
GrantUserGroupProductAccess	Adds user group product access
InstallApp	Installs an application
Login	Authenticates a user
ODBOTunnel	Opens a connection to an OLAP server
OpenInfoObject	Opens an information object file
Ping	Pings the server
PrintReport	Prints a document
RevokeUserGroupCapabilities	Removes user group capabilities
RevokeUserGroupProductAccess	Removes user group product access
SaveSearch	Saves a search
SaveTransientReport	Saves a report produced by an immediate job
SearchReport	Searches report content
SelectChannels	Sets the current list of channels
SelectFiles	Sets selected files
SelectFileTypes	Sets selected file types
SelectGroups	Sets selected user groups
SelectJavaReportPage	Sets selected report page
SelectJobNotices	Sets selected job notices
SelectJobs	Sets selected jobs
SelectJobSchedules	Sets selected job schedules
SelectPage	Sets selected page
SelectRoles	Sets selected roles
SelectUserGroups	Sets selected user groups
SelectUsers	Sets selected users
SetConnectionProperties	Sets connection properties
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 report job
SystemLogin	Authenticates the administrator user
UpdateDatabaseConnection	Refreshes the database connection list
UpdateResourceGroup	Refreshes the resource group list
UploadFile	Copies a file to the Encyclopedia volume
VerifyAuthId	Checks for the existence of an Auth ID
WaitForExecuteReport	Returns the status of a cancel request for an immediate report job