GetJobDetails
Retrieves the properties of a specified job.
Request schema
<xsd:complexType name="GetJobDetails">
<xsd:sequence>
<xsd:element name="JobId" type="xsd:string"/>
<xsd:element name="ResultDef" type="typens:ArrayOfString"/>
<xsd:element name="GroupingEnabled" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SupportedQueryFeatures"
type="typens:SupportedQueryFeatures" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
JobId
The ID of the job from which to retrieve properties.
ResultDef
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
The names of groups to receive notifications about the job
NotifyChannels
The names of channels to receive notifications about the job
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
Provided for backward compatibility. If the DOX was created using Actuate 7 Service Pack 2 or a later release, set GroupingEnabled to True. In this case, BIRT iHub Information and Management Console enable the grouping and aggregation pages. If the DOX came from an earlier version of an Actuate product, set GroupingEnabled to False.
SupportedQueryFeatures
Specifies additional query features.
Response schema
<xsd:complexType name="GetJobDetailsResponse">
<xsd:sequence>
<xsd:element name="JobAttributes" type="typens:JobProperties"
minOccurs="0"/>
<xsd:element name="InputDetail" type="typens:JobInputDetail"
minOccurs="0"/>
<xsd:element name="Schedules" type="typens:JobSchedule"
minOccurs="0"/>
<xsd:element name="PrinterOptions"
type="typens:PrinterOptions" minOccurs="0"/>
<xsd:element name="NotifyUsers" type="typens:ArrayOfString"
minOccurs="0"/>
<xsd:element name="NotifyGroups" type="typens:ArrayOfString">
<xsd:element name="NotifyChannels"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="DefaultOutputFileACL"
type="typens:ArrayOfPermission" minOccurs="0"/>
<xsd:element name="Status" type="xsd:string" minOccurs="0"/>
<xsd:element name="ReportParameters"
type="typens:ArrayOfParameterValue" minOccurs="0"/>
<xsd:element name="Query" type="typens:Query"
minOccurs="0"/>
<xsd:element name="OutputFileAccessType"
type="typens:FileAccess" minOccurs="0"/>
<xsd:element name="WaitForEvent" type="typens:Event"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
JobAttributes
The general job attributes.
InputDetail
The job input parameters.
Schedules
The job schedule information.
PrinterOptions
The job printer settings.
NotifyUsers
The names of users to receive notifications about the job.
NotifyGroups
The names of groups to receive notifications about the job.
NotifyChannels
The names of channels to receive notifications about the job.
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.
Query
The data object values (.dov) file associated with the job.
OutputFileAccessType
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
An event that must complete before processing the response.