AdminResource Resource

Resource for various tasks used by the administrator (like retrieving version numbers)

GET /admin/version

Get the current version of the REST API on the server

Response Body
media type data type description
application/json VersionResponse (JSON) VersionResponse

Example

Request
GET /admin/version
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "version" : "...",
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "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" : "NOTFOUND",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /admin/features/{name}

Get info about a feature activation

Request Parameters
name type description
name path name of the feature
Response Body
media type data type description
application/json FeatureResponse (JSON) feature response

Example

Request
GET /admin/features/{name}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "activated" : true,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /admin/tools

Get the tools, that shall be shown in the UI

Response Body
media type data type description
application/json ToolsResponse (JSON) list of tools

Example

Request
GET /admin/tools
Accept: application/json

              
Response
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" : "NEUTRAL",
    "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" : "AUTHREQUIRED",
    "responseMessage" : "...",
    "property" : "..."
  }
}