Resource for various tasks used by the administrator (like retrieving version numbers)
Get the current version of the REST API on the server
media type | data type | description |
---|---|---|
application/json | VersionResponse (JSON) | VersionResponse |
GET /admin/version Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"version" : "...",
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}
Get info about a feature activation
name | type | description |
---|---|---|
name | path | name of the feature |
media type | data type | description |
---|---|---|
application/json | FeatureResponse (JSON) | feature response |
GET /admin/features/{name} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"activated" : true,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "MAINTENANCEMODE",
"responseMessage" : "...",
"property" : "..."
}
}
Get the tools, that shall be shown in the UI
media type | data type | description |
---|---|---|
application/json | ToolsResponse (JSON) | list of tools |
GET /admin/tools Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"tools" : [ {
"id" : 12345,
"key" : "...",
"name" : {
"property1" : "...",
"property2" : "..."
},
"toolUrl" : "...",
"iconUrl" : "...",
"newtab" : true
}, {
"id" : 12345,
"key" : "...",
"name" : {
"property1" : "...",
"property2" : "..."
},
"toolUrl" : "...",
"iconUrl" : "...",
"newtab" : true
} ],
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "MAINTENANCEMODE",
"responseMessage" : "...",
"property" : "..."
}
}