Returns the result of a comparison. The behavior is defined by the <type>
parameter which is identical to the result
parameter of the /compare command.
The following <type>
parameters are available: pdf, log, webgui, count, report
Returns the comparison result as PDF file. This is the only format that allows customisation using additional parameters.
REQUEST Parameter | Value | Description |
---|---|---|
pageformat | A3 A4 (Default) A5 B4 B5 Legal Letter | Page format of the resulting PDF file |
orientation | PORTRAIT (Default) LANDSCAPE | Page orientation of the resulting PDF file |
onlyside | LEFT RIGHT BOTH (Default) | Which original file(s) should be shown in the exported PDF; The parameter refers to the Comparison Application where: LEFT is the first file and RIGHT the second one |
headerandfooter | TRUE FALSE (Default) | TRUE if additional header and footer should be shown, FALSE otherwise |
fittopage | TRUE FALSE (Default) | TRUE if the comparison pages should be fit into a resulting PDF page |
onlydifferent | TRUE FALSE (Default) | TRUE if only pages with differences should be rendered into the output |
comments | TRUE (Default) FALSE | TRUE add the comments to the exported PDF file, false for no comments |
exportbydiff | TRUE FALSE (Default) | TRUE if PDF file should be returned only in the case of differences |
password | Base64 Encoded String | The password for the created PDF file. MUST be base64 encoded, but the terminator == ist optional. |
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/result/pdf HTTP/1.1 Accept: application/pdf Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: application/pdf <PDF-DATA>
Returns the log of the comparison result in plain text.
REQUEST Parameter | Value | Description |
---|---|---|
format | html | Defines the type of the response. |
json (Default) |
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/result/log HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: plain/text <LOG-FILE-DATA>
Returns a 301
redirect to the webgui with the comparison result.
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/result/webgui HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 301 OK http://myerver.com/comparison/3lw250npgu9903b4nwp6mzr6k
Returns the number of differences as plain text.
REQUEST Parameter | Value | Description |
---|---|---|
format | html json (Default) | Defines the type of the response |
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/result/count HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: plain/text 1000
Returns the comparison result as PDF report file. This parameter is supported since i-net PDFC version 5.
REQUEST Parameter | Value | Description |
---|---|---|
reportformat | pdf (Default) ods rtf xls xlsx | Defines the type of the response |
detailed | TRUE (Default) FALSE | Defines if the report will be detailed |
profile | TRUE (Default) FALSE | Defines if the profile will be append |
exportbydiff | TRUE FALSE (Default) | If this parameter available and the comparsion has differences the pdf return as result. Otherwise return no result. |
password | Base64 Encoded String | The pdf password for the created file. MUST be base64 ancoded; the == terminator ist optional. |