Workshare Compare Service (APAC)

API change history

Convert a JSON description of a set of comparison rendering parameters into a 'Rendering Set' text which can be used with the Compare APIs.

Rendering set parameters that represent colours should be specified as well known colour names ("Red", "AliceBlue", etc), or colour # values ("#FF44CC" etc.). Rendering set parameters ending with 'TextDecoration' may be given one of the following values as a string value:
Underline (0x1),
Bold (0x2) Italic (0x4),
Strikethrough (0x8),
Superscript (0x10),
Subscript (0x20),
DoubleUnderline (0x100),
DoubleStrikethrough (0x200), Outline (0x400), or a combination of these as a numeric value.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

A JSON object specifying the rendering parameters to change from their default values. Only specify fields that you want to change from the default values.

{
  "FaultTolerantComparison": false,
  "IgnoreNumberedListStyle": false,
  "SingleColumnConversionFromPdf": false,
  "NoHeadersFootersConversionFromPdf": false,
  "IgnoreImagesWhenReadingSourceDocs": false,
  "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": false,
  "ShowStatistics": false,
  "ShowSummary": false,
  "InfoTablesAtStart": false,
  "ShowDeletionSummaryTable": false,
  "ShowRedlineOptionsSummaryTable": false,
  "ShowFilenamesInStatsTable": true,
  "CompareImages": false,
  "DetectFontChanges": false,
  "ShowChangeNumbers": false,
  "ChangeNumberBeforeChange": false,
  "DetectMoves": true,
  "CompressDeletionsToSingleCharacter": false,
  "InsertChangeMarkersInCells": false,
  "IgnoreChangesInTablesEntirely": false,
  "CompareTablesAtTheCellLevel": true,
  "ShowModifiedTableOnly": false,
  "ShowModifiedTableOnlyWithNoHighlighting": false,
  "DetectListNumberChanges": false,
  "UseWorkshareComparisonFooter": false,
  "CompareHeaderAndFooters": true,
  "CompareAtCharacterLevel": false,
  "CompareTextBoxContent": true,
  "DetectChangesToFieldCodes": true,
  "MakeFootersBlackAndWhite": false,
  "MakeHeadersBlackAndWhite": false,
  "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": false,
  "DetectNoteNumberingChanges": true,
  "DetectChangesToComments": false,
  "DeletionReplacementCharacter": "",
  "DetectWhitespaceChanges": true,
  "DetectParagraphChanges": false,
  "ShowDeletionsAdjacentToMovesAtTheMoveDestination": false,
  "CompareCaseInsensitive": false,
  "CompareNumbersAtCharacterLevel": false,
  "CompareFootnotes": true,
  "DetectParagraphStyleChanges": false,
  "DetectCharacterStyleChanges": false,
  "ParagraphTextMatchThresholdPercent": 0,
  "CellInsertColor": "#CCCCFF",
  "CellDeleteColor": "#FFCCCC",
  "CellMoveColor": "#CCC0CC",
  "CellMergeColor": "#FFFFCC",
  "CellPaddingColor": "Silver",
  "Insertion_TextDecoration": "DoubleUnderline",
  "InsertionSurroundingStartChar": "",
  "InsertionSurroundingEndChar": "",
  "InsertionTextColor": "Blue",
  "InsertionBackColor": "",
  "Deletion_TextDecoration": "Strikethrough",
  "Deletion_SurroundingStartChar": "",
  "Deletion_SurroundingEndChar": "",
  "Deletion_TextColor": "Red",
  "Deletion_BackColor": "",
  "MoveSource_TextDecoration": "Strikethrough",
  "MoveSource_SurroundingStartChar": "",
  "MoveSource_SurroundingEndChar": "",
  "MoveSource_TextColor": "#00C000",
  "MoveSource_BackColor": "",
  "MoveDestination_TextDecoration": "DoubleUnderline",
  "MoveDestination_SurroundingStartChar": "",
  "MoveDestination_SurroundingEndChar": "",
  "MoveDestination_TextColor": "#00C000",
  "MoveDestination_BackColor": "",
  "FormatChange_SurroundingStartChar": "",
  "FormatChange_SurroundingEndChar": "",
  "FormatChange_TextColor": "",
  "FormatChange_BackColor": "",
  "ChangeNumber_TextDecoration": "Superscript",
  "ChangeNumber_TextColor": "Black",
  "StyleLabel_TextColor": "Black",
  "StyleChange_TextDecoration": "Outline",
  "StyleChange_TextColor": "Black",
  "StyleChange_BackColor": "White",
  "StyleChangedSurroundingStartChar": "",
  "StyleChangedSurroundingEndChar": "",
  "RenderingSetName": "Unknown",
  "WriteDVBookmarks": true,
  "DisableFieldFlattening": false,
  "FlattenIfFields": false,
  "ChangeBarsOnRight": false,
  "ChangeBarsOnLeft": false,
  "RemovePagesWithoutChanges": false
}
{
  "type": "object",
  "properties": {
    "FaultTolerantComparison": {
      "type": "boolean"
    },
    "IgnoreNumberedListStyle": {
      "type": "boolean"
    },
    "SingleColumnConversionFromPdf": {
      "type": "boolean"
    },
    "NoHeadersFootersConversionFromPdf": {
      "type": "boolean"
    },
    "IgnoreImagesWhenReadingSourceDocs": {
      "type": "boolean"
    },
    "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": {
      "type": "boolean"
    },
    "ShowStatistics": {
      "type": "boolean"
    },
    "ShowSummary": {
      "type": "boolean"
    },
    "InfoTablesAtStart": {
      "type": "boolean"
    },
    "ShowDeletionSummaryTable": {
      "type": "boolean"
    },
    "ShowRedlineOptionsSummaryTable": {
      "type": "boolean"
    },
    "ShowFilenamesInStatsTable": {
      "type": "boolean"
    },
    "CompareImages": {
      "type": "boolean"
    },
    "DetectFontChanges": {
      "type": "boolean"
    },
    "ShowChangeNumbers": {
      "type": "boolean"
    },
    "ChangeNumberBeforeChange": {
      "type": "boolean"
    },
    "DetectMoves": {
      "type": "boolean"
    },
    "CompressDeletionsToSingleCharacter": {
      "type": "boolean"
    },
    "InsertChangeMarkersInCells": {
      "type": "boolean"
    },
    "IgnoreChangesInTablesEntirely": {
      "type": "boolean"
    },
    "CompareTablesAtTheCellLevel": {
      "type": "boolean"
    },
    "ShowModifiedTableOnly": {
      "type": "boolean"
    },
    "ShowModifiedTableOnlyWithNoHighlighting": {
      "type": "boolean"
    },
    "DetectListNumberChanges": {
      "type": "boolean"
    },
    "UseWorkshareComparisonFooter": {
      "type": "boolean"
    },
    "CompareHeaderAndFooters": {
      "type": "boolean"
    },
    "CompareAtCharacterLevel": {
      "type": "boolean"
    },
    "CompareTextBoxContent": {
      "type": "boolean"
    },
    "DetectChangesToFieldCodes": {
      "type": "boolean"
    },
    "MakeFootersBlackAndWhite": {
      "type": "boolean"
    },
    "MakeHeadersBlackAndWhite": {
      "type": "boolean"
    },
    "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": {
      "type": "boolean"
    },
    "DetectNoteNumberingChanges": {
      "type": "boolean"
    },
    "DetectChangesToComments": {
      "type": "boolean"
    },
    "DeletionReplacementCharacter": {
      "type": "string"
    },
    "DetectWhitespaceChanges": {
      "type": "boolean"
    },
    "DetectParagraphChanges": {
      "type": "boolean"
    },
    "ShowDeletionsAdjacentToMovesAtTheMoveDestination": {
      "type": "boolean"
    },
    "CompareCaseInsensitive": {
      "type": "boolean"
    },
    "CompareNumbersAtCharacterLevel": {
      "type": "boolean"
    },
    "CompareFootnotes": {
      "type": "boolean"
    },
    "DetectParagraphStyleChanges": {
      "type": "boolean"
    },
    "DetectCharacterStyleChanges": {
      "type": "boolean"
    },
    "ParagraphTextMatchThresholdPercent": {
      "format": "int32",
      "type": "integer"
    },
    "CellInsertColor": {
      "type": "string"
    },
    "CellDeleteColor": {
      "type": "string"
    },
    "CellMoveColor": {
      "type": "string"
    },
    "CellMergeColor": {
      "type": "string"
    },
    "CellPaddingColor": {
      "type": "string"
    },
    "Insertion_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "InsertionSurroundingStartChar": {
      "type": "string"
    },
    "InsertionSurroundingEndChar": {
      "type": "string"
    },
    "InsertionTextColor": {
      "type": "string"
    },
    "InsertionBackColor": {
      "type": "string"
    },
    "Deletion_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "Deletion_SurroundingStartChar": {
      "type": "string"
    },
    "Deletion_SurroundingEndChar": {
      "type": "string"
    },
    "Deletion_TextColor": {
      "type": "string"
    },
    "Deletion_BackColor": {
      "type": "string"
    },
    "MoveSource_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "MoveSource_SurroundingStartChar": {
      "type": "string"
    },
    "MoveSource_SurroundingEndChar": {
      "type": "string"
    },
    "MoveSource_TextColor": {
      "type": "string"
    },
    "MoveSource_BackColor": {
      "type": "string"
    },
    "MoveDestination_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "MoveDestination_SurroundingStartChar": {
      "type": "string"
    },
    "MoveDestination_SurroundingEndChar": {
      "type": "string"
    },
    "MoveDestination_TextColor": {
      "type": "string"
    },
    "MoveDestination_BackColor": {
      "type": "string"
    },
    "FormatChange_SurroundingStartChar": {
      "type": "string"
    },
    "FormatChange_SurroundingEndChar": {
      "type": "string"
    },
    "FormatChange_TextColor": {
      "type": "string"
    },
    "FormatChange_BackColor": {
      "type": "string"
    },
    "ChangeNumber_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "ChangeNumber_TextColor": {
      "type": "string"
    },
    "StyleLabel_TextColor": {
      "type": "string"
    },
    "StyleChange_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "StyleChange_TextColor": {
      "type": "string"
    },
    "StyleChange_BackColor": {
      "type": "string"
    },
    "StyleChangedSurroundingStartChar": {
      "type": "string"
    },
    "StyleChangedSurroundingEndChar": {
      "type": "string"
    },
    "RenderingSetName": {
      "type": "string"
    },
    "OriginalDocId": {
      "type": "string"
    },
    "ModifiedDocId": {
      "type": "string"
    },
    "WriteDVBookmarks": {
      "type": "boolean"
    },
    "DisableFieldFlattening": {
      "type": "boolean"
    },
    "FlattenIfFields": {
      "type": "boolean"
    },
    "ChangeBarsOnRight": {
      "type": "boolean"
    },
    "ChangeBarsOnLeft": {
      "type": "boolean"
    },
    "RemovePagesWithoutChanges": {
      "type": "boolean"
    }
  },
  "xml": {
    "name": "CompareOptions"
  },
  "example": {
    "FaultTolerantComparison": false,
    "IgnoreNumberedListStyle": false,
    "SingleColumnConversionFromPdf": false,
    "NoHeadersFootersConversionFromPdf": false,
    "IgnoreImagesWhenReadingSourceDocs": false,
    "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": false,
    "ShowStatistics": false,
    "ShowSummary": false,
    "InfoTablesAtStart": false,
    "ShowDeletionSummaryTable": false,
    "ShowRedlineOptionsSummaryTable": false,
    "ShowFilenamesInStatsTable": true,
    "CompareImages": false,
    "DetectFontChanges": false,
    "ShowChangeNumbers": false,
    "ChangeNumberBeforeChange": false,
    "DetectMoves": true,
    "CompressDeletionsToSingleCharacter": false,
    "InsertChangeMarkersInCells": false,
    "IgnoreChangesInTablesEntirely": false,
    "CompareTablesAtTheCellLevel": true,
    "ShowModifiedTableOnly": false,
    "ShowModifiedTableOnlyWithNoHighlighting": false,
    "DetectListNumberChanges": false,
    "UseWorkshareComparisonFooter": false,
    "CompareHeaderAndFooters": true,
    "CompareAtCharacterLevel": false,
    "CompareTextBoxContent": true,
    "DetectChangesToFieldCodes": true,
    "MakeFootersBlackAndWhite": false,
    "MakeHeadersBlackAndWhite": false,
    "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": false,
    "DetectNoteNumberingChanges": true,
    "DetectChangesToComments": false,
    "DeletionReplacementCharacter": "",
    "DetectWhitespaceChanges": true,
    "DetectParagraphChanges": false,
    "ShowDeletionsAdjacentToMovesAtTheMoveDestination": false,
    "CompareCaseInsensitive": false,
    "CompareNumbersAtCharacterLevel": false,
    "CompareFootnotes": true,
    "DetectParagraphStyleChanges": false,
    "DetectCharacterStyleChanges": false,
    "ParagraphTextMatchThresholdPercent": 0,
    "CellInsertColor": "#CCCCFF",
    "CellDeleteColor": "#FFCCCC",
    "CellMoveColor": "#CCC0CC",
    "CellMergeColor": "#FFFFCC",
    "CellPaddingColor": "Silver",
    "Insertion_TextDecoration": "DoubleUnderline",
    "InsertionSurroundingStartChar": "",
    "InsertionSurroundingEndChar": "",
    "InsertionTextColor": "Blue",
    "InsertionBackColor": "",
    "Deletion_TextDecoration": "Strikethrough",
    "Deletion_SurroundingStartChar": "",
    "Deletion_SurroundingEndChar": "",
    "Deletion_TextColor": "Red",
    "Deletion_BackColor": "",
    "MoveSource_TextDecoration": "Strikethrough",
    "MoveSource_SurroundingStartChar": "",
    "MoveSource_SurroundingEndChar": "",
    "MoveSource_TextColor": "#00C000",
    "MoveSource_BackColor": "",
    "MoveDestination_TextDecoration": "DoubleUnderline",
    "MoveDestination_SurroundingStartChar": "",
    "MoveDestination_SurroundingEndChar": "",
    "MoveDestination_TextColor": "#00C000",
    "MoveDestination_BackColor": "",
    "FormatChange_SurroundingStartChar": "",
    "FormatChange_SurroundingEndChar": "",
    "FormatChange_TextColor": "",
    "FormatChange_BackColor": "",
    "ChangeNumber_TextDecoration": "Superscript",
    "ChangeNumber_TextColor": "Black",
    "StyleLabel_TextColor": "Black",
    "StyleChange_TextDecoration": "Outline",
    "StyleChange_TextColor": "Black",
    "StyleChange_BackColor": "White",
    "StyleChangedSurroundingStartChar": "",
    "StyleChangedSurroundingEndChar": "",
    "RenderingSetName": "Unknown",
    "WriteDVBookmarks": true,
    "DisableFieldFlattening": false,
    "FlattenIfFields": false,
    "ChangeBarsOnRight": false,
    "ChangeBarsOnLeft": false,
    "RemovePagesWithoutChanges": false
  }
}
{
  "FaultTolerantComparison": false,
  "IgnoreNumberedListStyle": false,
  "SingleColumnConversionFromPdf": false,
  "NoHeadersFootersConversionFromPdf": false,
  "IgnoreImagesWhenReadingSourceDocs": false,
  "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": false,
  "ShowStatistics": false,
  "ShowSummary": false,
  "InfoTablesAtStart": false,
  "ShowDeletionSummaryTable": false,
  "ShowRedlineOptionsSummaryTable": false,
  "ShowFilenamesInStatsTable": true,
  "CompareImages": false,
  "DetectFontChanges": false,
  "ShowChangeNumbers": false,
  "ChangeNumberBeforeChange": false,
  "DetectMoves": true,
  "CompressDeletionsToSingleCharacter": false,
  "InsertChangeMarkersInCells": false,
  "IgnoreChangesInTablesEntirely": false,
  "CompareTablesAtTheCellLevel": true,
  "ShowModifiedTableOnly": false,
  "ShowModifiedTableOnlyWithNoHighlighting": false,
  "DetectListNumberChanges": false,
  "UseWorkshareComparisonFooter": false,
  "CompareHeaderAndFooters": true,
  "CompareAtCharacterLevel": false,
  "CompareTextBoxContent": true,
  "DetectChangesToFieldCodes": true,
  "MakeFootersBlackAndWhite": false,
  "MakeHeadersBlackAndWhite": false,
  "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": false,
  "DetectNoteNumberingChanges": true,
  "DetectChangesToComments": false,
  "DeletionReplacementCharacter": "",
  "DetectWhitespaceChanges": true,
  "DetectParagraphChanges": false,
  "ShowDeletionsAdjacentToMovesAtTheMoveDestination": false,
  "CompareCaseInsensitive": false,
  "CompareNumbersAtCharacterLevel": false,
  "CompareFootnotes": true,
  "DetectParagraphStyleChanges": false,
  "DetectCharacterStyleChanges": false,
  "ParagraphTextMatchThresholdPercent": 0,
  "CellInsertColor": "#CCCCFF",
  "CellDeleteColor": "#FFCCCC",
  "CellMoveColor": "#CCC0CC",
  "CellMergeColor": "#FFFFCC",
  "CellPaddingColor": "Silver",
  "Insertion_TextDecoration": "DoubleUnderline",
  "InsertionSurroundingStartChar": "",
  "InsertionSurroundingEndChar": "",
  "InsertionTextColor": "Blue",
  "InsertionBackColor": "",
  "Deletion_TextDecoration": "Strikethrough",
  "Deletion_SurroundingStartChar": "",
  "Deletion_SurroundingEndChar": "",
  "Deletion_TextColor": "Red",
  "Deletion_BackColor": "",
  "MoveSource_TextDecoration": "Strikethrough",
  "MoveSource_SurroundingStartChar": "",
  "MoveSource_SurroundingEndChar": "",
  "MoveSource_TextColor": "#00C000",
  "MoveSource_BackColor": "",
  "MoveDestination_TextDecoration": "DoubleUnderline",
  "MoveDestination_SurroundingStartChar": "",
  "MoveDestination_SurroundingEndChar": "",
  "MoveDestination_TextColor": "#00C000",
  "MoveDestination_BackColor": "",
  "FormatChange_SurroundingStartChar": "",
  "FormatChange_SurroundingEndChar": "",
  "FormatChange_TextColor": "",
  "FormatChange_BackColor": "",
  "ChangeNumber_TextDecoration": "Superscript",
  "ChangeNumber_TextColor": "Black",
  "StyleLabel_TextColor": "Black",
  "StyleChange_TextDecoration": "Outline",
  "StyleChange_TextColor": "Black",
  "StyleChange_BackColor": "White",
  "StyleChangedSurroundingStartChar": "",
  "StyleChangedSurroundingEndChar": "",
  "RenderingSetName": "Unknown",
  "WriteDVBookmarks": true,
  "DisableFieldFlattening": false,
  "FlattenIfFields": false,
  "ChangeBarsOnRight": false,
  "ChangeBarsOnLeft": false,
  "RemovePagesWithoutChanges": false
}
{
  "type": "object",
  "properties": {
    "FaultTolerantComparison": {
      "type": "boolean"
    },
    "IgnoreNumberedListStyle": {
      "type": "boolean"
    },
    "SingleColumnConversionFromPdf": {
      "type": "boolean"
    },
    "NoHeadersFootersConversionFromPdf": {
      "type": "boolean"
    },
    "IgnoreImagesWhenReadingSourceDocs": {
      "type": "boolean"
    },
    "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": {
      "type": "boolean"
    },
    "ShowStatistics": {
      "type": "boolean"
    },
    "ShowSummary": {
      "type": "boolean"
    },
    "InfoTablesAtStart": {
      "type": "boolean"
    },
    "ShowDeletionSummaryTable": {
      "type": "boolean"
    },
    "ShowRedlineOptionsSummaryTable": {
      "type": "boolean"
    },
    "ShowFilenamesInStatsTable": {
      "type": "boolean"
    },
    "CompareImages": {
      "type": "boolean"
    },
    "DetectFontChanges": {
      "type": "boolean"
    },
    "ShowChangeNumbers": {
      "type": "boolean"
    },
    "ChangeNumberBeforeChange": {
      "type": "boolean"
    },
    "DetectMoves": {
      "type": "boolean"
    },
    "CompressDeletionsToSingleCharacter": {
      "type": "boolean"
    },
    "InsertChangeMarkersInCells": {
      "type": "boolean"
    },
    "IgnoreChangesInTablesEntirely": {
      "type": "boolean"
    },
    "CompareTablesAtTheCellLevel": {
      "type": "boolean"
    },
    "ShowModifiedTableOnly": {
      "type": "boolean"
    },
    "ShowModifiedTableOnlyWithNoHighlighting": {
      "type": "boolean"
    },
    "DetectListNumberChanges": {
      "type": "boolean"
    },
    "UseWorkshareComparisonFooter": {
      "type": "boolean"
    },
    "CompareHeaderAndFooters": {
      "type": "boolean"
    },
    "CompareAtCharacterLevel": {
      "type": "boolean"
    },
    "CompareTextBoxContent": {
      "type": "boolean"
    },
    "DetectChangesToFieldCodes": {
      "type": "boolean"
    },
    "MakeFootersBlackAndWhite": {
      "type": "boolean"
    },
    "MakeHeadersBlackAndWhite": {
      "type": "boolean"
    },
    "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": {
      "type": "boolean"
    },
    "DetectNoteNumberingChanges": {
      "type": "boolean"
    },
    "DetectChangesToComments": {
      "type": "boolean"
    },
    "DeletionReplacementCharacter": {
      "type": "string"
    },
    "DetectWhitespaceChanges": {
      "type": "boolean"
    },
    "DetectParagraphChanges": {
      "type": "boolean"
    },
    "ShowDeletionsAdjacentToMovesAtTheMoveDestination": {
      "type": "boolean"
    },
    "CompareCaseInsensitive": {
      "type": "boolean"
    },
    "CompareNumbersAtCharacterLevel": {
      "type": "boolean"
    },
    "CompareFootnotes": {
      "type": "boolean"
    },
    "DetectParagraphStyleChanges": {
      "type": "boolean"
    },
    "DetectCharacterStyleChanges": {
      "type": "boolean"
    },
    "ParagraphTextMatchThresholdPercent": {
      "format": "int32",
      "type": "integer"
    },
    "CellInsertColor": {
      "type": "string"
    },
    "CellDeleteColor": {
      "type": "string"
    },
    "CellMoveColor": {
      "type": "string"
    },
    "CellMergeColor": {
      "type": "string"
    },
    "CellPaddingColor": {
      "type": "string"
    },
    "Insertion_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "InsertionSurroundingStartChar": {
      "type": "string"
    },
    "InsertionSurroundingEndChar": {
      "type": "string"
    },
    "InsertionTextColor": {
      "type": "string"
    },
    "InsertionBackColor": {
      "type": "string"
    },
    "Deletion_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "Deletion_SurroundingStartChar": {
      "type": "string"
    },
    "Deletion_SurroundingEndChar": {
      "type": "string"
    },
    "Deletion_TextColor": {
      "type": "string"
    },
    "Deletion_BackColor": {
      "type": "string"
    },
    "MoveSource_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "MoveSource_SurroundingStartChar": {
      "type": "string"
    },
    "MoveSource_SurroundingEndChar": {
      "type": "string"
    },
    "MoveSource_TextColor": {
      "type": "string"
    },
    "MoveSource_BackColor": {
      "type": "string"
    },
    "MoveDestination_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "MoveDestination_SurroundingStartChar": {
      "type": "string"
    },
    "MoveDestination_SurroundingEndChar": {
      "type": "string"
    },
    "MoveDestination_TextColor": {
      "type": "string"
    },
    "MoveDestination_BackColor": {
      "type": "string"
    },
    "FormatChange_SurroundingStartChar": {
      "type": "string"
    },
    "FormatChange_SurroundingEndChar": {
      "type": "string"
    },
    "FormatChange_TextColor": {
      "type": "string"
    },
    "FormatChange_BackColor": {
      "type": "string"
    },
    "ChangeNumber_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "ChangeNumber_TextColor": {
      "type": "string"
    },
    "StyleLabel_TextColor": {
      "type": "string"
    },
    "StyleChange_TextDecoration": {
      "format": "int32",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        256,
        512,
        1024
      ],
      "type": "integer"
    },
    "StyleChange_TextColor": {
      "type": "string"
    },
    "StyleChange_BackColor": {
      "type": "string"
    },
    "StyleChangedSurroundingStartChar": {
      "type": "string"
    },
    "StyleChangedSurroundingEndChar": {
      "type": "string"
    },
    "RenderingSetName": {
      "type": "string"
    },
    "OriginalDocId": {
      "type": "string"
    },
    "ModifiedDocId": {
      "type": "string"
    },
    "WriteDVBookmarks": {
      "type": "boolean"
    },
    "DisableFieldFlattening": {
      "type": "boolean"
    },
    "FlattenIfFields": {
      "type": "boolean"
    },
    "ChangeBarsOnRight": {
      "type": "boolean"
    },
    "ChangeBarsOnLeft": {
      "type": "boolean"
    },
    "RemovePagesWithoutChanges": {
      "type": "boolean"
    }
  },
  "xml": {
    "name": "CompareOptions"
  },
  "example": {
    "FaultTolerantComparison": false,
    "IgnoreNumberedListStyle": false,
    "SingleColumnConversionFromPdf": false,
    "NoHeadersFootersConversionFromPdf": false,
    "IgnoreImagesWhenReadingSourceDocs": false,
    "IgnoreEmbeddedObjectsAndImagesWhenReadingSourceDocs": false,
    "ShowStatistics": false,
    "ShowSummary": false,
    "InfoTablesAtStart": false,
    "ShowDeletionSummaryTable": false,
    "ShowRedlineOptionsSummaryTable": false,
    "ShowFilenamesInStatsTable": true,
    "CompareImages": false,
    "DetectFontChanges": false,
    "ShowChangeNumbers": false,
    "ChangeNumberBeforeChange": false,
    "DetectMoves": true,
    "CompressDeletionsToSingleCharacter": false,
    "InsertChangeMarkersInCells": false,
    "IgnoreChangesInTablesEntirely": false,
    "CompareTablesAtTheCellLevel": true,
    "ShowModifiedTableOnly": false,
    "ShowModifiedTableOnlyWithNoHighlighting": false,
    "DetectListNumberChanges": false,
    "UseWorkshareComparisonFooter": false,
    "CompareHeaderAndFooters": true,
    "CompareAtCharacterLevel": false,
    "CompareTextBoxContent": true,
    "DetectChangesToFieldCodes": true,
    "MakeFootersBlackAndWhite": false,
    "MakeHeadersBlackAndWhite": false,
    "TurnSelectedFieldsToTextToAllowChangesInFieldResultToBeShown": false,
    "DetectNoteNumberingChanges": true,
    "DetectChangesToComments": false,
    "DeletionReplacementCharacter": "",
    "DetectWhitespaceChanges": true,
    "DetectParagraphChanges": false,
    "ShowDeletionsAdjacentToMovesAtTheMoveDestination": false,
    "CompareCaseInsensitive": false,
    "CompareNumbersAtCharacterLevel": false,
    "CompareFootnotes": true,
    "DetectParagraphStyleChanges": false,
    "DetectCharacterStyleChanges": false,
    "ParagraphTextMatchThresholdPercent": 0,
    "CellInsertColor": "#CCCCFF",
    "CellDeleteColor": "#FFCCCC",
    "CellMoveColor": "#CCC0CC",
    "CellMergeColor": "#FFFFCC",
    "CellPaddingColor": "Silver",
    "Insertion_TextDecoration": "DoubleUnderline",
    "InsertionSurroundingStartChar": "",
    "InsertionSurroundingEndChar": "",
    "InsertionTextColor": "Blue",
    "InsertionBackColor": "",
    "Deletion_TextDecoration": "Strikethrough",
    "Deletion_SurroundingStartChar": "",
    "Deletion_SurroundingEndChar": "",
    "Deletion_TextColor": "Red",
    "Deletion_BackColor": "",
    "MoveSource_TextDecoration": "Strikethrough",
    "MoveSource_SurroundingStartChar": "",
    "MoveSource_SurroundingEndChar": "",
    "MoveSource_TextColor": "#00C000",
    "MoveSource_BackColor": "",
    "MoveDestination_TextDecoration": "DoubleUnderline",
    "MoveDestination_SurroundingStartChar": "",
    "MoveDestination_SurroundingEndChar": "",
    "MoveDestination_TextColor": "#00C000",
    "MoveDestination_BackColor": "",
    "FormatChange_SurroundingStartChar": "",
    "FormatChange_SurroundingEndChar": "",
    "FormatChange_TextColor": "",
    "FormatChange_BackColor": "",
    "ChangeNumber_TextDecoration": "Superscript",
    "ChangeNumber_TextColor": "Black",
    "StyleLabel_TextColor": "Black",
    "StyleChange_TextDecoration": "Outline",
    "StyleChange_TextColor": "Black",
    "StyleChange_BackColor": "White",
    "StyleChangedSurroundingStartChar": "",
    "StyleChangedSurroundingEndChar": "",
    "RenderingSetName": "Unknown",
    "WriteDVBookmarks": true,
    "DisableFieldFlattening": false,
    "FlattenIfFields": false,
    "ChangeBarsOnRight": false,
    "ChangeBarsOnLeft": false,
    "RemovePagesWithoutChanges": false
  }
}

Responses

200 OK

OK

Representations

string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.workshare.net/apac/compare-service/api/RenderingSet/Create"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.workshare.net/apac/compare-service/api/RenderingSet/Create?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.workshare.net/apac/compare-service/api/RenderingSet/Create");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.workshare.net/apac/compare-service/api/RenderingSet/Create?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.workshare.net/apac/compare-service/api/RenderingSet/Create";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.workshare.net/apac/compare-service/api/RenderingSet/Create');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.workshare.net')
    conn.request("POST", "/apac/compare-service/api/RenderingSet/Create?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.workshare.net')
    conn.request("POST", "/apac/compare-service/api/RenderingSet/Create?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.workshare.net/apac/compare-service/api/RenderingSet/Create')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body