Contracts

Export Attachments Job Contract

ATTRIBUTE	DESCRIPTION
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.

ATTRIBUTE	DESCRIPTION
requestId string	The unique identifier for the attachment. The request id uniquely identifies the caller's request for the batch export job.
annotationSettings.visibility array(string)	Defines the visibility that will be applied to the export files. Possible values are the following: - Public - Visible to all users. - Internal - Visible to all Encompass users. - Private - Visible to only the creator of the annotation.
ExportEntity.exportMeta[] array	Contains metadata information for the export job. Currently supports a 10-job maximum request limit.
exportEntity.exportMeta[] .requestId string	Uniquely identifies the caller's request for each export request in the batch. This enables the caller to map each request with its corresponding response.
exportEntity.exportMeta[].fileName string	Name of the file to be kept after the export job is completed.
exportEntity.exportMeta[].entities[].entityId string	The unique identifier for the related external file entity. This can be used to reference external entities based on the associated entityType.