{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Unpublishing
Revoke access for non-owner users to the given comparison
GET /api/comparison/<GUID>/unpublish
Revokes access to the specified comparison.
REQUEST Parameter | Value | Description |
---|---|---|
format |
html | Defines the type of the response. |
json (Default) |
RESPONSE Fields | Value Type | Description |
---|---|---|
isPublic |
boolean | TRUE, if published |
sharedLink |
URL | Share-URL of the comparison |
Example Request: json-format
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/unpublish?format=json HTTP/1.1 Accept: application/json Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: application/json { "isPublic" : false, "sharedLink" : "http://myserver.com/comparison/3lw250npgu9903b4nwp6mzr6k" }
Example Request: plain-format
# Request # Use user:password for authorization GET /api/comparison/3lw250npgu9903b4nwp6mzr6k/unpublish HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK
Application Example
# Browser access: use the following URL http://127.0.0.1:9900/api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/unpublish # Shell access using curl curl -Lsu <USERNAME>:<PASSWORD> 'http://127.0.0.1:9900/api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/unpublish'