V1 Contracts

V1 eFolder Attachment Contracts and Attributes

Attachment Attributes


dateCreated date	Date the attachment or page annotation was created. Example: 2017-01-07T01:57:23.107Z
createdBy string	UserID of the user who created the attachment or annotation.
createdByName string	User Name of the user who created the attachment.
createReason int32	1 = Browse, 2 = Forms, 3 = Scan, 4 = Upload 5 = Fax, 6 = Esign, 7 = Services, 10 = Printer 11 = Import Example: 1
attachmentType int32	Possible values are: Native = 0, Image = 1, and Background = 2. Note that Native (for example .pdf or .doc files) is the only attachmentType that can currently be created through the API.
fileSize int64	The size of the image file. Example: 0
isActive boolean	True indicates it is the active attachment on the document. (Current Version is checked on the Document Details window in Encompass.) False indicates it is not the active attachment on the document. (Current Version is unchecked on the Document Details window in Encompass.)
pages string	pageImage schema, which lists page images for an image attachment. For example, string.
rotation int32	The rotation of the image. Example: 0
title string	The title of the attachment.
entityId string	Unique identifier of the entity (document). Example: 12345
entityType string	The entity type for documents, is “document”. The entity type for attachments, is “attachment”.
entityName string	Name of the entity.
entityUri string	Location of the entity. Example: /v1/documents/123/attachment/12345
imageKey string	The identifier of the image or thumbnail file.
zipKey string	The identifier of the zip file that contains the image or thumbnail.
nativeKey string	The Native key.
width int32	The width of the annotation. Example: 0
height int32	The height of the annotation. Example: 0
horizontalResolution float	The horizontal resolution of the image or thumbnail. Example: 0
verticalResolution float	The vertical resolution of the image or thumbnail. Example: 0
thumbnail string	pageThumbnail schema, which includes details of the page image thumbnail. For example, resource.
text string	The text of the annotation.
left int32	The horizontal location of the annotation. Example: 0
top int32	The vertical location of the annotation. Example: 0
visibilityType int32	The visibility type of the annotation. 0 – Public (Default. Viewable by the user who added it.) 1 – Internal (Viewable by any person with Encompass permissions to view annotations.) 2 – Personal (Viewable by everyone and is sent as part of documents.) Example: 0

eFolder Media URL Attributes


title string	The name of the media attachment.
fileWithExtension string	The attachment's file name and extension. The following file extensions are supported: .doc, .docx, .html, .jpeg, .jpg, .pdf, .tif, and .txt.
createReason int32	1 = Browse 2 = Forms 3 = Scan 4 = Upload 5 = Fax 6 = Esign 7 = Services 10 = Printer 11 = Import
documentRefId string	Reference to the document object.
mediaUrl string	The location or path where the media attachment is located.