Skip to content

Latest commit

 

History

History
107 lines (83 loc) · 4.09 KB

DocumentProperties.md

File metadata and controls

107 lines (83 loc) · 4.09 KB

DocumentProperties

Properties

Name Type Description Notes
documentId String [optional]
brandId String [optional]
messageTitle String [optional]
documentDescription String [optional]
status StatusEnum [optional]
files List<DocumentFiles> [optional]
senderDetail DocumentSenderDetail [optional]
signerDetails List<DocumentSignerDetails> [optional]
formGroups List<FormGroup> [optional]
commonFields List<DocumentFormFields> [optional]
behalfOf BehalfOf [optional]
ccDetails List<DocumentCcDetails> [optional]
reminderSettings ReminderSettings [optional]
reassign List<DocumentReassign> [optional]
documentHistory List<AuditTrail> [optional]
activityBy String [optional]
activityDate Long [optional]
activityAction ActivityActionEnum [optional]
createdDate Long [optional]
expiryDays Integer [optional]
expiryDate Long [optional]
enableSigningOrder Boolean [optional]
isDeleted Boolean [optional]
revokeMessage String [optional]
declineMessage String [optional]
applicationId String [optional]
labels List<String> [optional]
disableEmails Boolean [optional]
enablePrintAndSign Boolean [optional]
enableReassign Boolean [optional]
disableExpiryAlert Boolean [optional]
hideDocumentId Boolean [optional]
expiryDateType ExpiryDateTypeEnum [optional]
expiryValue Long [optional]
documentDownloadOption DocumentDownloadOptionEnum [optional]
metaData Map<String, String> [optional]
enableAuditTrailLocalization Boolean [optional]
downloadFileName String [optional]
recipientNotificationSettings RecipientNotificationSettings [optional]

Enum: StatusEnum

Name Value
IN_PROGRESS "InProgress"
COMPLETED "Completed"
DECLINED "Declined"
EXPIRED "Expired"
REVOKED "Revoked"
DRAFT "Draft"

Enum: ActivityActionEnum

Name Value
VIEWED "Viewed"
SIGNED "Signed"
REASSIGNED "Reassigned"
DECLINED "Declined"
REVOKED "Revoked"
EXPIRED "Expired"
DOWNLOADED "Downloaded"
DOWNLOADED_FOR_PRINT_SIGN "DownloadedForPrintSign"
INITIATE_PRINT_AND_SIGN "InitiatePrintAndSign"
INITIATE_FORM_SIGN "InitiateFormSign"
CANCEL_PRINT_AND_SIGN "CancelPrintAndSign"
COMPLETE_PRINT_AND_SIGN "CompletePrintAndSign"
REVIEWED "Reviewed"
NONE "None"
EDITING_INITIATED "EditingInitiated"
EDITING_CANCELLED "EditingCancelled"
EDITING_COMPLETED "EditingCompleted"

Enum: ExpiryDateTypeEnum

Name Value
DAYS "Days"
HOURS "Hours"
SPECIFIC_DATE_TIME "SpecificDateTime"

Enum: DocumentDownloadOptionEnum

Name Value
COMBINED "Combined"
INDIVIDUALLY "Individually"