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’s 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 schema
<xsd:complexType name="PrintReport">
<xsd:sequence>
<xsd:element name="JobName" type="xsd:string"/>
<xsd:element name="Priority" type="xsd:int"/>
<xsd:choice>
<xsd:element name="InputFileName" type="xsd:string"/>
<xsd:element name="InputFileId" type="xsd:string"/>
</xsd:choice>
<xsd:element name="Schedules" type="typens:JobSchedule"
minOccurs="0"/>
<xsd:element name="PrinterOptions"
type="typens:JobPrinterOptions" minOccurs="0"/>
<xsd:element name="NotifyUsersByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="NotifyGroupsByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="NotifyChannelsByName"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="NotifyUsersById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="NotifyGroupsById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="NotifyChannelsById"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SendSuccessNotice"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="SendFailureNotice" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendEmailForSuccess"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="SendEmailForFailure"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="OverrideRecipientPref"
type="xsd:boolean"
<xsd:element name="RecordSuccessStatus"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="RecordFailureStatus"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="RetryOptions"
type="typens:RetryOptions" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
JobName
The job name.
Priority
The job priority. Limited by the user’s Max job priority setting.
InputFileName
The name of the file to print. Specify either InputFileName or InputFileId.
InputFileId
The ID of the file to print. Specify either InputFileId or InputFileName.
Schedules
The schedule for the print job. If not specified, the print request is sent immediately.
PrinterOptions
The job printer settings. The printer settings have the following precedence:
Job printer settings
User printer settings
System printer settings
NotifyUsersByName
The names of users to receive job completion notice. Specify either NotifyUsersByName or NotifyUsersById.
NotifyGroupsByName
The names of groups to receive the job completion notice. Specify either NotifyGroupsByName or NotifyGroupsById.
NotifyChannelsByName
The names of channels to receive the job completion notice. Specify either NotifyChannelsByName or NotifyChannelsById.
NotifyUsersById
The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.
NotifyGroupsById
The IDs of groups to receive the job completion notice. Specify either NotifyGroupsById or NotifyGroupsByName.
NotifyChannelsById
The IDs of channels to receive job completion notice. Specify either NotifyChannelsById or NotifyUsersByName.
SendSuccessNotice
Specifies whether notices are sent if report printing succeeds.
SendFailureNotice
Specifies whether notices are sent if report printing fails.
SendEmailForSuccess
Specifies whether an e‑mail is sent when report printing succeeds.
SendEmailForFailure
Specifies whether an e‑mail is sent when report printing fails.
OverrideRecipientPref
Specifies whether recipient preferences are overridden.
RecordSuccessStatus
Specifies whether the job status is kept if report printing succeeds.
RecordFailureStatus
Specifies whether the job status is kept if report printing fails.
RetryOptions
Specifies how to retry printing if the previous attempt failed. Used only if Retryable is specified.
Response schema
<xsd:complexType name="PrintReportResponse">
<xsd:sequence>
<xsd:element name="JobId" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
Response elements
JobId
The ID of the print job. Returned after the job is created.