Merge Types and Discovery
The /types
resource provides information about the merge types available through the REST service.
Request
GET /api/v1/xmlmerge/types
Response
<MergeTypes>
<Types>
<ThreeWayMerge>
<Links>
<Links>
<rel>self</rel>
<href>/api/xmlmerge/v1/types/threeway</href>
</Links>
</Links>
</ThreeWayMerge>
<ConcurrentMerge>
<Links>
<Links>
<rel>self</rel>
<href>/api/xmlmerge/v1/types/concurrent</href>
</Links>
</Links>
</ConcurrentMerge>
<SequentialMerge>
<Links>
<Links>
<rel>self</rel>
<href>/api/xmlmerge/v1/types/sequential</href>
</Links>
</Links>
</SequentialMerge>
</Types>
</MergeTypes>
An equivalent JSON result could be obtained by using the relevant HTTP Accept
header:
Request
GET /api/v1/xmlmerge/types
Accept application/json
Response
{
"Types": {
"ThreeWayMerge": {
"Links": [
{
"rel": "self",
"href": "/api/xmlmerge/v1/types/threeway"
}
]
},
"ConcurrentMerge": {
"Links": [
{
"rel": "self",
"href": "/api/xmlmerge/v1/types/concurrent"
}
]
},
"SequentialMerge": {
"Links": [
{
"rel": "self",
"href": "/api/xmlmerge/v1/types/sequential"
}
]
}
}
}
Further discovery of the merge type parameters and their default values is possible by using the specific types
resource - i.e. /types/{typeName}
Request
GET /api/v1/xmlmerge/types/sequential
XML
Response
<SequentialMerge>
<ResultType>DELTAV2</ResultType>
<Configuration>
<WordByWord>true</WordByWord>
<CalsTableProcessing>true</CalsTableProcessing>
<HtmlTableProcessing>true</HtmlTableProcessing>
<Indent>false</Indent>
<DoctypePreservationMode>PRESERVE_WHEN_UNCHANGED</DoctypePreservationMode>
<EntityReferencePreservationMode>PRESERVE_REFERENCES</EntityReferencePreservationMode>
<CalsValidationLevel>RELAXED</CalsValidationLevel>
<InvalidCalsTableBehaviour>PROPAGATE_UP</InvalidCalsTableBehaviour>
<WarningReportMode>PROCESSING_INSTRUCTIONS</WarningReportMode>
</Configuration>
<Links>
<Links>
<rel>self</rel>
<href>/api/xmlmerge/v1/types/sequential</href>
</Links>
</Links>
</SequentialMerge>
JSON
Response
{
"ResultType": "DELTAV2",
"Configuration": {
"WordByWord": true,
"CalsTableProcessing": true,
"HtmlTableProcessing": true,
"Indent": false,
"DoctypePreservationMode": "PRESERVE_WHEN_UNCHANGED",
"EntityReferencePreservationMode": "PRESERVE_REFERENCES",
"CalsValidationLevel": "RELAXED",
"InvalidCalsTableBehaviour": "PROPAGATE_UP",
"WarningReportMode": "PROCESSING_INSTRUCTIONS"
},
"Links": [
{
"rel": "self",
"href": "/api/xmlmerge/v1/types/sequential"
}
]
}