{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Info
Returns a list of user specific details. The result can be requested in the format either HTML or JSON.
GET /api/comparison/info
Requests a list of user specific details.
| REQUEST Parameter | Value | Description |
|---|---|---|
format |
html | Defines the type of the response. |
| json (Default) |
| RESPONSE Fields | Value Type | Description |
|---|---|---|
username |
string | Username of the currently logged in user |
comparisons |
number | Number of currently saved comparisons for the user |
maxcomparisons |
number | Number of maximum comparisons allowed for the user |
space |
number | Harddisk space used by the user |
maxspace |
number | Maximum harddisk space allowed for the user |
maxpagesperdocument |
number | Maximum number of pages allowed for a single document |
profiles |
number | Number of profiles available for the user |
visiblesettings |
object | Settings of element type visibility |
colorsettings |
object | Settings of element type color |
Visibility
| RESPONSE Fields | Value Type | Description |
|---|---|---|
type |
string | Settings for the visibility. These options are the same for the comparison and the export
ONLYPAGESWITHDIFFS COMMENTS HEADER FOOTER SCALETOPAGEHEIGHT |
visible |
boolean | Whether elements of this type are visible |
Colors
| RESPONSE Fields | Value Type | Description |
|---|---|---|
type |
string | Settings for the visibility. These options are the same for the comparison and the export
AddedOrRemoved Replaced Modified MetadataChanged ALLOUTLINEMARKER all visibility filter |
visible |
boolean | Whether elements of this type are visible |
color |
string | Color the differences |
Example Request
# REQUEST # Use user:password for authorization GET /api/comparison/info?format=json HTTP/1.1 Accept: application/json Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
Example Response
# RESPONSE HTTP/1.1 200 OK Content-Type: application/json { "username":"developer", "comparisons": 152, "maxcomparisons": 500, "space": 90997818, "maxspace": 500, "maxpagesperdocument":0, "profiles":6, "visiblesettings":[{"type":"COMMENTS","visible":true}, {"type":"CREATE_DIFFIMAGES_FIRST","visible":false}, {"type":"CREATE_DIFFIMAGES_SECOND","visible":false}, {"type":"CREATE_ORIGIMAGES","visible":false}, {"type":"CREATE_XORIMAGES","visible":false}, {"type":"FOOTER","visible":true}, {"type":"HEADER","visible":true}, {"type":"HEADERFOOTER","visible":false}, {"type":"ONLYPAGESWITHDIFFS","visible":false}, {"type":"ONLY_ON_DIFFERENCES","visible":false}, {"type":"SCALETOPAGEHEIGHT","visible":false}], "colorsettings":[{"type":"ALLOUTLINEMARKER","visible":true,"color":"#0000ffff"}, {"type":"AddedOrRemoved","visible":true,"color":"#ff000028"}, {"type":{"filterName":"BASELINETABLE"},"visible":false,"color":"#ffc800ff"}, {"type":{"filterName":"BIDI"},"visible":false,"color":"#ffffffff"}, {"type":{"filterName":"CMAPPATCH"},"visible":false,"color":"#ffffffff"}, {"type":{"filterName":"HEADERFOOTER"},"visible":false,"color":"#808080ff"}, {"type":{"filterName":"HIDEROTATEDTEXT"},"visible":false,"color":"#ffffffff"}, {"type":{"filterName":"INVISIBLEELEMENTS"},"visible":false,"color":"#0000c080"}, {"type":{"filterName":"MULTICOLUMN"},"visible":false,"color":"#00b200ff"}, {"type":"MetadataChanged","visible":true,"color":"#0080c428"}, {"type":"Modified","visible":true,"color":"#00993c64"}, {"type":{"filterName":"OCR"},"visible":false,"color":"#ffffffff"}, {"type":{"filterName":"PAGERANGE"},"visible":false,"color":"#4b0082ff"}, {"type":{"filterName":"REGEXP"},"visible":true,"color":"#ff00ff20"}, {"type":"Replaced","visible":true,"color":"#ffaa0050"}, {"type":{"filterName":"TEXTTRANSFORM"},"visible":false,"color":"#ffffffff"}] }
Application Example
# Browser access: use the following URL http://127.0.0.1:9900/api/comparison/info # Shell access using curl curl -Lsu <USERNAME>:<PASSWORD> 'http://127.0.0.1:9900/api/comparison/info'
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
