eFolder File Attachment Resources

The following tables contain the eFolder document parameters that are available for use in a file attachment request body and returned in a response body.

	Indicates the parameter is required in a request body or always returned in a response body.
	Indicates the parameter is optional in the request body and may be returned in a response body.

Document parameters are divided into 5 categories:

· Basic

· Document

· Pages

· Thumbnail

· Annotations

Basic File Attachment Parameters

Parameter	Data Type	Description	GET	POST	PATCH
attachmentId	string	The unique identifier assigned to the attachment.
dateCreated	DateTime	Date the attachment was created. Example: 2017-01-07T01:57:23.107Z
createdBy	string	UserID of the user who created the attachment.
createdByName	string	User Name of the user who created the attachment.
createReason	int	1 = Browse 2 = Forms 3 = Scan 4 = Upload 5 = Fax 6 = Esign 7 = Services 10 = Printer 11 = Import Example: 1
attachmentType	int	The type of the attachment. 0 – Native 1 – Image
fileSize	long	The file size of the attachment. Example: 0
isActive	bool	True if the attachment is the active referenced attachment on the document to which it is assigned. Example: TRUE
pages		PageImageContract : List of page images for an Image attachment. Example: string
rotation	int	The rotation for Native attachments. Example: 0
title	string	The title of the attachment.

Document

Parameters associated with the document to which the files are attached.

Parameter	Data Type	Description	GET	POST	PATCH
entityId	string	Unique identifier of the entity. 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

Pages

Parameters associated with the page image.

Parameter	Data Type	Description	GET	POST	PATCH
imageKey	string	The identifier of the image file.
zipKey	string	The identifier of the zip file that contains the image.
nativeKey	string	The Native key.
width	int	The width of the image. Example: 0
height	int	The height of the image. Example: 0
horizontalResolution	float	The horizontal resolution of the image. Example: 0
verticalResolution	float	The vertical resolution of the image. Example: 0
rotation	int	The rotation of the image. Example: 0
fileSize	long	The size of the image file. Example: 0
thumbnail		PageThumbnailContract : Details of the page image thumbnail. Example: resource

Thumbnail

Parameters associated with page thumbnail.

Parameter	Data Type	Description	GET	POST	PATCH
imageKey	string	The identifier of the thumbnail file.
zipKey	string	The identifier of the zip file that contains the thumbnail.
width	int	The width of the thumbnail. Example: 0
height	int	The height of the thumbnail. Example: 0
horizontalResolution	float	The horizontal resolution of the thumbnail. Example: 0
verticalResolution	float	The vertical resolution of the thumbnail. Example: 0

Annotations

Parameters associated with page annotation contracts.

Parameter	Data Type	Description	GET	POST	PATCH
dateCreated	DateTime	Date the annotation was created. Example: 2017-01-07T01:57:23.107Z
createdBy	string	User that created the annotation.
text	string	The text of the annotation.
left	int	The horizontal location of the annotation. Example: 0
top	int	The vertical location of the annotation. Example: 0
width	int	The width of the annotation. Example: 0
height	int	The height of the annotation. Example: 0
visibilityType	int	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