e-Sign REST Web Service
PostGetDocuments
e-Sign REST Web Service > All Operations Resource Group : GetDocuments (Post)

Resource Path: /api/v5/documents

Description
Get an existing Document.
Request Headers
NameDescription
 
 
 
 
Request

The request body is of type DocumentDetailsRequestModel.

Overview

DocumentDetailsRequestModel
ProntoID : string
IDs : Array[integer]
TransactionIDs : Array[integer]
ParticipantIDs : Array[integer]
TaskIDs : Array[integer]
MetaDataName : string
MetaDataValue : string
StatusType : string
SearchDateType : string
SearchDateFrom : string
SearchDateTo : string
IncludeFile : boolean
IncludeNonWatermarkedVersion : boolean
IncludePdfStampedWithCopyWatermark : boolean
IncludeFileUnlocked : boolean
IncludeOriginalSourceFile : boolean
IncludeSpecificVersion : integer
IncludeMetaData : boolean
IncludeWorkflowActions : boolean
IncludeTasks : boolean
TaskIncludes : TaskIncludesModel
IncludeWorkflowActions : boolean
IncludeFileAttachments : boolean
IncludeTests : boolean
IncludeSignatureBlock : boolean
IncludeFileAttachmentsInfoOnly : boolean
IncludeTests : boolean
IncludeVersions : boolean
EnableLogging : boolean
ResultsCountLimit : integer
ResultsCountStart : integer
TimeZoneID : string
Response

The response body is of type DocumentDetailsServiceReturnModel.

OK

Overview

DocumentDetailsServiceReturnModel
IsSuccessful : boolean
Message : string
Documents : Array[object]
ProcessingTime : string
TimeZoneUtcOffset : number
See Also
All Operations Resource Groupe-Sign REST Web Service