Contracts

Export Attachments Job Contract

ATTRIBUTEDESCRIPTION
jobId
string
Unique identifier of the export job.
status
string
Status of the export job. Possible values are:
Queued
Running
Retrying
Success
Failed


Error
object
Object containing details of the job export error in case the status of the job is Failed.
code
string
Any error codes returned by the export job.
details
string
Details of the error due to which the job failed.
summary
string
Summary of the error.


FileResponse
object
Object containing information about the file generated by the export job.
authorizationHeader
string
The Authorization request header to be passed to download the export job file.
contentType
string
Content type of the export file. Currently, the only format supported is PDF. The value returned would be application/pdf.
entityId
string
References the entity ID of the file.
entityType
string
Indicates the file type. Supported value is SkyDrive to indicate that the file is available on Cloud storage.
entityUri
string
The URL of the file where it can be retrieved.
fileSize
integer
The size of the attachment in bytes.
pageCount
integer
Number of pages the file contains.