{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Status
Returns the status of the specified comparison as a key-value-map. If there is no comparison for the GUID, the server responds with HTTP code 404.
GET /api/comparison/<GUID>/status
Returns information about the status of the job.
| REQUEST Parameter | Value | Description |
|---|---|---|
format |
html | Defines the type of the response. |
| json (Default) |
| RESPONSE Fields | Value Type | Description |
|---|---|---|
| progress | float | Progress of the job in percent |
| status | string | Current state of the job: |
IDLE |
||
QUEUED |
||
START |
||
COMPARING |
||
PAUSED |
||
FINISHED |
||
CANCELING |
||
CANCELED |
||
ERROR |
||
| error | string | Error message generated by the job, or null if none |
Example Request: json-Format
# Request # Use user:password for authorization GET /api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/status HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u #Response HTTP/1.1 200 OK Content-Type: application/json { "progress" : "76", "status" : "FINISHED", "message" : null }
Example Request: HTML-Format
# Request # Use user:password for authorization GET /api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4?format=html HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u #Response HTTP/1.1 200 OK Content-Type: text/html Progress:100.0% Status:FINISHED Error:No error
Application Example
# Browser access: use the following URL http://127.0.0.1:9900/api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/status # Shell access using curl curl -Lsu <USERNAME>:<PASSWORD> 'http://127.0.0.1:9900/api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/status'
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
