REST API Services for CPQ Cloud

DOCX Compare

post

/rest/v7/docxCompare

This operation compares two Contract DOCX documents created by Document Designer and returns a list of modified clauses.

Request

Supported Media Types

application/json

Root Schema : docxCompare-createform

Type: object

Show Source

newDocAttachId(optional): integer

Title: New Document Attachment ID

The New Document File Attachment Resource Identifier
oldDocAttachId(optional): integer

Title: Old Document Attachment ID

The Old Document File Attachment Resource Identifier
processVarname(optional): string

Title: Process Variable Name

Commerce Process Resource Identifier
transactionId(optional): 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"
        },
        "oldDocAttachId":{
            "type":"integer",
            "description":"The Old Document File Attachment Resource Identifier",
            "title":"Old Document Attachment ID"
        },
        "newDocAttachId":{
            "type":"integer",
            "description":"The New Document File Attachment Resource Identifier",
            "title":"New Document Attachment ID"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : docxCompare

Type: object

Show Source

diffs(optional): array Differences

Title: Differences

The docxCompare response consisting of a list of differences between the two documents

{
    "type":"object",
    "properties":{
        "diffs":{
            "type":"array",
            "description":"The docxCompare response consisting of a list of differences between the two documents",
            "title":"Differences",
            "items":{
                "$ref":"#/definitions/diff"
            }
        }
    }
}

Nested Schema : Differences

Type: array

Title: Differences

The docxCompare response consisting of a list of differences between the two documents

Show Source

Array of: object diff

{
    "type":"array",
    "description":"The docxCompare response consisting of a list of differences between the two documents",
    "title":"Differences",
    "items":{
        "$ref":"#/definitions/diff"
    }
}

Nested Schema : diff

Type: object

Show Source

action(optional): string

Title: Diff Action

Diffs: English label of 'type', eg: Updated
clauseId(optional): string

Title: Clause Identifier

Diffs: Unique Identifier for Clause
clauseLabel(optional): string

Title: Diff Clause Label

Diffs: Label of changed Clause
parentLabel(optional): string

Title: Diff Parent Label

Diffs: Label of parent Clause
reviewed(optional): string

Title: Diff Reviewed

Diffs: Changes have been approved in Word
type(optional): 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"
        }
    }
}