Jump to

• Request
• Response

DOCX Merge

post

/rest/v16/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

Body ()

Root Schema : docxMerge-createform

Type: object

Show Source

• approvedChanges: array Approved Changes
  Title: Approved Changes

  A list of approved changes.
• processVarname: string
  Title: Process Variable Name

  Commerce Process Resource Identifier
• sourceFileAttachId: integer
  Title: Source File Attachment ID

  Source Document File Attachment Resource Identifier
• targetFileAttachId: integer
  Title: Target File Attachment ID

  Target Document File Attachment Resource Identifier
• transactionId: integer
  Title: Transaction ID

  Transaction Resource Identifier

{
    "type":"object",
    "properties":{
        "processVarname":{
            "type":"string",
            "description":"Commerce Process Resource Identifier",
            "title":"Process Variable Name"
        },
        "transactionId":{
            "type":"integer",
            "description":"Transaction Resource Identifier",
            "title":"Transaction ID"
        },
        "sourceFileAttachId":{
            "type":"integer",
            "description":"Source Document File Attachment Resource Identifier",
            "title":"Source File Attachment ID"
        },
        "targetFileAttachId":{
            "type":"integer",
            "description":"Target Document File Attachment Resource Identifier",
            "title":"Target File Attachment ID"
        },
        "approvedChanges":{
            "type":"array",
            "description":"A list of approved changes.",
            "title":"Approved Changes",
            "items":{
                "$ref":"#/definitions/diff"
            }
        }
    }
}

Nested Schema : Approved Changes

Type: array

Title: Approved Changes

A list of approved changes.

Show Source

• Array of: object diff

{
    "type":"array",
    "description":"A list of approved changes.",
    "title":"Approved Changes",
    "items":{
        "$ref":"#/definitions/diff"
    }
}

Nested Schema : diff

Type: object

Show Source

• action: string
  Title: Diff Action

  Diffs: English label of 'type', eg: Updated
• clauseId: string
  Title: Clause Identifier

  Diffs: Unique Identifier for Clause
• clauseLabel: string
  Title: Diff Clause Label

  Diffs: Label of changed Clause
• parentLabel: string
  Title: Diff Parent Label

  Diffs: Label of parent Clause
• reviewed: string
  Title: Diff Reviewed

  Diffs: Changes have been approved in Word
• type: string
  Title: Diff Action Type

  Diffs: Enum value of a Diff Action: MODIFIED, MOVE, REMOVE, INSERT

{
    "type":"object",
    "properties":{
        "clauseId":{
            "type":"string",
            "description":" Diffs: Unique Identifier for Clause",
            "title":"Clause Identifier"
        },
        "type":{
            "type":"string",
            "description":" Diffs: Enum value of a Diff Action: MODIFIED, MOVE, REMOVE, INSERT",
            "title":"Diff Action Type"
        },
        "clauseLabel":{
            "type":"string",
            "description":" Diffs: Label of changed Clause",
            "title":"Diff Clause Label"
        },
        "parentLabel":{
            "type":"string",
            "description":" Diffs: Label of parent Clause",
            "title":"Diff Parent Label"
        },
        "reviewed":{
            "type":"string",
            "description":" Diffs: Changes have been approved in Word",
            "title":"Diff Reviewed"
        },
        "action":{
            "type":"string",
            "description":" Diffs: English label of 'type', eg: Updated",
            "title":"Diff Action"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : docxMerge

Type: object

Show Source

• base64Doc: string
  Title: Base64 Document

  RESPONSE: Byte array of Document base64 encoded string.
• errors: array Errors Array
  Title: Errors Array

  RESPONSE: An array of Error strings

{
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "description":"RESPONSE: An array of Error strings",
            "title":"Errors Array",
            "items":{
                "type":"string"
            }
        },
        "base64Doc":{
            "type":"string",
            "description":"RESPONSE: Byte array of Document base64 encoded string.",
            "title":"Base64 Document"
        }
    }
}

Nested Schema : Errors Array

Type: array

Title: Errors Array

RESPONSE: An array of Error strings

Show Source

• Array of: string

{
    "type":"array",
    "description":"RESPONSE: An array of Error strings",
    "title":"Errors Array",
    "items":{
        "type":"string"
    }
}

Back to Top