eoCreateDocumentProfileUploadDocument
Action Parameter
eoCreateDocumentProfileUploadDocument
Purpose
To create a document information template as a standard means of collecting and controlling information about a document and its subsequent versions.
This interface is then used to store unsigned PDF files as eStore documents that are ready to be signed. The interface can also be used to store a previously-signed document as an Electronic Original document. Documents that are presented for storage as Electronic Original documents will be validated to ensure the integrity of the document prior to storage in the eCore® service.
Description
The createDocumentProfile action establishes a document profile. A document profile represents a document and contains a list of document versions.
The upload document action stores a document in the eCore® service, and returns a document identifier and other document metadata. The interface requires an existing transaction in the eCore® service.
Type
Coarse
Preconditions
A transaction has been created, and the client application has the transactionSid as well as the dptName.
Parameters
Required
Parameter
Value
Description
transactionSid
Sequence ID (SID) of the transaction that will contain the document profile
dptName
Name of the document profile template (DPT) used to create the document profile
dpName
Document profile name of the document to be signed
customField
Add
Name of custom field configured for organization
dpXRef1
External reference ID used on the document profile
dpXRef2
External reference ID used on the document profile
dpXRef3
External reference ID used on the document profile
dpBusinessProcessName
Business Process name applied to document; if not provided, the default is the organization's default Business Process.
dpTaskTemplateName
Task Template name applied to document; if not provided, the default is the organization's default Task Template.
dpStateName
Document profile's state name after it is created. If this parameter is not passed, the default is the eCore® default state.
dpExtraData
Extra data to be added to the document profile
srcFile
The PDF file to be stored.
documentFileName
The filename of the srcFile. This parameter is used when the document is rendered from the eCore® service, and should include the .PDF document extension in the parameter.
mimeType
application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
text/plain
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/lotus123
text/comma-separated-values
text/csv
application/csv
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
image/bmp
image/jpeg
application/postscript
application/png
image/png
application/x-png
image/tiff
image/gif
image/x-xbitmap
application/x-smartdoc
The document mime/type
applyStoredFormFieldsTemplate
false
true
This merge form fields that are attached to a DPT when the document is stored.
Response
We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.