{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
Profiles
Returns a list of the available profiles. This will include all global profiles (default and shared profiles from other users) as well as the custom profiles of the user. The result can be requested in the format either HTML or JSON.
GET /api/comparison/profiles
Requests a list of the available comparison profiles.
| REQUEST Parameter | Value | Description |
|---|---|---|
format |
html | Defines the type of the response. |
| json (Default) |
| RESPONSE Fields | Value Type | Description |
|---|---|---|
| profileID | string | A unique id for the profile |
| name | string | The name of the profile |
Example Request
# REQUEST # Use user:password for authorization GET /api/comparison/profiles?format=json HTTP/1.1 Accept: application/json Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # RESPONSE HTTP/1.1 200 OK Content-Type: application/json [ { "profileID": "continuous000000000000000", "name": "Continuous document" }, { "profileID": "paged00000000000000000000", "name": "Page by page comparison" }, { "profileID": "textonly00000000000000000", "name": "Text only" }, { "profileID": "textandstyles000000000000", "name": "Text with styles" }, { "profileID": "pagedlocation000000000000", "name": "Verify identity" } ]
Application Example
# Browser access: use the following URL http://127.0.0.1:9900/api/comparison/profiles # Shell access using curl curl -Lsu <USERNAME>:<PASSWORD> 'http://127.0.0.1:9900/api/comparison/profiles'
