{{sidenavigation.sidenavigationExpandLabel}}
{{getMsg('Help_YouAreHere')}}: {{page.title}} {{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}} {{helpModel.downloadHelpPdfDataStatus}}

<GUID>

Accessing a GUID corresponds to accessing a comparison on the server. Clients need to be authenticated and have the permission to access a comparison - e.g. the user is the owner or the comparison is published to all users.

Further information about the comparison is available using the following commands.

Command Description
/<GUID>/status Display the status of a comparison
/<GUID>/result/<type> Display the result of a comparison
/<GUID>/delete Remove a comparison
/<GUID>/publish Publish a comparison
/<GUID>/unpublish Unpublish a comparison

GET /api/comparison/<GUID>

Requests the details of a comparison

REQUEST Parameter Value Description
format html Defines the type of the response.
json (Default)
RESPONSE Fields Value Type Description
guid string The globally unique id
name string Name of the job when it has been saved
file1name string Name of the first file to compare
file2name string Name of the second file to compare
status string Current state of the job:
IDLE
QUEUED
START
COMPARING
PAUSED
FINISHED
CANCELING
CANCELED
ERROR
profilename string The name of the profile used for comparison
profileid string Unique id of the profile
profilefilename string Name of the profile file
differences number Number of differences found
ispublic boolean True, if the comparison is public
created number timestamp for creation time (server time)
modified number timestamp for modify time (server time)

Example Request

# REQUEST
# Use user:password for authorization
GET /api/comparison/8mzp5899ayao3f9tgvssh6byu HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# RESPONSE
HTTP/1.1 200 OK
Content-Type: application/json
 
{
  "guid": "8mzp5899ayao3f9tgvssh6byu",
  "name": "Testsuit_1",
  "file1name": "TEST1.pdf",
  "file2name": "TEST6.pdf",
  "status": "IDLE",
  "profilename": "Text only",
  "profileid": "textonly00000000000000000",
  "profilefilename": null,
  "differences": 0,
  "ispublic": false,
  "created": 0,
  "modified": 0
}

Application Example

# Browser access: use the following URL
http://127.0.0.1:9900/api/comparison/8mzp5899ayao3f9tgvssh6byu
 
# Shell access using curl
curl -Lsu <USERNAME>:<PASSWORD> 'http://127.0.0.1:9900/api/comparison/8mzp5899ayao3f9tgvssh6byu'
i-net PDFC
This application uses cookies to allow login. By continuing to use this application, you agree to the use of cookies.


Help - /<GUID>