{"info":{"_postman_id":"d0c7bc63-5961-40cf-ac47-876c07237698","name":"XML Compare REST API","description":"

Collection for demonstrating and testing DeltaXML's XML Compare REST API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5865263","collectionId":"d0c7bc63-5961-40cf-ac47-876c07237698","publishedId":"S11By26L","public":true,"customColor":{"top-bar":"545F6D","right-sidebar":"545F6D","highlight":"EF5B25"},"publishDate":"2019-02-15T14:02:40.000Z"},"item":[{"name":"Get Pipeline Info","item":[{"name":"All Pipelines Info","id":"2d213fc0-1655-4bcc-b001-fc042ec57697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xml-compare/v1/pipelines","description":"

Calling GET on the pipelines endpoint gives you information about the various pipelines that are available.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3d9c248e-d0c2-42a5-aefc-c689878967c9","name":"JSON Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":true},{"key":"Accept","value":"application/json","disabled":false}],"url":"http://localhost:8080/api/xml-compare/v1/pipelines"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1186","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"},{"key":"Date","value":"Wed, 18 Apr 2018 12:27:33 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"schema\",\n \"name\": \"[DXP] Schema Compare, output HTML report\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/schema\"\n }\n ]\n },\n {\n \"id\": \"doc-delta\",\n \"name\": \"[DCP] XML Compare, output XML delta\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/doc-delta\"\n }\n ]\n },\n {\n \"id\": \"diffreport-sbs\",\n \"name\": \"[DXP] XML Compare, output HTML5 Side-by-Side report\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/diffreport-sbs\"\n }\n ]\n },\n {\n \"id\": \"doc-diffreport\",\n \"name\": \"[DCP] XML Compare, output HTML folding report\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/doc-diffreport\"\n }\n ]\n },\n {\n \"id\": \"doc-diffreport-sbs\",\n \"name\": \"[DCP] XML Compare, output HTML Side-by-Side report\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/doc-diffreport-sbs\"\n }\n ]\n },\n {\n \"id\": \"delta\",\n \"name\": \"[DXP] XML Compare, output XML delta\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/delta\"\n }\n ]\n },\n {\n \"id\": \"diffreport\",\n \"name\": \"[DXP] XML Compare, output HTML folding report\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/diffreport\"\n }\n ]\n },\n {\n \"id\": \"raw\",\n \"name\": \"[DXP] XML Compare, output recombinable delta\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/raw\"\n }\n ]\n },\n {\n \"id\": \"xhtml\",\n \"name\": \"[DXP] XHTML Compare, output XHTML\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/api/xml-compare/v1/pipelines/xhtml\"\n }\n ]\n }\n]"},{"id":"61e8db2a-5815-47c1-a723-1c42c20c2f18","name":"XML Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"},{"key":"Accept","value":"application/json","disabled":true}],"url":"http://localhost:8080/api/xml-compare/v1/pipelines"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"5929","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"},{"key":"Date","value":"Wed, 18 Apr 2018 12:26:17 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"schema[DXP] Schema Compare, output HTML reportdoc-delta[DCP] XML Compare, output XML deltaload-external-dtdfalseresolve-formatting-diffstruecollate-element-type-infofalseschema-locationformatting-element-listb,i,u,em,strong,emphasisimportant-attribute-listid,name,property,keydiffreport-sbs[DXP] XML Compare, output HTML5 Side-by-Side reportPreserve WhitespacefalseWord By WordtrueEnhanced Match 1truedoc-diffreport[DCP] XML Compare, output HTML folding reportload-external-dtdfalseresolve-formatting-diffstruecollate-element-type-infofalseadd-all-namespace-declarationsfalseminimize-unchanged-displayfalseschema-locationformatting-element-listb,i,u,em,strong,emphasisimportant-attribute-listid,name,property,keyno-fold-size50doc-diffreport-sbs[DCP] XML Compare, output HTML Side-by-Side reportload-external-dtdfalseresolve-formatting-diffstrueschema-locationformatting-element-listb,i,u,em,strong,emphasisimportant-attribute-listid,name,property,keydelta[DXP] XML Compare, output XML deltaPreserve WhitespacefalseFull ContexttrueWord By WordfalseEnhanced Match 1trueIndentyesdiffreport[DXP] XML Compare, output HTML folding reportPreserve WhitespacefalseWord By WordfalseEnhanced Match 1trueadd-all-namespace-declarationsfalseminimize-unchanged-displayfalsecollate-element-type-infofalseno-fold-size50important-attribute-listid,name,property,keyraw[DXP] XML Compare, output recombinable deltaxhtml[DXP] XHTML Compare, output XHTMLWord By WordtrueIgnore Format ChangestrueView Buttonsyes"}],"_postman_id":"2d213fc0-1655-4bcc-b001-fc042ec57697"},{"name":"Delta Pipeline Info","id":"85c8e1e4-f7fb-4ca2-a648-4bea0960514d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

You can get information for a specific pipeline by adding its id after /pipelines/

For example this request uses the \"delta\" pipeline - a simple pipeline provided by DeltaXML.

The /pipelines endpoint allows to get information about available pipelines

\n","event":[{"listen":"prerequest","script":{"id":"4df4cb5c-3369-4963-98d6-b12de2909d81","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e0df859-2fea-4d53-baa8-4d363e1f52e0","type":"text/javascript","exec":[""]}}],"_postman_id":"04ba6e8b-7303-4663-ac52-7912e9d6ef1d"},{"name":"Synchronous Comparisons","item":[{"name":"XML Format","id":"ae4b0a0d-44de-477e-857d-aeb91fce51a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \n Preserve Whitespace\n false\n \n \n Word By Word\n true\n \n \n Indent\n yes\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Demonstrates how to use file paths and HTTP URIs from XML formatted input

Note: Replace the path/uri values with a suitable URI

\n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n Word by word comparison may need to be turned off for \n certain \n circumstances where it is not suitable.\n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n

\n\n"}],"_postman_id":"ae4b0a0d-44de-477e-857d-aeb91fce51a7"},{"name":"JSON Format","id":"8a0d2ec0-9c5a-45ad-94e5-97719ae2abfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\"\n },\n \"configurationParameters\": [\n \t{\n \"booleanParameter\": {\n \"name\": \"Word By Word\",\n \"value\": true\n }\n },\n {\n \"stringParameter\": {\n \"name\": \"Indent\",\n \"value\": \"yes\"\n }\n }\n\t]\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Demonstrates how to use file paths and HTTP URIs from JSON formatted input.

Note: Replace the uri values with a suitable URI.

\n\n"}],"_postman_id":"8a0d2ec0-9c5a-45ad-94e5-97719ae2abfb"},{"name":"multipart/form-data","id":"8bebcf24-aec9-40be-9359-06407a2efabf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"A","value":"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"B","value":"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"

Comma separated parameters

\n","type":"text","disabled":true}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

multipart/form-data can also be used to specify comparisons.

In addition to file paths and HTTP URIs, with multipart/form-data you can also use raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part.

\n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n

\n\n"},{"id":"6cd29d63-9aa0-4365-ab09-523cf00179a3","name":"File Paths","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"A","value":"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml","description":"Can be a file path, a HTTP(S) URI, or raw XML (note: cannot enter raw strings as text in Postman currently)","type":"text"},{"key":"B","value":"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"Can be a file path, a HTTP(S) URI, or raw XML (note: cannot enter raw strings as text in Postman currently)","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"Comma separated parameters","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"Comma separated parameters","type":"text","disabled":true}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"2936","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"},{"key":"Date","value":"Tue, 17 Apr 2018 12:29:49 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n A pangram uses all the letters of the alphabet. It is often used to test typewriters or computer keyboards, for example: The quick brown fox jumps over the lazy dog.\n A pangram uses all the letters of the alphabet and is often used to test typewriters or computer keyboards, for example: A quick movement of the enemy will jeopardize six gunboats.\n \n \n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n

\n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n \n \n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for circumstances where it is not suitable.\n \n \n

\n\n"}],"_postman_id":"8bebcf24-aec9-40be-9359-06407a2efabf"}],"id":"df3b8df0-1308-4e76-a9e5-a061abfce916","description":"

Comparisons can be posted in a synchronous request - the response will be the comparison result.

This is recommended for use only for very small comparisons (where the request isn't likely to timeout), or if information about the comparison (e.g. progress, size of result) isn't necessary.

\n","event":[{"listen":"prerequest","script":{"id":"c84b3a8b-3597-4442-b551-55fe5362b2d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e4301a0-20f3-45c4-aa7e-df25e69c2dcb","type":"text/javascript","exec":[""]}}],"_postman_id":"df3b8df0-1308-4e76-a9e5-a061abfce916"},{"name":"Async Comparisons","item":[{"name":"Jobs & Results","item":[{"name":"Get Job Info","id":"f37c90d9-840b-4cd1-afd3-e9d8ee1b0ae9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xml-compare/v1/jobs/0","description":"

Calling GET on a specified Job (returned in the Location header of the initial comparison request) allows you to check the Job's information.

This example uses Job #0, the id can changed by changing the 0 in the path, e.g. .../jobs/12

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","jobs","0"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3747a301-9ce8-4be8-af3b-d298e1939602","name":"XML Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":false},{"key":"Accept","value":"application/json","disabled":true}],"url":"http://localhost:8080/api/xml-compare/v1/jobs/0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"498","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"},{"key":"Date","value":"Tue, 17 Apr 2018 13:58:10 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"2018-04-17T14:05:58.679+01:002018-04-17T14:57:30.167+01:00FINISHED8dxp-0-com.deltaxml.pipe.filters.NormalizeSpace100.02018-04-17T14:05:58.684+01:00"},{"id":"b78da2ba-c227-4ede-a610-58338716bc0c","name":"JSON Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":true},{"key":"Accept","value":"application/json","disabled":false}],"url":"http://localhost:8080/api/xml-compare/v1/jobs/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"346","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"},{"key":"Date","value":"Wed, 18 Apr 2018 13:18:01 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"{\"startTime\":\"2018-04-18T13:18:00.214+0000\",\"creationTime\":\"2018-04-18T13:18:00.207+0000\",\"finishedTime\":\"2018-04-18T13:18:00.315+0000\",\"numberOfStages\":11,\"progressInPercentage\":100.0,\"pipelineStage\":\"dxp-0-com.deltaxml.pipe.filters.dx2.wbw.WordOutfilter\",\"jobStatus\":\"FINISHED\",\"links\":[{\"href\":\"/api/xml-compare/v1/results/0\",\"rel\":\"result\"}]}"}],"_postman_id":"f37c90d9-840b-4cd1-afd3-e9d8ee1b0ae9"},{"name":"Cancel Queued Job","id":"b9c8d43b-48b2-4a32-bb22-373438c3b308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/xml"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8080/api/xml-compare/v1/jobs/0","description":"

Queued jobs can be cancelled by using a HTTP DELETE request.

Note: it is unlikely Job 0 actually will be queued for very long - replace the 0 in the path with a job that is queued.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","jobs","0"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"841541e9-2aec-4a9a-a7f6-f0242a680590","name":"JSON Format","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/xml","disabled":true},{"key":"Accept","value":"application/json","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8080/api/xml-compare/v1/jobs/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"128","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"},{"key":"Date","value":"Wed, 18 Apr 2018 13:19:45 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"{\"creationTime\":\"2018-04-18T13:19:31.989+0000\",\"numberOfStages\":0,\"progressInPercentage\":0.0,\"jobStatus\":\"CANCELLED\",\"links\":[]}"},{"id":"b21a4618-b378-477c-93db-97c1e1639caa","name":"XML Format","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/xml","disabled":false},{"key":"Accept","value":"application/json","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8080/api/xml-compare/v1/jobs/0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"229","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"},{"key":"Date","value":"Wed, 18 Apr 2018 13:07:03 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"2018-04-18T14:06:59.777+01:00CANCELLED00.0"}],"_postman_id":"b9c8d43b-48b2-4a32-bb22-373438c3b308"},{"name":"Get Result Info","id":"9d977213-994b-4644-9c10-f8f765be3cac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xml-compare/v1/results/0","description":"

When a Job is complete - you can get its Result information.

This example uses Result #0, the id can changed by changing the 0 in the path, e.g. .../results/12

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","results","0"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"8e83e707-462c-420a-bb84-95b4e41cfbf7","name":"JSON Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":true},{"key":"Accept","value":"application/json","disabled":false}],"url":"http://localhost:8080/api/xml-compare/v1/results/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"189","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"},{"key":"Date","value":"Wed, 18 Apr 2018 13:21:06 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"{\"comparisonTime\":\"1423 ms\",\"finishTime\":\"2018-04-18T13:21:03.744+0000\",\"output\":{\"type\":\"http\",\"size\":3036,\"uri\":\"http://localhost:8080/api/xml-compare/v1/downloads/0\"},\"status\":\"SUCCESS\"}"},{"id":"a77f0262-3139-4425-bb15-2edf139862c8","name":"XML Format","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":false},{"key":"Accept","value":"application/json","disabled":true}],"url":"http://localhost:8080/api/xml-compare/v1/results/0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"280","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"},{"key":"Date","value":"Wed, 18 Apr 2018 12:58:18 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"SUCCESS90 ms2018-04-18T13:56:52.012+01:00http://localhost:8080/api/xml-compare/v1/downloads/03036"}],"_postman_id":"9d977213-994b-4644-9c10-f8f765be3cac"},{"name":"Download result","id":"439eb6b8-a7b4-4e63-8e9d-558246c03b04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"http://localhost:8080/api/xml-compare/v1/downloads/0","description":"

When a Job is complete - you can get its XML result with the downloads endpoint (linked to from the Result object)

This example uses Job #0, the id can changed by changing the 0 in the path, e.g. .../downloads/12

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","downloads","0"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e2abab72-55ff-4157-938c-db9c988d2eca","name":"Comparison result","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","disabled":false}],"url":"http://localhost:8080/api/xml-compare/v1/downloads/0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1159","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"},{"key":"Date","value":"Tue, 17 Apr 2018 14:03:18 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"\n\n A pangram uses all the letters of the alphabet. It is often used to test typewriters or computer keyboards, for example: The quick brown fox jumps over the lazy dog.\n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n

\n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n Word by word comparison may need to be turned off for certain circumstances where it is not suitable.\n

\n\n"}],"_postman_id":"439eb6b8-a7b4-4e63-8e9d-558246c03b04"}],"id":"b948088f-19c4-42eb-889b-dae1c8f02789","description":"

Asynchronous comparisons give you Job and Results resources containing relevant information about the comparison.

\n","event":[{"listen":"prerequest","script":{"id":"9185b72a-caed-4e11-b2d2-8f295c163ae2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e64b55a-0ba4-4207-a727-df7a3624f887","type":"text/javascript","exec":[""]}}],"_postman_id":"b948088f-19c4-42eb-889b-dae1c8f02789"},{"name":"Async Features","item":[{"name":"Callback","item":[{"name":"XML Format","id":"683c51aa-0795-4b95-93e2-7570e0712916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \thttp://www.example.com\n\t\n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To specify an asynchronous callback, simply specify the value in the <callback> element, a child of the <async> element.

For more information, see the User Guide.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"683c51aa-0795-4b95-93e2-7570e0712916"},{"name":"JSON Format","id":"efde0166-f345-4797-855f-f9c569f83ece","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\"\n },\n \"async\": {\n \t\"callback\": \"http://www.example.com\"\n }\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To specify an asynchronous callback, simply specify the value with the key callback, inside the async object.

For more information, see the User Guide.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"efde0166-f345-4797-855f-f9c569f83ece"},{"name":"multipart/form-data","id":"21571749-38f5-4017-8f04-6e3fb7ae4c55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"A","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"B","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"async","value":"true","description":"

Boolean controlling setting asynchronous or synchronous comparison (true for async, false for sync)

\n","type":"text"},{"key":"callback","value":"http://www.example.com","description":"

A URL that the REST service will call a GET request on (with Job specific parameters) after the comparison is complete.

\n","type":"text"}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To specify an asynchronous callback, simply specify the value from the parameter callback

For more information, see the User Guide.

Note: Replace the path/uri values with a suitable URI or upload a file. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"21571749-38f5-4017-8f04-6e3fb7ae4c55"}],"id":"64f5b2a5-6254-4ccb-aff6-6de3eb4ba1e4","description":"

A callback URL can be specified when using asynchronous comparisons.

When the comparison is complete, a HTTP GET request will be made with comparison specific parameters.

For example if \"http://www.example.com/comparison-callback\" is registered, then a GET request will be made to \"http://www.example.com/comparison-callback?jobNumber=12346124&resultResource=/results/12346124\"

\n","event":[{"listen":"prerequest","script":{"id":"b0aa152d-a02c-459a-a9e6-f45a9f546619","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d2b1b122-32ac-4fb4-92b0-f21da4fc2f40","type":"text/javascript","exec":[""]}}],"_postman_id":"64f5b2a5-6254-4ccb-aff6-6de3eb4ba1e4"},{"name":"Keep Result","item":[{"name":"XML Format","id":"cbd92c92-9b33-416e-9338-4d8aeb870535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \ttrue\n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Example showing specifying the \"keepResult\" variable.

If set to false the result file will be deleted from the server after the first time you download the XML comparison result.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cbd92c92-9b33-416e-9338-4d8aeb870535"},{"name":"JSON Format","id":"f38064a7-5f37-450c-9d4d-31fdbf2953ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\"\n },\n \"async\": {\n \t\"keepResult\": true\n }\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Example showing specifying the \"keepResult\" variable.

If set to false the result file will be deleted from the server after the first time you download the XML comparison result.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f38064a7-5f37-450c-9d4d-31fdbf2953ac"},{"name":"multipart/form-data","id":"114a74fc-3d34-42a7-8447-2e71a7a95d63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"A","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"B","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"async","value":"true","description":"

Boolean controlling setting asynchronous or synchronous comparison (true for async, false for sync)

\n","type":"text"},{"key":"keepResult","value":"true","description":"

Boolean controlling keeping the result file stored on the server after downloading it or not. Default is false.

\n","type":"text"}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Example showing specifying the \"keepResult\" variable.

If set to false the result file will be deleted from the server after the first time you download the XML comparison result.

Note: Replace the path/uri values with a suitable URI or upload a file. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"114a74fc-3d34-42a7-8447-2e71a7a95d63"}],"id":"95dce5ed-9f48-4932-b609-8bcd70883027","description":"

keepResult is a boolean value indicating whether to keep the result file after the first time it is downloaded.

\n","event":[{"listen":"prerequest","script":{"id":"65626d6e-0e3a-4d4d-b898-5c7d94bc9d90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6fcd56eb-b8e7-41c2-b0ae-b6d5b462113c","type":"text/javascript","exec":[""]}}],"_postman_id":"95dce5ed-9f48-4932-b609-8bcd70883027"},{"name":"Output","item":[{"name":"XML Format","id":"ff41118b-06be-4708-a789-d0a3b6ae1f07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \t/Users/exampleUser/Documents/result.xml\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

You can specify a file path (on the server) for where the result file will be written to.

For more information see the User Guide.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff41118b-06be-4708-a789-d0a3b6ae1f07"},{"name":"JSON Format","id":"4d55346d-dcda-43e5-9ac3-21d5c0d6a490","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\"\n },\n \"output\": {\n \t\"type\": \"file\",\n \t\"path\": \"/Users/exampleUser/Documents/result.xml\"\n },\n \"async\": {}\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

You can specify a file path (on the server) for where the result file will be written to.

For more information see the User Guide.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d55346d-dcda-43e5-9ac3-21d5c0d6a490"},{"name":"multipart/form-data","id":"5fe02aec-17d5-41b0-b44a-b63052bd74ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"A","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"B","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"async","value":"true","description":"

Boolean controlling setting asynchronous or synchronous comparison (true for async, false for sync)

\n","type":"text"},{"key":"output","value":"/Users/exampleUser/Documents/result.xml","description":"

File path (on the server) for where the result file will be written.

\n","type":"text"}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

You can specify a file path (on the server) for where the result file will be written to.

For more information see the User Guide.

Note: Replace the path/uri values with a suitable URI or upload a file. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"5fe02aec-17d5-41b0-b44a-b63052bd74ac"}],"id":"f4eed17a-46ef-49b7-a635-71d062b4169f","description":"

A file path (on the server) can be specified that controls where the comparison result file will be written.

\n","event":[{"listen":"prerequest","script":{"id":"64ce1e13-4dae-40ee-8f62-c43115bdc767","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"44f0cf8c-30b8-4ebd-9319-95c36253c2ee","type":"text/javascript","exec":[""]}}],"_postman_id":"f4eed17a-46ef-49b7-a635-71d062b4169f"}],"id":"70fb3b5a-ec4b-42da-9acc-0b556ff25e14","description":"

Examples of features exclusively available when using aynchronous comparisons.

\n","event":[{"listen":"prerequest","script":{"id":"8235c615-e5af-4121-bc04-46862e263cd9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2149871-89ef-47f9-b846-318fc0cfc03f","type":"text/javascript","exec":[""]}}],"_postman_id":"70fb3b5a-ec4b-42da-9acc-0b556ff25e14"},{"name":"Run Async","item":[{"name":"XML Format","id":"cd6f0695-3d68-4b51-971d-f1929e3093d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \n Preserve Whitespace\n false\n \n \n Word By Word\n true\n \n \n Indent\n yes\n \n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To specify an asynchronous comparison when using XML formatted input just add the <async> element.

In the \"Async Features\" folder there are requests showing the extra values you can specify beneath <async>.

Note: Replace the path/uri values with a suitable URI

To specify an asynchronous comparison when using JSON formatted input just add the async key, with its value an object.

In the \"Async Features\" folder there are requests showing the extra values you can specify beneath async, but if using default values you can leave it as an empty object.

Note: Replace the path/uri values with a suitable URI

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"B","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml","description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","type":"text"},{"key":"booleanParameters","value":"Word By Word=true","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"stringParameters","value":"Indent=no","description":"

Comma separated parameters

\n","type":"text","disabled":true},{"key":"async","value":"true","description":"

Boolean controlling setting asynchronous or synchronous comparison (true for async, false for sync)

\n","type":"text"}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To specify an asynchronous comparison when using multipart/form-data, set the async parameter to true.

You can also specify extra values - output, keepResult, and callback.

Note: Replace the path/uri values with a suitable URI or upload a file. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part.

Comparisons can be posted asynchronously - the server will set up a Job to handle the request.

You can poll Jobs' information from the /jobs endpoint.

When the Job is complete, you can check the /results endpoint to get information about the result.

\n","event":[{"listen":"prerequest","script":{"id":"8b713d53-5453-4448-a02e-5595ec35b6a2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5015babc-ffe9-4daf-ae9b-5578dba3e080","type":"text/javascript","exec":[""]}}],"_postman_id":"ec4d85dd-5c66-4cad-ac53-80bbd9f6f7ca"},{"name":"General Features","item":[{"name":"Catalog","item":[{"name":"XML Format","id":"7da1ee5d-f489-408e-bf4c-27450e9c8f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\n \n \n \t/Users/exampleUser/Documents/catalog.xml\n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

An XML Catalog can be specified, from either a file path or HTTP URI.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7da1ee5d-f489-408e-bf4c-27450e9c8f59"},{"name":"JSON Format","id":"6cb54a5d-7b82-4c48-9a20-8c7dc99591ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml\"\n },\n \"catalog\": {\n \"type\": \"file\",\n \"path\": \"/Users/exampleUser/Documents/catalog.xml\"\n }\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

An XML Catalog can be specified, from either a file path or HTTP URI.

Note: Replace the path/uri values with a suitable URI

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cb54a5d-7b82-4c48-9a20-8c7dc99591ab"},{"name":"multipart/form-data","id":"0a00ff93-2a8d-43af-851c-c25fcc863d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","key":"A","type":"text","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input1.xml"},{"description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","key":"B","type":"text","value":"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input2.xml"},{"description":"

Comma separated parameters

\n","key":"booleanParameters","type":"text","value":"Word By Word=true","disabled":true},{"description":"

Comma separated parameters

\n","key":"stringParameters","type":"text","value":"Indent=no","disabled":true},{"description":"

Can be a file path, a HTTP(S) URI, or raw XML. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","key":"catalog","type":"text","value":"file:///usr/local/deltaxml/dita-catalog.xml"}]},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Example showing how an XML Catalog can be specified.

Note: Replace the path/uri values with a suitable URI or upload a file. To specify raw XML use application/xml, text/xml or text/html as the Content-Type of the part

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a00ff93-2a8d-43af-851c-c25fcc863d37"}],"id":"42b025c7-f580-4498-b326-780422da1fff","description":"

An OASIS XML Catalog can be specified.

\n","event":[{"listen":"prerequest","script":{"id":"0b80d84f-ce34-4fcb-bbe0-5eca035ab0cf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8a6c81b3-5f9b-4b40-989f-1d1dc1bc3fe9","type":"text/javascript","exec":[""]}}],"_postman_id":"42b025c7-f580-4498-b326-780422da1fff"},{"name":"Error Handling","item":[{"name":"XML","id":"51d17ccd-7b91-4b6f-a275-1b8eed078c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml\n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input4.xml\n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Shows how errors are formatted in XML format - in this example there are non-existent files as inputs.

For more information, see the User Guide.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"7a5e05b0-4e40-44ab-bb11-6b6f999ed83e","name":"XML Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false},{"key":"Accept","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml\n \n \n \n \n file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input4.xml\n \n \n \n \n Preserve Whitespace\n false\n \n \n Word By Word\n true\n \n \n Indent\n yes\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"2632","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"},{"key":"Date","value":"Tue, 17 Apr 2018 14:10:26 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory)400com.deltaxml.xmlcompare.rest.exceptions.ServerErrorException: /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory) com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:252) com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:86) com.deltaxml.xmlcompare.rest.services.PipelinesService.lambda$runSyncComparison$1(PipelinesService.java:65) java.util.concurrent.FutureTask.run(FutureTask.java:266) java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) java.lang.Thread.run(Thread.java:745)Caused by: java.io.FileNotFoundException: /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory) java.io.FileInputStream.open0(Native Method) java.io.FileInputStream.open(FileInputStream.java:195) java.io.FileInputStream.<init>(FileInputStream.java:138) com.deltaxml.xmlcompare.rest.services.PipelinesService.getInputSource(PipelinesService.java:296) com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:188) com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:86) com.deltaxml.xmlcompare.rest.services.PipelinesService.lambda$runSyncComparison$1(PipelinesService.java:65) java.util.concurrent.FutureTask.run(FutureTask.java:266) java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) java.lang.Thread.run(Thread.java:745)"}],"_postman_id":"51d17ccd-7b91-4b6f-a275-1b8eed078c4a"},{"name":"JSON","id":"7458cdc8-b73d-44dc-8c0c-3f669334da27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input4.xml\"\n }\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

Shows how errors are formatted in JSON format - in this example there are non-existent files as inputs.

For more information, see the User Guide.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"296a0e29-6a3c-4747-bba4-ddcb3ccdd8e5","name":"JSON Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"file\",\n \"path\": \"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml\"\n },\n \"inputB\": {\n \"type\": \"http\",\n \"uri\": \"file:///usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input4.xml\"\n }\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"1912","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"},{"key":"Date","value":"Wed, 18 Apr 2018 13:33:56 GMT","name":"Date","description":"The date and time that the message was sent"}],"cookie":[],"responseTime":null,"body":"{\"errorMessage\":\"/usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory)\",\"errorCode\":400,\"stackTrace\":[\"com.deltaxml.xmlcompare.rest.exceptions.ServerErrorException: /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:252)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:86)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.lambda$runSyncComparison$1(PipelinesService.java:65)\",\" java.util.concurrent.FutureTask.run(FutureTask.java:266)\",\" java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\",\" java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\",\" java.lang.Thread.run(Thread.java:745)\",\"Caused by: java.io.FileNotFoundException: /usr/local/deltaxml/DeltaXML-XML-Compare-9_0_6_j/samples/WordByWord/input3.xml (No such file or directory)\",\" java.io.FileInputStream.open0(Native Method)\",\" java.io.FileInputStream.open(FileInputStream.java:195)\",\" java.io.FileInputStream.(FileInputStream.java:138)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.getInputSource(PipelinesService.java:296)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:188)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.runComparison(PipelinesService.java:86)\",\" com.deltaxml.xmlcompare.rest.services.PipelinesService.lambda$runSyncComparison$1(PipelinesService.java:65)\",\" java.util.concurrent.FutureTask.run(FutureTask.java:266)\",\" java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\",\" java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\",\" java.lang.Thread.run(Thread.java:745)\"]}"}],"_postman_id":"7458cdc8-b73d-44dc-8c0c-3f669334da27"}],"id":"b3835202-6ced-4103-ab96-b16f6826608f","description":"

Examples showing how errors are formatted, in both XML and JSON format.

\n","event":[{"listen":"prerequest","script":{"id":"2472bfa6-015c-46c7-bcaf-bec8d2258841","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6b6e91ab-6a63-49dc-bc38-30607f26bb7d","type":"text/javascript","exec":[""]}}],"_postman_id":"b3835202-6ced-4103-ab96-b16f6826608f"},{"name":"Cloud IO","item":[{"name":"Microsoft Azure","item":[{"name":"XML Format","id":"f13c4ddb-0fc4-4515-a6b5-de9be0d3764c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n your_azure_account\n your_account_key\n your_bucket\n input_a_path\n \n \n your_azure_account\n your_account_key\n your_bucket\n input_b_path\n \n \n your_azure_account\n your_account_key\n your_bucket\n output_path\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use Microsoft Azure Storage, you will need to specify your account details, along with the bucket your data is stored in, and the path of the input file.

Note: async is recommended as the REST service needs to make additional HTTP requests to retrieve your data.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f13c4ddb-0fc4-4515-a6b5-de9be0d3764c"},{"name":"JSON Format","id":"01d27e64-bdc0-4995-9b44-c829a263fe94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"microsoftazure\",\n \"accountName\": \"your_account_name\",\n \"accountKey\": \"your_account_key\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_a_path\"\n },\n \"inputB\": {\n \t\"type\": \"microsoftazure\",\n \"accountName\": \"your_account_name\",\n \"accountKey\": \"your_account_key\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_b_path\"\n },\n \"output\": {\n \t\"type\": \"microsoftazure\",\n \"accountName\": \"your_account_name\",\n \"accountKey\": \"your_account_key\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"output_path\"\n },\n \"async\": {}\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use Microsoft Azure Storage, you will need to specify your account details, along with the bucket your data is stored in, and the path of the input file.

Note: async is recommended as the REST service needs to make additional HTTP requests to retrieve your data.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"01d27e64-bdc0-4995-9b44-c829a263fe94"}],"id":"910eda07-4b37-4f4e-8fcd-62e0f5d59caf","description":"

For more information on Microsoft Azure, including generating credentials to access your data, see https://azure.microsoft.com/en-gb/services/storage/

\n","event":[{"listen":"prerequest","script":{"id":"595af3f8-8c0c-4f7d-839c-5eaf63a7aab8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d67f7228-47f3-4a7f-83b3-ea5afbbdc406","type":"text/javascript","exec":[""]}}],"_postman_id":"910eda07-4b37-4f4e-8fcd-62e0f5d59caf"},{"name":"AWS S3","item":[{"name":"XML Format","id":"323b3239-673f-4534-a4dc-50a4e6cfdc0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n your_aws_client_id\n your_aws_client_secret\n your_aws_region\n your_bucket\n input_a_path\n \n \n your_aws_client_id\n your_aws_client_secret\n your_aws_region\n your_bucket\n input_b_path\n \n \n your_aws_client_id\n your_aws_client_secret\n your_aws_region\n your_bucket\n output_path\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use AWS S3, you will need to specify your client details, AWS region, the bucket your data is stored in, and the name of the file.

Note: async is recommended as the REST service needs to make additional HTTP requests

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"323b3239-673f-4534-a4dc-50a4e6cfdc0f"},{"name":"JSON Format","id":"04d92956-5e7a-498d-b8dc-0aa452dcdd49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"amazons3\",\n \"clientId\": \"your_aws_client_id\",\n \"clientSecret\": \"your_aws_client_secret\",\n \"region\": \"your_aws_region\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_a_path\"\n },\n \"inputB\": {\n \t\"type\": \"amazons3\",\n \"clientId\": \"your_aws_client_id\",\n \"clientSecret\": \"your_aws_client_secret\",\n \"region\": \"your_aws_region\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_b_path\"\n },\n \"output\": {\n \t\"type\": \"amazons3\",\n \"clientId\": \"your_aws_client_id\",\n \"clientSecret\": \"your_aws_client_secret\",\n \"region\": \"your_aws_region\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"output_path\"\n },\n \"async\": {}\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use AWS S3, you will need to specify your client details, AWS region, the bucket your data is stored in, and the name of the file.

Note: async is recommended as the REST service needs to make additional HTTP requests

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"04d92956-5e7a-498d-b8dc-0aa452dcdd49"}],"id":"5ae87139-1d11-44c9-81a8-6b629e1352e8","description":"

For more information on AWS S3, including generating client credentials to access your buckets, see https://aws.amazon.com/s3/

\n","event":[{"listen":"prerequest","script":{"id":"2b5a69f6-fc65-49c7-97b6-6d8b36faed21","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"46678fd0-abf1-4f58-a524-d48c3138e23e","type":"text/javascript","exec":[""]}}],"_postman_id":"5ae87139-1d11-44c9-81a8-6b629e1352e8"},{"name":"Google Cloud","item":[{"name":"XML Format","id":"084d5644-23ab-409c-8c5f-21802de0cba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n your_email\n your_private_key\n your_project_id\n your_bucket\n input_a_path\n \n \n\t\tyour_email\n your_private_key\n your_project_id\n your_bucket\n input_b_path\n \n \n\t\tyour_email\n your_private_key\n your_project_id\n your_bucket\n output_path\n \n \n"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use Google Cloud Platform, you will need to specify your client details including private key and project ID, along with the bucket your data is stored in, and the input file paths

Note: async is recommended as the REST service needs to make additional HTTP requests

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"084d5644-23ab-409c-8c5f-21802de0cba3"},{"name":"JSON Format","id":"ed5bc1ec-ccf2-43cc-be93-55751cd137c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n \"inputA\": {\n \t\"type\": \"googlecloudplatform\",\n \t\"clientEmail\": \"your_email\",\n \"privateKey\": \"your_private_key\",\n \"projectId\": \"your_project_id\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_a_path\"\n },\n \"inputB\": {\n \t\"type\": \"googlecloudplatform\",\n \t\"clientEmail\": \"your_email\",\n \"privateKey\": \"your_private_key\",\n \"projectId\": \"your_project_id\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"input_b_path\"\n },\n \"output\": {\n \t\"type\": \"googlecloudplatform\",\n \t\"clientEmail\": \"your_email\",\n \"privateKey\": \"your_private_key\",\n \"projectId\": \"your_project_id\",\n \"bucket\": \"your_bucket_name\",\n \"path\": \"output_path\"\n },\n \"async\": {}\n}"},"url":"http://localhost:8080/api/xml-compare/v1/pipelines/delta","description":"

To use Google Cloud Platform, you will need to specify your client details including private key and project ID, along with the bucket your data is stored in, and the input file paths.

Note: async is recommended as the REST service needs to make additional HTTP requests

\n","urlObject":{"protocol":"http","port":"8080","path":["api","xml-compare","v1","pipelines","delta"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed5bc1ec-ccf2-43cc-be93-55751cd137c8"}],"id":"9c282d7f-21c1-4a30-a52c-6833581c2d25","description":"

For more information on Google Cloud, including generating credentials to access your data, see https://cloud.google.com/storage/

\n","event":[{"listen":"prerequest","script":{"id":"0410275e-25f5-4656-a084-df18a6972c1b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92f4b3d8-7203-4852-a3e2-4acebd38b6e3","type":"text/javascript","exec":[""]}}],"_postman_id":"9c282d7f-21c1-4a30-a52c-6833581c2d25"}],"id":"d00e7c55-8bb0-4e33-9060-593a728b39ec","description":"

We currently support Microsoft Azure Storage, Google Cloud Storage, and Amazon Web Services S3.\nNOTE: CloudRail's API has been deprecated, existing licenses will continue to work for the foreseeable future. We will revise this service in a future release.

\n","event":[{"listen":"prerequest","script":{"id":"a5ac690c-d6d0-486f-8572-d3f3945f13dc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4246a27f-4842-4a0c-9e9a-710201bc7eb9","type":"text/javascript","exec":[""]}}],"_postman_id":"d00e7c55-8bb0-4e33-9060-593a728b39ec"}],"id":"1f97c36a-b5ac-450a-a4c3-b878b8d5ec0c","description":"

Examples of features available in both synchronous and asynchronous comparisons.

\n","event":[{"listen":"prerequest","script":{"id":"a2c19fa5-a4d3-465f-a002-256f19b4a8ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"74fa6caf-1907-40ae-a76e-f82b53646402","type":"text/javascript","exec":[""]}}],"_postman_id":"1f97c36a-b5ac-450a-a4c3-b878b8d5ec0c"}],"event":[{"listen":"prerequest","script":{"id":"32357aee-0bb3-4c14-b1d3-b7637d8ad3bd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b19710e8-3d99-41d8-97eb-6b3541ead0f2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"scheme","value":"http"},{"key":"host","value":"localhost"},{"key":"port","value":"8080"}]}