DOCX Compare and Merge REST APIs
Overview
The DOCX Compare and DOCX Merge REST APIs enable the Contract Negotiation functionality.
- DOCX Compare - Compares two Contract DOCX documents and returns a list of differences.
- DOCX Merge – Merges approved changes into a Contract DOCX.
Administration
DOCX Compare
| Description |
This operation compares two Contract DOCX documents
created by Document Designer and returns a list of modified clauses. |
| URI Endpoint |
/rest/v17/docxCompare
|
| Parameter(s) |
processVarname
|
Variable Name of Commerce Process |
|
transactionId
|
ID of Transaction |
|
oldDocAttachId
|
ID of File Attachment for Old Document |
|
newDocAttachId
|
ID of File Attachment for New Document |
| HTTP Method |
POST |
Response Body Parameters(s)
Diffs
(Array of
JSON objects) |
clauseId
|
ID of changed clause |
|
type
|
Enum value of change type, eg: "MODIFIED" |
|
clause label
|
Label of changed clause |
|
parentlabel
|
Label of parent clause |
|
reviewed
|
Changes have been approved in Word |
|
action
|
English label of "type", eg: "Updated" |
Sample Response Body
{
"diffs": [
{
"clauseId": "123456",
"type": "MODIFIED",
"clauselabel": "Clause A Name",
"parentlabel": "Parent Clause Name",
"reviewed": "Y",
"action": "Updated"
},
{
"clauseId": "123789",
"type": "MODIFIED",
"clauselabel": "Clause B Name",
"parentlabel": "Parent Clause Name",
"reviewed": "Y",
"action": "Updated"
}
]
}
DOCX Merge
| Description |
This operation merges changes into a Contract DOCX document using a list of approved changes and another Contract document as a source. It returns the updated document as a base64 string. |
| URI Endpoint |
/rest/v17/docxMerge
|
|
Parameter(s)
|
processVarname
|
Variable Name of Commerce Process |
|
transactionId
|
ID of Transaction |
|
sourceFileAttachId
|
ID of File Attachment for Source Document |
|
targetFileAttachId
|
ID of File Attachment for Merge Target Document |
|
approvedChanges
|
Array of changes to be applied |
| HTTP Method |
POST |
| Response Body Parameters |
errors
|
Array of error messages |
|
base64Doc
|
String base64 document |
Notes
For more information on the Interface Catalogs, see the topic Interface Catalog.
Related Topics
See Also
