DOCX Merge
post
/rest/v7/docxMerge
This operation merges two Contract DOCX documents created by Document Designer and returns list of errors as well as the Base64 encoded document resulting from the merge.
Request
Supported Media Types
- application/json
Root Schema : docxMerge-createform
Type:
Show Source
object-
approvedChanges(optional):
array Approved Changes
Title:
Approved ChangesA list of approved changes. -
processVarname(optional):
string
Title:
Process Variable NameCommerce Process Resource Identifier -
sourceFileAttachId(optional):
integer
Title:
Source File Attachment IDSource Document File Attachment Resource Identifier -
targetFileAttachId(optional):
integer
Title:
Target File Attachment IDTarget Document File Attachment Resource Identifier -
transactionId(optional):
integer
Title:
Transaction IDTransaction Resource Identifier
Nested Schema : Approved Changes
Type:
arrayTitle:
Approved ChangesA list of approved changes.
Show Source
Nested Schema : diff
Type:
Show Source
object-
action(optional):
string
Title:
Diff ActionDiffs: English label of 'type', eg: Updated -
clauseId(optional):
string
Title:
Clause IdentifierDiffs: Unique Identifier for Clause -
clauseLabel(optional):
string
Title:
Diff Clause LabelDiffs: Label of changed Clause -
parentLabel(optional):
string
Title:
Diff Parent LabelDiffs: Label of parent Clause -
reviewed(optional):
string
Title:
Diff ReviewedDiffs: Changes have been approved in Word -
type(optional):
string
Title:
Diff Action TypeDiffs: Enum value of a Diff Action: MODIFIED, MOVE, REMOVE, INSERT
Response
Supported Media Types
- application/json
Default Response
Root Schema : docxMerge
Type:
Show Source
object-
base64Doc(optional):
string
Title:
Base64 DocumentRESPONSE: Byte array of Document base64 encoded string. -
errors(optional):
array Errors Array
Title:
Errors ArrayRESPONSE: An array of Error strings
Nested Schema : Errors Array
Type:
arrayTitle:
Errors ArrayRESPONSE: An array of Error strings
Show Source