Resource for various tasks used by the administrator (like retrieving version numbers)
Get information of the current publish process
code | condition |
---|---|
200 | Requested data is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | PublishInfoResponse (JSON) | publish info response |
GET /admin/publishInfo Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"failed" : false,
"progress" : 38,
"estimatedDuration" : 128,
"running" : true,
"totalWork" : 1325,
"totalWorkDone" : 503,
"phase" : "...",
"files" : {
"toPublish" : 158,
"delayed" : 0,
"published" : 22,
"remaining" : 136
},
"folders" : {
"toPublish" : 158,
"delayed" : 0,
"published" : 22,
"remaining" : 136
},
"pages" : {
"toPublish" : 158,
"delayed" : 0,
"published" : 22,
"remaining" : 136
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the tools, that shall be shown in the UI
code | condition |
---|---|
200 | Requested data is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
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" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get available updates
code | condition |
---|---|
200 | Requested data is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | UpdatesInfoResponse (JSON) | response containing available updates |
GET /admin/updates Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"available" : [ "5.34.23", "5.35.6" ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the current version of the REST API on the server
code | condition |
---|---|
200 | Requested data is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
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" : "5.35.6",
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get info about a feature activation
name | type | description |
---|---|---|
name | path | name of the feature |
code | condition |
---|---|
200 | Requested data is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FeatureResponse (JSON) | feature response |
GET /admin/features/new_tageditor Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "new_tageditor",
"activated" : true,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}