Collection for demonstrating and testing DeltaXML's DITA Merge REST API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5865356","collectionId":"012a9d58-2325-43c9-9ebd-18ee2c172202","publishedId":"SVSDRsCC","public":true,"customColor":{"top-bar":"113C6B","right-sidebar":"545F6D","highlight":"A2C644"},"publishDate":"2019-07-08T13:51:24.000Z"},"item":[{"name":"Get DITA Merge Info","item":[{"name":"All Merge Types","id":"538347f5-d8a9-4835-8e4e-1568b9fce26c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/ditamerge/v1/types/","description":"Calling GET on the types endpoint gives you information about the various merge types available.
\nThis information is available in both XML and JSON using the Accept headers application/xml and application/json respectively.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types",""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"2853912b-f887-473d-b24b-5b4c57bfd004","name":"All Merge Types (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:8080/api/xmlmerge/v1/types/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"271"}],"cookie":[],"responseTime":null,"body":"{\n \"Types\": {\n \"ThreeWayMerge\": {\n \"Links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/ditamerge/v1/types/threeway\"\n }\n ]\n },\n \"ConcurrentMerge\": {\n \"Links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/ditamerge/v1/types/concurrent\"\n }\n ]\n },\n \"SequentialMerge\": {\n \"Links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/ditamerge/v1/types/sequential\"\n }\n ]\n }\n }\n}"},{"id":"b1032c5f-1a50-46c3-827c-987728b276b2","name":"All Merge Types (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xmlmerge/v1/types/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"412"}],"cookie":[],"responseTime":null,"body":"You can GET information about the default parameters on a merge type by using its id after \"/types/\". For example, this request shows the \"concurrent\" merge type.
\nThis information is available in both XML and JSON using the Accept headers application/xml and application/json respectively.
\nTo learn more about Concurrent Merge see our web page, Concurrent Merge Analysis
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","concurrent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"168e4b08-65b5-4b3e-a89c-3e1936520ab0","name":"Concurrent Merge Info (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xmlmerge/v1/types/concurrent"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"962"}],"cookie":[],"responseTime":null,"body":"You can GET information about the default parameters on a merge type by using its id after \"/types/\". For example, this request shows the \"sequential\" merge type.
\nThis information is available in both XML and JSON using the Accept headers application/xml and application/json respectively.
\nTo learn more about Sequential Merge see our web page, Sequential Merge Analysis
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","sequential"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a4e7e5f1-6de6-4e45-90f4-08aa2f42f0cf","name":"Sequential Merge Info (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:8080/api/ditamerge/v1/types/sequential"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"537"}],"cookie":[],"responseTime":null,"body":"{\n \"ResultType\": \"DELTAV2\",\n \"Configuration\": {\n \"WordByWord\": true,\n \"CalsTableProcessing\": true,\n \"HtmlTableProcessing\": true,\n \"Indent\": false,\n \"FormattingElementsConfiguration\": {\n \"AddFormattingElements\": [],\n \"RemoveFormattingElements\": [],\n \"SetFormattingElements\": [],\n \"enabled\": false,\n \"DefaultFormattingElements\": \"tt,sub,parmname,msgph,sup,uicontrol,filepath,userinput,term,lines,codeph,sep,wintitle,msgnum,b,pre,systemoutput,var,i,q,apiname,u,cmdname,cite,tm\"\n },\n \"DoctypePreservationMode\": \"PRESERVE_WHEN_UNCHANGED\",\n \"EntityReferencePreservationMode\": \"PRESERVE_REFERENCES\",\n \"CalsValidationLevel\": \"RELAXED\",\n \"InvalidCalsTableBehaviour\": \"PROPAGATE_UP\",\n \"WarningReportMode\": \"PROCESSING_INSTRUCTIONS\",\n \"FormattingOutputType\": \"DELTA_V_2_1\",\n \"FormatExtractionPriorityList\": []\n },\n \"Links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/ditamerge/v1/types/sequential\"\n }\n ]\n}"},{"id":"c0f4d67a-4454-48e0-83b5-da62beb810ee","name":"Sequential Merge Info (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/ditamerge/v1/types/sequential"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"795"}],"cookie":[],"responseTime":null,"body":"You can GET information about the default parameters on a merge type by using its id after \"/types/\". For example, this request shows the \"threeway\" merge type.
\nThis information is available in both XML and JSON using the Accept headers application/xml and application/json respectively.
\nThree-way merge is an extension to the concurrent merge with some additional result types. See our web page, DITA Merge Result Formats and Types
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1f881e60-c138-4097-82b0-a12c33aea140","name":"Three Way Merge Info (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/ditamerge/v1/types/threeway"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"1189"}],"cookie":[],"responseTime":null,"body":"The /types endpoint allows you to see the default parameters for the merge types.
\n","event":[{"listen":"prerequest","script":{"id":"b04240ae-608d-4155-8f9c-81d5bb57b394","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1feb7a54-fa01-4b04-a1c3-f6f4aa1f8785","type":"text/javascript","exec":[""]}}],"_postman_id":"e997c690-fbe0-446c-ad45-b6260887f4af"},{"name":"Synchronous DITA Merges","item":[{"name":"DITA - Concurrent Merge","item":[{"name":"XML Request Format","id":"9135da34-ba04-421c-a341-34c8afde3c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"Make a Concurrent Merge synchronous request using an XML formatted request.
\nThis request contains the default values for configuration parameters and a result type that is available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","concurrent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"289867ef-aa28-4fdc-8536-1ceb5e6dd6c9","name":"XML Request Format, default configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
Make a Concurrent Merge synchronous request using a JSON formatted request. Note: JSON is only used to configure the request, this is DITA Merge. For JSON comparison and merging see our JSON Compare product
\nThis request contains the default values for configuration parameters and a result type that is available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","concurrent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"83ae5089-f32c-48f7-b489-cc1942a4c4f7","name":"JSON Request Format, default configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Versions\": [\n {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml\"\n },\n {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml\"\n }\n ]\n}"},"url":"http://localhost:8080/api/ditamerge/v1/types/concurrent"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"5695"}],"cookie":[],"responseTime":null,"body":"\n\n\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it suddenly becomes a lot more complicated, because you need to do two comparisons and then view three different documents (changes from each reviewer and your original) to produce a new version. For three or more reviewers, you soon run out of screen space to see what is going on.
\nIt is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it becomes a lot more complicated, because you need to do two comparisons and then view three different documents (changes from each reviewer and your original) to produce a new version. For three or more reviewers, you soon run out of screen space to see what is going on.
\n\n
\n
accept or reject changes from multiple reviewers by working on just one document
\n\n
\n
merge changes from many different branches in a CMS
\nmerge changes from two different branches in a CMS
\n\n
\n
The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"ben","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"chris","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionOrder","value":"anna,ben,chris","description":"REQUIRED. Comma separated list of version names, in the order the versions will be added to the merge. The first item in the list will be treated as the ancestor.
\n","type":"text"},{"key":"WordByWord","value":"true","description":"Boolean controlling whether PCDATA (text) that has changed is shown has having changed as a block (false), or whether the changes are marked up at a finer level down to word, space or punctuation (true).
\n","type":"text"},{"key":"ResultType","value":"RULE_PROCESSED_DELTAV2","description":"An enum which specifies the type of post-processing applied to the merge result. See Javadoc and ResultTypes on our web page
\n","type":"text"},{"key":"Catalog","value":"/path/to/catalog.xml","description":"A Catalog file for resolving external entities used in the inputs (http://xerces.apache.org/xml-commons/components/resolver/resolver-article.html). Can be specified as a URI, file path, or raw XML file.
\n","type":"text","disabled":true},{"key":"DoctypePreservationMode","value":"PRESERVE_WHEN_UNCHANGED","description":"An enum which controls how DOCTYPE declarations appear in the result. See Javadoc
\n","type":"text"},{"key":"EntityReferencePreservationMode","value":"PRESERVE_REFERENCES","description":"An enum which controls how general entity references appear in the result. See Javadoc
\n","type":"text"},{"key":"ElementSplitting","value":"true","description":"Boolean controlling whether elements that contain a lot of changes are shown as a single element with the changes shown inside it, or whether it is split into a set of sibling elements one for each version. Splitting can create more readable results.
\n","type":"text"},{"key":"CalsTableProcessing","value":"true","description":"If the inputs contain CALS tables then setting this to true will cause XML Merge to detect them and invoke specific CALS Table processing. It should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"CalsValidationLevel","value":"RELAXED","description":"Enum specifying how CALS tables are validated in a STRICT or RELAXED way. Merge may still be able to analyze CALS Tables that fail strict validation. See Javadoc
\n","type":"text"},{"key":"HtmlTableProcessing","value":"true","description":"If the inputs contain DITA Simple Tables (HTML tables) then setting this to true should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"InvalidCalsTableBehaviour","value":"PROPAGATE_UP","description":"Enum specifying how to handle invalid CALS tables. See Javadoc
\n","type":"text"},{"key":"Indent","value":"false","description":"Boolean controlling whether to indent the result of the merge.
\n","type":"text"},{"key":"WarningReportMode","value":"PROCESSING_INSTRUCTIONS","description":"Enum specifying how to handle warnings when comparing CALS tables. See Javadoc
\n","type":"text"},{"key":"RuleConfiguration","value":"A String of XML or JSON which represents a RuleConfiguration object (same format as when using XML or JSON formatted requests). When DITA Merge has been set to use Rules to resolve conflicts between the inputs (see ResultType) this determines how the rules are applied. See Javadoc
\n","type":"text"},{"key":"EnableFormattingElements","value":"true","description":"Boolean controlling formatting element processing
\n","type":"text"},{"key":"FormattingElementsConfiguration","value":"A String of XML or JSON which represents a FormattingElementsConfiguration object.\nThere are different options:\nSetFormattingElements : Override default list of formatting elements\nAddFormattingElements : Add to the existing list of formatting elements\nRemoveFormattingElements : Remove from the existing list of formatting elements
\n","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/concurrent","description":"To specify a version, add a field where the key is the version name, e.g. \"anna\", with the value a URI/file path pointing to the input. Alternatively the input can be an XML file, or raw XML strings.
\nThis request contains the default values for configuration parameters and a result type that is available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","concurrent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"2a017692-cff0-46be-92b9-3c3d0d433331","name":"multipart/form-data, Simplified Delta, word by word off","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"anna","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"ben","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"chris","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionOrder","value":"anna,ben,chris","description":"REQUIRED. Comma separated list of version names, in the order the versions will be added to the merge. The first item in the list will be treated as the ancestor.","type":"text"},{"key":"WordByWord","value":"false","description":"Boolean controlling whether PCDATA (text) that has changed is shown has having changed as a block (false), or whether the changes are marked up at a finer level down to word, space or punctuation (true).","type":"text"},{"key":"ResultType","value":"SIMPLIFIED_DELTAV2","description":"An enum which specifies the type of post-processing applied to the merge result. See [Javadoc](https://docs.deltaxml.com/dita-merge/current/docs/api/com/deltaxml/ditamerge/ConcurrentMerge.MergeResultType.html) and [ResultTypes on our web page](https://docs.deltaxml.com/dita-merge/latest/samples-and-guides/dita-merge-result-formats-and-types)","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/concurrent"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"6837"}],"cookie":[],"responseTime":null,"body":"\n\n\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it suddenly becomes a lot more complicated, because you need to do two comparisons and then view three different documents (changes from each reviewer and your original) to produce a new version. For three or more reviewers, you soon run out of screen space to see what is going on.
\nIt is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it becomes a lot more complicated, because you need to do two comparisons and then view three different documents (changes from each reviewer and your original) to produce a new version. For three or more reviewers, you soon run out of screen space to see what is going on.
\n\n
\n
accept or reject changes from multiple reviewers by working on just one document
\n\n
\n
merge changes from many different branches in a CMS
\nmerge changes from two different branches in a CMS
\n\n
\n
\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
Make a Three Way DITA Merge synchronous request using an XML formatted request.
\nThis request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"9e8dd9b7-17ab-440d-b6ae-34ac16292ae6","name":"XML Request Format, default configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
DeltaXML DITA Merge automatically merges edits from two or more \n \n editors\n into a single document, so you can accept/reject changes from multiple authors all in one document. With\n DITA Merge you are no longer restricted to having only one person working on a document.\n
\n \nNow, with\n DITA Merge, this job becomes much, much easier, because\n DITA Merge merges all the changes into a single document.\n
\n\n DITA Merge has a number of different use cases:\n
\naccept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n \n two users check\n in the same \n \n edited\n document\n
\nmerge changes from \n \n two\n different branches in a CMS\n
\n\n DITA Merge works at the level of each paragraph, table or list.\n DITA Merge compares each \n \n edited\n version with the base and if only one is different, the changes are shown as tracked changes so that they can be accepted or rejected.\n
\nIf more than one editor has changed the same item, the change from each \n \n editor\n is shown separately for easier understanding. At the same time, all the changes are intelligently merged into one copy of the paragraph or item to make it easier to accept or reject each change.\n
\n \nMake a Three Way Merge synchronous request using a JSON formatted request. Note: JSON is only used to configure the request, this is DITA Merge. For JSON comparison and merging see our JSON Compare product
\nThis request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"26e3f6e0-01ad-400a-90c1-d64c293216cc","name":"JSON Request Format, default configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Ancestor\": {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"VersionOne\": {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml\"\n },\n \"VersionTwo\": {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml\"\n }\n}"},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"5695"}],"cookie":[],"responseTime":null,"body":"\n\n\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
DeltaXML DITA Merge automatically merges edits from two or more \n \n editors\n into a single document, so you can accept/reject changes from multiple authors all in one document. With\n DITA Merge you are no longer restricted to having only one person working on a document.\n
\n \nNow, with\n DITA Merge, this job becomes much, much easier, because\n DITA Merge merges all the changes into a single document.\n
\n\n DITA Merge has a number of different use cases:\n
\naccept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n \n two users check\n in the same \n \n edited\n document\n
\nmerge changes from \n \n two\n different branches in a CMS\n
\n\n DITA Merge works at the level of each paragraph, table or list.\n DITA Merge compares each \n \n edited\n version with the base and if only one is different, the changes are shown as tracked changes so that they can be accepted or rejected.\n
\nIf more than one editor has changed the same item, the change from each \n \n editor\n is shown separately for easier understanding. At the same time, all the changes are intelligently merged into one copy of the paragraph or item to make it easier to accept or reject each change.\n
\n \nThe field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.
\n","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"VersionOne\" will be used.
\n","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"VersionTwo\" will be used.
\n","type":"text"},{"key":"WordByWord","value":"true","description":"Boolean controlling whether PCDATA (text) that has changed is shown has having changed as a block (false), or whether the changes are marked up at a finer level down to word, space or punctuation (true).
\n","type":"text"},{"key":"ResultType","value":"RULE_PROCESSED_DELTAV2","description":"An enum which specifies the type of post-processing applied to the merge result. See Javadoc and our web page
\n","type":"text"},{"key":"Catalog","value":"/path/to/catalog.xml","description":"A Catalog file for resolving external entities used in the inputs (http://xerces.apache.org/xml-commons/components/resolver/resolver-article.html). Can be specified as a URI, file path, or raw XML file.
\n","type":"text","disabled":true},{"key":"DoctypePreservationMode","value":"PRESERVE_WHEN_UNCHANGED","description":"An enum which controls how DOCTYPE declarations appear in the result. See Javadoc
\n","type":"text"},{"key":"IdentityReferencePreservationMode","value":"PRESERVE_REFERENCES","description":"An enum which controls how general entity references appear in the result. See Javadoc
\n","type":"text"},{"key":"ElementSplitting","value":"true","description":"Boolean controlling whether elements that contain a lot of changes are shown as a single element with the changes shown inside it, or whether it is split into a set of sibling elements one for each version. Splitting can create more readable results.
\n","type":"text"},{"key":"CalsTableProcessing","value":"true","description":"If the inputs contain CALS tables then setting this to true will cause DITA Merge to detect them and invoke specific CALS Table processing. It should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"CalsValidationLevel","value":"RELAXED","description":"Enum specifying how CALS tables are validated in a STRICT or RELAXED way. DITA Merge may still be able to analyze CALS Tables that fail strict validation. See Javadoc
\n","type":"text"},{"key":"HtmlTableProcessing","value":"true","description":"If the inputs contain DITA Simple Tables (HTML tables) then setting this to true should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"InvalidCalsTableBehaviour","value":"PROPAGATE_UP","description":"Enum specifying how to handle invalid CALS tables. See Javadoc
\n","type":"text"},{"key":"Indent","value":"false","description":"Boolean controlling whether to indent the result of the merge.
\n","type":"text"},{"key":"WarningReportMode","value":"PROCESSING_INSTRUCTIONS","description":"Enum specifying how to handle warnings when comparing CALS tables. See Javadoc
\n","type":"text"},{"key":"RuleConfiguration","value":"A String of XML or JSON which represents a RuleConfiguration object (same format as when using XML or JSON formatted requests). When DITA Merge has been set to use Rules to resolve conflicts between the inputs (see ResultType) this determines how the rules are applied. See Javadoc
\n","type":"text"},{"key":"ExistingOxygenTCsProcessingMode","value":"ACCEPT","description":"Enum that controls how existing Oxygen Track Changes processing instructions will be handled. See Javadoc
\n","type":"text"},{"key":"ResultFormat","value":"XML_DELTA","description":"Enum specifying whether the output will be our standard XML Delta, Oxygen Track Changes instructions, or DITA rev and status attributes. See Javadoc
\n","type":"text"},{"key":"EnableFormattingElements","value":"true","description":"Boolean controlling formatting element processing
\n","type":"text"},{"key":"FormattingElementsConfiguration","value":"A String of XML or JSON which represents a FormattingElementsConfiguration object.\nThere are different options:\nSetFormattingElements : Override default list of formatting elements\nAddFormattingElements : Add to the existing list of formatting elements\nRemoveFormattingElements : Remove from the existing list of formatting elements
\n","type":"text"},{"key":"ThreeWayResultPreset","value":"ALL_CHANGES","description":"Enum that sets up pre-configured options for displaying changes when using Three-to-Two merge. See Javadoc.
\n","type":"text","disabled":true}]},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"This request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"35dfd77a-8653-49fe-baed-884eaf8efd94","name":"multipart/form-data, oXygen TC, Two Way Result","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"Ancestor","value":"/usr/local/deltaxml/DeltaXML-Merge-6_0_1_j/samples/html-data/four-edits-anna.html","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-Merge-6_0_1_j/samples/html-data/four-edits-ben.html","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"VersionOne\" will be used.","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-Merge-6_0_1_j/samples/html-data/four-edits-chris.html","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"VersionTwo\" will be used.","type":"text"},{"key":"ResultType","value":"TWO_WAY_RESULT","description":"An enum which specifies the type of post-processing applied to the merge result. See https://docs.deltaxml.com/merge/current/docs/api/com/deltaxml/merge/ThreeWayMerge.ThreeWayMergeResultType.html and https://docs.deltaxml.com/xml-merge/latest/samples-and-guides/merge-result-formats-and-types","type":"text"},{"key":"ResultFormat","value":"OXYGEN_TRACK_CHANGES","description":"Enum specifying whether the output will be our standard XML Delta or contain Oxygen Track Changes instructions. See https://docs.deltaxml.com/merge/current/docs/api/com/deltaxml/merge/ThreeWayMerge.ResultFormat.html","type":"text"}]},"url":"http://localhost:8080/api/xmlmerge/v1/types/threeway"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"3389"}],"cookie":[],"responseTime":null,"body":"\n\n \nDeltaXML Merge automatically merges edits from two or more \n \n editors\n into a single document, so you can accept/reject changes from multiple authors all in one document. With DeltaXML Merge you are no longer restricted to having only one person working on a document.\n
\n \nNow, with DeltaXML Merge, this job becomes much, much easier, because Merge merges all the changes into a single document.
\nDeltaXML Merge has a number of different use cases:
\naccept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n \n two users check\n in the same \n \n edited\n document\n
\nmerge changes from \n \n two\n different branches in a CMS\n
\nDeltaXML Merge works at the level of each paragraph, table or list. Merge compares each \n \n edited\n version with the base and if only one is different, the changes are shown as tracked changes so that they can be accepted or rejected.\n
\nIf more than one editor has changed the same item, the change from each \n \n editor\n is shown separately for easier understanding. At the same time, all the changes are intelligently merged into one copy of the paragraph or item to make it easier to accept or reject each change.\n
\n \n"},{"id":"868db44d-7421-4a59-b73d-71c44f5eeda0","name":"multipart/form-data - Three-to-Two result, marked up with Oxygen Track Changes instructions","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"Ancestor","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-2_2_4_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-2_2_4_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"VersionOne\" will be used.","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-2_2_4_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"VersionTwo\" will be used.","type":"text"},{"key":"ResultType","value":"TWO_WAY_RESULT","description":"An enum which specifies the type of post-processing applied to the merge result. See [Javadoc](https://docs.deltaxml.com/merge/current/docs/api/com/deltaxml/merge/ThreeWayMerge.ThreeWayMergeResultType.html) and [our web page](https://docs.deltaxml.com/dita-merge/latest/samples-and-guides/dita-merge-result-formats-and-types)","type":"text"},{"key":"ResultFormat","value":"OXYGEN_TRACK_CHANGES","description":"Enum specifying whether the output will be our standard XML Delta or contain Oxygen Track Changes instructions. See [Javadoc](https://docs.deltaxml.com/merge/current/docs/api/com/deltaxml/merge/ThreeWayMerge.ResultFormat.html)","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"3981"}],"cookie":[],"responseTime":null,"body":"\n\nDeltaXML DITA Merge automatically merges edits from two or more \n \n editors\n into a single document, so you can accept/reject changes from multiple authors all in one document. With\n DITA Merge you are no longer restricted to having only one person working on a document.\n
\n \nNow, with\n DITA Merge, this job becomes much, much easier, because\n DITA Merge merges all the changes into a single document.\n
\n\n DITA Merge has a number of different use cases:\n
\naccept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n \n two users check\n in the same \n \n edited\n document\n
\nmerge changes from \n \n two\n different branches in a CMS\n
\n\n DITA Merge works at the level of each paragraph, table or list.\n DITA Merge compares each \n \n edited\n version with the base and if only one is different, the changes are shown as tracked changes so that they can be accepted or rejected.\n
\nIf more than one editor has changed the same item, the change from each \n \n editor\n is shown separately for easier understanding. At the same time, all the changes are intelligently merged into one copy of the paragraph or item to make it easier to accept or reject each change.\n
\n \n\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
Make a Sequential Merge synchronous request using an XML formatted request.
\nThis request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","sequential"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"47bcd234-34a4-49a6-899a-35a5f60f09d7","name":"XML Request Format, default configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
\n
\n
\n
DITA Merge has a number of different use cases:
\nDeltaXML DITA Merge has a number of different use cases:
\naccept or reject changes from multiple reviewers by working on just one document
\n\n
\n
merge changes from many different branches in a CMS
\nmerge changes from two different branches in a CMS
\n\n
\n
Make a Sequential Merge synchronous request using a JSON formatted request. Note: JSON is only used to configure the request, this is DITA Merge. For JSON comparison and merging see our JSON Compare product
\nThis request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","sequential"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"4f9b4a6e-e60d-4ec9-a3cf-6f8339047755","name":"JSON Request Format - Simplified Delta result, Word By Word disabled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Versions\": [\n {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml\"\n },\n {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml\"\n }\n ],\n \"Configuration\": {\n \"WordByWord\": false\n },\n \"ResultType\": \"SIMPLIFIED_DELTAV2\"\n}"},"url":"http://localhost:8080/api/ditamerge/v1/types/sequential"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"\n\n\n
\n
\n
DITA Merge has a number of different use cases:
\nDeltaXML DITA Merge has a number of different use cases:
\naccept or reject changes from multiple reviewers by working on just one document
\n\n
\n
merge changes from many different branches in a CMS
\nmerge changes from two different branches in a CMS
\n\n
\n
\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"ben","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"chris","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionOrder","value":"anna,ben,chris","description":"REQUIRED. Comma separated list of version names, in the order the versions will be added to the merge. The first item in the list will be treated as the ancestor.
\n","type":"text"},{"key":"WordByWord","value":"true","description":"Boolean controlling whether PCDATA (text) that has changed is shown has having changed as a block (false), or whether the changes are marked up at a finer level down to word, space or punctuation (true).
\n","type":"text"},{"key":"ResultType","value":"DELTAV2","description":"An enum which specifies the type of post-processing applied to the merge result. See Javadoc and our web page
\n","type":"text"},{"key":"Catalog","value":"/path/to/catalog.xml","description":"A Catalog file for resolving external entities used in the inputs (http://xerces.apache.org/xml-commons/components/resolver/resolver-article.html). Can be specified as a URI, file path, or raw XML file.
\n","type":"text","disabled":true},{"key":"DoctypePreservationMode","value":"PRESERVE_WHEN_UNCHANGED","description":"An enum which controls how DOCTYPE declarations appear in the result. See Javadoc
\n","type":"text"},{"key":"EntityReferencePreservationMode","value":"PRESERVE_REFERENCES","description":"An enum which controls how general entity references appear in the result. See Javadoc
\n","type":"text"},{"key":"CalsTableProcessing","value":"true","description":"If the inputs contain CALS tables then setting this to true will cause DITA Merge to detect them and invoke specific CALS Table processing. It should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"CalsValidationLevel","value":"RELAXED","description":"Enum specifying how CALS tables are validated in a STRICT or RELAXED way. DITA Merge may still be able to analyze CALS Tables that fail strict validation. See our web page
\n","type":"text"},{"key":"HtmlTableProcessing","value":"true","description":"If the inputs contain DITA Simple Tables (HTML tables) then setting this to true should provide a better representation of the changes. See our web page
\n","type":"text"},{"key":"InvalidCalsTableBehaviour","value":"PROPAGATE_UP","description":"Enum specifying how to handle invalid CALS tables. See Javadoc
\n","type":"text"},{"key":"Indent","value":"false","description":"Boolean controlling whether to indent the result of the merge.
\n","type":"text"},{"key":"WarningReportMode","value":"PROCESSING_INSTRUCTIONS","description":"Enum specifying how to handle warnings when comparing CALS tables. See Javadoc
\n","type":"text"},{"key":"EnableFormattingElements","value":"true","description":"Boolean controlling formatting element processing
\n","type":"text"},{"key":"FormattingElementsConfiguration","value":"A String of XML or JSON which represents a FormattingElementsConfiguration object.\nThere are different options:\nSetFormattingElements : Override default list of formatting elements\nAddFormattingElements : Add to the existing list of formatting elements\nRemoveFormattingElements : Remove from the existing list of formatting elements
\n","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/sequential","description":"To specify a version, add a field where the key is the version name, e.g. \"a\", and then the value is a URI/file path pointing to the input. Alternatively the input can be an XML file, or raw XML strings.
\nThis request contains the default values for configuration parameters and result type available to you.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","sequential"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"20963984-30eb-4e8e-b5bd-dca1aab0fee3","name":"multipart/form-data, default configuration","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"anna","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"ben","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"chris","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionOrder","value":"anna,ben,chris","description":"REQUIRED. Comma separated list of version names, in the order the versions will be added to the merge. The first item in the list will be treated as the ancestor.","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/sequential"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"5929"}],"cookie":[],"responseTime":null,"body":"\n\n\n
It is relatively easy to work on a document which is reviewed by one other person because you just need to compare two documents (or record changes) to see the changes. If there are two reviewers, then it\n
Now, with\n
\n
accept or reject changes from multiple reviewers by working on just one document
\nallow more than one editor to work on a document simultaneously and merge their changes together
\nallow intelligent resolution of conflicts in a Content Management System (CMS) when \n
merge changes from \n
\n
If more than one editor has changed the same item, the change from each \n
\n
\n
\n
DITA Merge has a number of different use cases:
\nDeltaXML DITA Merge has a number of different use cases:
\naccept or reject changes from multiple reviewers by working on just one document
\n\n
\n
merge changes from many different branches in a CMS
\nmerge changes from two different branches in a CMS
\n\n
\n
Merges can be posted synchronously - i.e. the HTTP response will be the merge result.
\nNote: This is only recommended for small inputs with a small number of versions.
\nThere is documentation for the various merge types, along with the associated parameters. These are available in the three input formats (XML, JSON, and multipart/form-data).
\n","event":[{"listen":"prerequest","script":{"id":"6f7fcc78-1c69-46f3-b619-cbd031fa1a85","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a0a08649-8117-4d3a-91ba-c158ec2ea820","type":"text/javascript","exec":[""]}}],"_postman_id":"e61df495-1fc0-4d82-bbaf-9e9c28689a37"},{"name":"Asynchronous DITA Merges","item":[{"name":"Jobs","item":[{"name":"Job Info","id":"262f4a00-dc27-4687-8556-7760b585f6b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/ditamerge/v1/jobs/JOB_ID","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","jobs","JOB_ID"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"36a1b00c-1c13-48ca-902f-95511876d9f3","name":"JSON Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:8080/api/xmlmerge/v1/jobs/892f7abe-e759-4108-9b8c-f2a5f51f2f2d"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"291","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"}],"cookie":[],"responseTime":null,"body":"{\"jobId\":\"892f7abe-e759-4108-9b8c-f2a5f51f2f2d\",\"startTime\":1536852649593,\"finishedTime\":1536852650504,\"processingTime\":41168630,\"jobStatus\":\"SUCCESS\",\"output\":{\"type\":\"http\",\"size\":4884,\"uri\":\"http://localhost:8080/api/xmlmerge/v1/downloads/892f7abe-e759-4108-9b8c-f2a5f51f2f2d\"},\"link\":[]}"},{"id":"af56f567-5bc3-470a-9809-c51486dfa872","name":"XML Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xmlmerge/v1/jobs/892f7abe-e759-4108-9b8c-f2a5f51f2f2d"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"360","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"The mime type of this content"}],"cookie":[],"responseTime":null,"body":"Asynchronous DITA merges give you Job resources containing relevant information about the merge, including errors and the output location.
\n","event":[{"listen":"prerequest","script":{"id":"3492373b-a76a-4b25-905d-0a8ab3a3aaf4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71c4b308-2173-4f05-a93a-27cd82e20b36","type":"text/javascript","exec":[""]}}],"_postman_id":"6f41f4fa-ffa0-47e1-826e-8b9dbc8d0e6d"},{"name":"Async Features","item":[{"name":"Output","item":[{"name":"XML Request","id":"ea39d884-5181-4907-8ce3-3cf5ca84a1f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"This example request uses File IO. Specify a file path and the result will be written there - on the server the REST API is running on.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea39d884-5181-4907-8ce3-3cf5ca84a1f3"},{"name":"JSON Request","id":"b6cfc712-02e7-4291-b30d-6ce6d33b48ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Ancestor\": {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"VersionOne\": {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml\"\n },\n \"VersionTwo\": {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml\"\n },\n \"Async\": {\n \"Output\": {\n \"type\": \"file\",\n \"Path\": \"/path/to/output.xml\"\n }\n }\n}"},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"This example request uses File IO. Specify a file path and the result will be written there - on the server the REST API is running on.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6cfc712-02e7-4291-b30d-6ce6d33b48ef"},{"name":"multipart/form-data","id":"3c5a7a49-c380-4cce-bb1f-8229adef0540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"Ancestor","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.
\n","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"version-one\" will be used.
\n","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"version-two\" will be used.
\n","type":"text"},{"key":"Async","value":"true","description":"Boolean controlling whether to use asynchronous operation (true) or not.
\n","type":"text"},{"key":"AsyncOutput","value":"/path/to/output.xml","description":"A file path on the server where the merge result will be written to.
\n","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"This example request uses File IO. Specify a file path and the result will be written there - on the server the REST API is running on.
\nNote: at the moment you can only use File IO from multipart/form-data when specifying an Output.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c5a7a49-c380-4cce-bb1f-8229adef0540"}],"id":"3e6afb2b-8801-482c-b6d4-c2d1c31a843e","description":"A string representing a URI (or a simple file path) where the output of the merge should be stored.
\nIf this is specified the caller is responsible for maintaining and retrieving the output from that location.
\nIf it is not specified the service will provide the location of the output as a URL in the Job response once the Job has completed successfully.
\nIf the service provides the output location it will clean it up after a certain time, or the User can explicitly ask for it to be deleted by doing an HTTP DELETE on the job resource
\n","event":[{"listen":"prerequest","script":{"id":"b713cf07-6b76-4443-8468-061cf419b7e1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cccb0ddc-d912-425f-b18c-2888b8bd836a","type":"text/javascript","exec":[""]}}],"_postman_id":"3e6afb2b-8801-482c-b6d4-c2d1c31a843e"},{"name":"Callback","item":[{"name":"XML Request","id":"097eb0a1-d2e3-4c5d-a5ac-ae557132ce0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"To specify an asynchronous callback, simply specify the value in the <Callback> element, a child of the <Async> element.
\nNote: Replace the path/uri values with a suitable URI
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"097eb0a1-d2e3-4c5d-a5ac-ae557132ce0a"},{"name":"JSON Request","id":"f149f7f0-3389-4d37-b595-6253d91eec43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Ancestor\": {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"VersionOne\": {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"VersionTwo\": {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"Async\": {\n \"Callback\": \"http://mycall.back/dita-merge-rest/\"\n }\n}"},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"To specify an asynchronous callback, simply specify the value with the key Callback, inside the Async object.
\nNote: Replace the path/uri values with a suitable URI
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f149f7f0-3389-4d37-b595-6253d91eec43"},{"name":"multipart/form-data","id":"f078541f-cc67-4bf0-8033-772de34394b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"Ancestor","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.
\n","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"version-one\" will be used.
\n","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"version-two\" will be used.
\n","type":"text"},{"key":"Async","value":"true","description":"Boolean controlling whether to use asynchronous operation (true) or not.
\n","type":"text"},{"key":"AsyncCallback","value":"http://mycall.back/dita-merge-rest/","description":"URI of a location which will be called when the merge has successfully completed and the result is ready. Must accept GET HTTP Method
\n","type":"text"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"To specify an asynchronous callback, simply specify the value from the parameter AsyncCallback
\nNote: Replace the path/uri values with a suitable URI
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f078541f-cc67-4bf0-8033-772de34394b0"}],"id":"72f5c85c-7857-4146-a84f-a882f9abc9c4","description":"A URI, such as http://myserver/callback, to a location which will be called when the merge has successfully completed and the result is ready. Must accept GET HTTP Method
\n","event":[{"listen":"prerequest","script":{"id":"2d2fa028-2ae7-4d8c-897b-4615031cad3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab479d20-f499-44d7-9b57-30da26329921","type":"text/javascript","exec":[""]}}],"_postman_id":"72f5c85c-7857-4146-a84f-a882f9abc9c4"}],"id":"f4503734-8e26-48fd-b8e3-6f12a872e663","description":"Examples of features exclusively available when using aynchronous merge.
\n","event":[{"listen":"prerequest","script":{"id":"04845e06-f6b8-4cd1-8f2c-8f3f981fdda3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f797aa3-3eec-4f83-8831-ab39fd712ac4","type":"text/javascript","exec":[""]}}],"_postman_id":"f4503734-8e26-48fd-b8e3-6f12a872e663"},{"name":"XML Request","id":"68764ca7-b418-4ccd-adef-4a8d46162a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"This example uses Three Way Merge, but the options equally apply to Sequential and Concurrent Merge types
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"06abfd98-8d0f-4e84-bab5-bc9fcd2d0f60","name":"XML Request Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"This example uses Three Way Merge, but the options equally apply to Sequential and Concurrent Merge types
\nNote that JSON is only used to configure the request, this is DITA Merge. For JSON comparison and merging see our JSON Compare product.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ae2d9217-b395-4f3a-9a53-30d7be16162a","name":"JSON Request Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Ancestor\": {\n \"type\": \"file\",\n \"name\": \"anna\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml\"\n },\n \"VersionOne\": {\n \"type\": \"file\",\n \"name\": \"ben\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml\"\n },\n \"VersionTwo\": {\n \"type\": \"file\",\n \"name\": \"chris\",\n \"Path\": \"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml\"\n },\n \"Async\": {}\n}"},"url":"http://localhost:8080/api/xmlmerge/v1/types/threeway"},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Location","value":"http://localhost:8080/api/xmlmerge/v1/jobs/a9d93c4c-9578-4ebb-a5be-5088c638e7d2"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ce795869-3913-4c93-aab3-062fe74a88c5"},{"name":"multipart/form-data","id":"9732d741-d6d9-41a5-a195-1a6fca06a45b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","key":"Ancestor","type":"text","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml"},{"description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.
\n","key":"AncestorName","type":"text","value":"anna"},{"description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","key":"VersionOne","type":"text","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml"},{"description":"The name of version one. If not specified a default of \"version-one\" will be used.
\n","key":"VersionOneName","type":"text","value":"ben"},{"description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.
\n","key":"VersionTwo","type":"text","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml"},{"description":"The name of version two. If not specified a default of \"version-two\" will be used.
\n","key":"VersionTwoName","type":"text","value":"chris"},{"description":"Boolean controlling whether to use asynchronous operation (true) or not.
\n","key":"Async","type":"text","value":"true"}]},"url":"http://localhost:8080/api/ditamerge/v1/types/threeway","description":"This example uses Three Way Merge, but the options equally apply to Sequential and Concurrent Merge types
\n","urlObject":{"protocol":"http","port":"8080","path":["api","ditamerge","v1","types","threeway"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"22ddb2cb-4514-481e-97db-468bdf72ec7a","name":"multipart/form-data example","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"Ancestor","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-anna.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"AncestorName","value":"anna","description":"The name of the ancestor version. If not specified a default of \"ancestor\" will be used.","type":"text"},{"key":"VersionOne","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-ben.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionOneName","value":"ben","description":"The name of version one. If not specified a default of \"version-one\" will be used.","type":"text"},{"key":"VersionTwo","value":"/usr/local/deltaxml/DeltaXML-DITA-Merge-x_y_z_j/samples/data/four-edits-chris.xml","description":"The field key is used as the version name in the merge. The value will be the input to the merge, e.g. a URI. See Request Description for more details.","type":"text"},{"key":"VersionTwoName","value":"chris","description":"The name of version two. If not specified a default of \"version-two\" will be used.","type":"text"},{"key":"Async","value":"true","description":"Boolean controlling whether to use asynchronous operation (true) or not.","type":"text"}]},"url":"http://localhost:8080/api/xmlmerge/v1/types/threeway"},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Location","value":"http://localhost:8080/api/xmlmerge/v1/jobs/50463f44-b60f-481a-938f-db7394077dcf"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9732d741-d6d9-41a5-a195-1a6fca06a45b"}],"id":"e5a17378-a958-431c-b202-5905661f3852","description":"Merges can be posted asynchronously - the server will set up a Job to handle the request. This can be useful for larger inputs and/or a large number of versions.
\nYou can poll Jobs' information from the /jobs endpoint.
\nThe Job information will highlight any errors, and the output location when complete.
\n","event":[{"listen":"prerequest","script":{"id":"4da95c38-6f1c-4321-b4cd-1c615184f47a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a428c3d5-8e95-451f-b144-6db8a9772b6c","type":"text/javascript","exec":[""]}}],"_postman_id":"e5a17378-a958-431c-b202-5905661f3852"}],"event":[{"listen":"prerequest","script":{"id":"7f604cfb-f48e-4997-8df7-e50f8b5fd81c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c2a6d678-911e-4efa-914a-ff8661744af6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"scheme","value":"http"},{"key":"host","value":"localhost"},{"key":"port","value":"8080"}]}