Examples of using the REST API are available on Postman documentation.
The ResultType specifies the type of post-processing applied to the merge result. The types available are:
|ResultType Value||Description||Merge Type|
|DELTAV2||the raw result with no post-processing.||✓||✓||✓|
|ANALYZED_DELTAV2||performs first-line analysis of the result and adds attributes to indicate types of change||✓||✓||✓|
|RULE_PROCESSED_DELTAV2||applies default rules to auto-resolve the simple change types 'add' and 'delete'.||✓||✓|
|SIMPLIFIED_DELTAV2||a simplified form of the deltaV2 format||✓||✓||✓|
|SIMPLIFIED_RULE_PROCESSED_DELTAV2||the simplified format with the simple change types 'add' and 'delete' auto-resolved.||✓||✓|
|TWO_WAY_RESULT||a three-way merge converted to a two-way result||✓|
|RULE_PROCESSED_TWO_WAY_RESULT||a three-way merge converted to a two-way result, with rule processing applied||✓|
|THREE_WAY_OXYGEN_TRACK_CHANGES||standard three-way merge except changes are displayed in Oxygen's track changes format||✓|
Specific Javadoc ResultType pages:
Controls how DOCTYPE declarations appear in the result. The available modes are:
|REMOVE_ALWAYS||no doctypes appear in the result, irrespective of what's in the inputs.|
|PRESERVE_WHEN_UNCHANGED||if no changes then preserved, otherwise removed.|
|ERROR_WHEN_CHANGED||if changes signal error, otherwise preserved in result.|
For Javadoc see here.
Controls how general entity references appear in the result. The available modes are:
|USE_REPLACEMENT_TEXT||Entity references are replaced with their 'replacement text' (which may actually include general XML such as text, attributes and elements).|
|PRESERVE_REFERENCES||Entity references remain in the body of the XML content. Declarations in the internal subset will also be preserved where possible. If multiple declarations with different values are used in the inputs then multiple declarations may appear in the result.|
|PRESERVE_REFERENCES_ENCODED_FORM||Entity references remain in the body of the XML content in encoded output format. Declarations in the internal subset will also be preserved where possible. If multiple declarations with different values are used in the inputs then multiple declarations may appear in the result.|
For Javadoc, see here.
Controls the granularity of text/PCDATA comparison, alignment and change reporting:
| ||Text is segmented into words (as described in Unicode Annex 29, Section 4), compared and results are then reported as this granularity.|
| ||Text is compared and changes reported corresponding to the text/PCDATA structure found in the comparison inputs.|
Sets whether elements containing significantly modified text should be split.
| ||Enable element splitting when WordByWord is true and the amount of unchanged text in an element falls below 10%.|
| ||Disable element splitting.|
Controls the generation of intermediate pipeline debug files. This parameter is not available for REST API-based command-line interface.
| ||Intermediate pipeline debug files are generated.|
| ||Intermediate pipeline debug files are not generated.|
Controls whether to enable processing for that type of tables.
| ||Enables the table processing.|
| ||Disables the table processing.|
This parameter declares what type of processing should be used for invalid tables.
| Propagate the changes to the |
|Compare tables as 'plain' XML.|
|Throw an Exception when invalid CALS tables are encountered.|
Controls the validation level to use for table validation.
|Performs relaxed validation. Invalidities which are known to have no effect on subsequent processing will not cause that processing to be bypassed.|
|Performs strict validation. All invalidities will cause the appropriate subsequent processing to be bypassed.|
Specifies how table invalidity warnings should be reported.
| Reports warning using processing instructions with the format |
|Reports warnings using XML comments.|
|Reports warnings using <xsl:message/>.|
HTML Tables Only
Controls whether to normalize the specification of columns in HTML tables.
| ||Enables the table normalization.|
| ||Disables the table normalization.|
Javadoc for the HTML parameter.
Additional Three Way Merge Parameters
Presets the corresponding RuleConfiguration and ResultType settings. The types available are:
|ALL_CHANGES||shows as many changes as possible.|
|CONFLICTING_CHANGES||shows conflicts for further resolution. Simple, non-conflicting adds, deletes and modifications are automatically resolved.|
|THEIR_CHANGES||shows conflicts for further resolution. Additionally changes in the third input are displayed. Simple, non-conflicting changes in the second input are automatically resolved. This is designed for merge scenarios where the third input corresponds to the 'remote' or other users (their) branch.|
The Javadoc is here.
Specifies the result format when using three-to-two merge. The formats available are:
|XML_DELTA||produces a deltaV2 result.|
produces a result format which is an XML file with processing instructions used in the accept/reject interface of the oXygen XML editor/author
|DITA_MARKUP||produces a DITA document, using |
The Javadoc is here.