AdminResource Resource

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

GET /admin/actionlog

Get the action log

Request Parameters
name type description default constraints multivalued
action query List of action names for filtering     yes
end query End timestamp for filtering   int no
objId query Object ID for filtering   int no
page query Returned page, if paging is used. Paging starts with 1 1 int no
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int no
start query Start timestamp for filtering   int no
type query List of object type names for filtering     yes
user query Search string for filtering by user. The string may be contained in the firstname, lastname or login of the user.     no
Response Codes
code condition
200 Action log is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ActionLogEntryList (JSON) response containing log entries

Example

Request
GET /admin/actionlog
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deletetemplates", "inheritance" ],
    "property2" : [ "view", "deletetemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/errorlog

Get error log

Request Parameters
name type description default constraints
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
Response Codes
code condition
200 Error log is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ErrorLogEntryList (JSON) response containing list of logged errors

Example

Request
GET /admin/errorlog
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "updateform", "createtemplates" ],
    "property2" : [ "setperm", "formreport" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /admin/maintenance

Set or unset the maintenancemode, including the maintenance message. When the maintenance mode is enabled, all other sessions will be invalidated.

Request Body
media type data type description
application/json MaintenanceModeRequest (JSON) request
Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
200 Maintenance mode has been changed
Response Body
media type data type description
application/json MaintenanceResponse (JSON) response

Example

Request
POST /admin/maintenance
Content-Type: application/json
Accept: application/json

                
{
  "maintenance" : true,
  "banner" : true,
  "message" : "..."
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "maintenance" : true,
  "banner" : true,
  "message" : "...",
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/publicKey

Get the public server key as JWK

Response Codes
code condition
200 Public Key is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json object (JSON) Public server key as JWK

Example

Request
GET /admin/publicKey
Content-Type: */*
Accept: application/json

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

                
{
  "kty" : "RSA",
  "e" : "AQAB",
  "use" : "sig",
  "kid" : "a9eb8baa-801e-4802-be20-f04aeda1efa0",
  "n" : "6UiLZTzmDC1tAVh0hdA3yGx1eLAc5Ybg9ClgeJk1cZn-OzTHZCT5GT58UF1y4AR-dMqqLybzOTvV-BdwVcLh92S1p_mpl-1rZOSsdATDuwH72EpLg5dSvTq520Ju3MbBJn_JkZWVRkhWBctRR6W0qWYkK8ecg67knKzOwOng8z3IRISOgPSZ3JS0eaZzSIfRnqIvh5ZBt3AuX-P0QH_S9FQYUqD2lY7OoRDPtCeCVaDi5blZPT_X_u0M1n0qJdw1MjPIIJJzeJmKslxBuenHPqlpuofZ9s53VJ2dqkB--UA5k2XTUUwrhoKhYBhV3pdaCPIiIWTmCN2kweHrPJ14mw"
}

GET /admin/publishInfo

Get information of the current publish process. Since collecting the statistics may be resource intensive, this is not done during this request but the statistics are collected in a background job. The delay between the jobs can be configured with the variable $PUBLISH_QUEUE_STATS["refresh_delay"] and defaults to 60000 milliseconds (one minute).

Response Codes
code condition
200 Requested data is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json PublishInfoResponse (JSON) publish info response

Example

Request
GET /admin/publishInfo
Content-Type: */*
Accept: application/json

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

                
{
  "failed" : false,
  "lastFailed" : 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
  },
  "forms" : {
    "toPublish" : 158,
    "delayed" : 0,
    "published" : 22,
    "remaining" : 136
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/tools

Get the tools, that shall be shown in the UI

Response Codes
code condition
200 Requested data is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ToolsResponse (JSON) list of tools

Example

Request
GET /admin/tools
Content-Type: */*
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" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/updates

Get available updates

Response Codes
code condition
200 Requested data is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json UpdatesInfoResponse (JSON) response containing available updates

Example

Request
GET /admin/updates
Content-Type: */*
Accept: application/json

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

                
{
  "available" : [ "5.34.23", "5.35.6" ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/version

Get the current version of the REST API on the server

Apart from the CMS version a map with version information about CMP components for each node will be included.

Response Codes
code condition
200 Requested data is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json VersionResponse (JSON) VersionResponse

Example

Request
GET /admin/version
Content-Type: */*
Accept: application/json

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

                
{
  "version" : "5.38.0",
  "cmpVersion" : "7.9",
  "nodeInfo" : {
    "property1" : {
      "meshVersion" : "...",
      "portalType" : "...",
      "portalVersion" : "...",
      "compatibility" : "NOT_SUPPORTED"
    },
    "property2" : {
      "meshVersion" : "...",
      "portalType" : "...",
      "portalVersion" : "...",
      "compatibility" : "NOT_SUPPORTED"
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/actionlog/actions

Get the actions, which are logged.
The result can be filtered by

  • name
  • label
and sorted by
  • name
  • label

Request Parameters
name type description default constraints
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name  
Response Codes
code condition
200 Action log actions are returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ActionModelList (JSON) response containing a list of actions

Example

Request
GET /admin/actionlog/actions
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "importitems", "userassignment" ],
    "property2" : [ "create", "delete" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/actionlog/types

Get the object types, that are logged.
The result can be filtered by

  • name
  • label
and sorted by
  • name
  • label

Request Parameters
name type description default constraints
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name  
Response Codes
code condition
200 Action log types are returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ActionLogTypeList (JSON) response containing a list of object types

Example

Request
GET /admin/actionlog/types
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "linktemplates", "createtemplates" ],
    "property2" : [ "updateform", "publishform" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /admin/config/reload

Reload the configuration

Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
PUT /admin/config/reload
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/content/dirtqueue

Get the sorted list of dirt queue entries

Request Parameters
name type description default constraints
end query End timestamp for filtering   int
failed query True for returning only failed entries, false for returning not failed entries, null for returning all entries.   boolean
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
start query Start timestamp for filtering   int
Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
200 The dirt queue entry list is returned.
Response Body
media type data type description
application/json DirtQueueEntryList (JSON) response containing a list of dirt queue entries

Example

Request
GET /admin/content/dirtqueue
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "createitems", "createtemplates" ],
    "property2" : [ "deletetemplates", "inheritance" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/content/publishqueue

Get publish queue information. Since collecting the statistics may be resource intensive, this is not done during this request but the statistics are collected in a background job. The delay between the jobs can be configured with the variable $PUBLISH_QUEUE_STATS["refresh_delay"] and defaults to 60000 milliseconds (one minute).

Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
200 The publish queue information is returned.
Response Body
media type data type description
application/json PublishQueueResponse (JSON) response containing object counts per node and type

Example

Request
GET /admin/content/publishqueue
Content-Type: */*
Accept: application/json

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

                
{
  "nodes" : {
    "property1" : {
      "files" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "folders" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "forms" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "pages" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      }
    },
    "property2" : {
      "files" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "folders" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "forms" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      },
      "pages" : {
        "toPublish" : 158,
        "delayed" : 0,
        "published" : 22,
        "remaining" : 136
      }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /admin/content/publishqueue

Perform a maintenance action on the publish queue

Request Body
media type data type description
application/json ContentMaintenanceActionRequest (JSON) maintenance action request
Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
200 The content maintenance action is queued.
400 No request body was sent.
400 Not all required fields had non-null values.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
POST /admin/content/publishqueue
Content-Type: application/json
Accept: application/json

                
{
  "action" : "markPublished",
  "types" : [ "form", "page" ],
  "clearPublishCache" : true,
  "attributes" : [ "...", "..." ],
  "nodes" : [ 12345, 12345 ],
  "contentRepositories" : [ 12345, 12345 ],
  "start" : 12345,
  "end" : 12345
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/features/{name}

Get info about a feature activation

Request Parameters
name type description
name path name of the feature
Response Codes
code condition
200 Requested data is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json FeatureResponse (JSON) feature response

Example

Request
GET /admin/features/new_tageditor
Content-Type: */*
Accept: application/json

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

                
{
  "name" : "new_tageditor",
  "activated" : true,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /admin/content/dirtqueue/summary

Get a sorted summary of current dirt queue entries

Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
200 The dirt queue summary is returned.
Response Body
media type data type description
application/json DirtQueueSummaryResponse (JSON) response containing a sorted summary

Example

Request
GET /admin/content/dirtqueue/summary
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "update", "updateconstructs" ],
    "property2" : [ "read", "read" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /admin/content/dirtqueue/{id}

Delete the failed dirt queue entry with given ID

Request Parameters
name type description constraints
id path entry ID required int
Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
204 The dirt queue entry has been deleted.
404 Dirt queue entry {id} was not found.
409 Dirt queue entry {id} could not be deleted, because it is not marked 'failed'.
Response Body
media type data type description
application/json object (JSON) empty response

Example

Request
DELETE /admin/content/dirtqueue/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

PUT /admin/content/dirtqueue/{id}/redo

Repeat the failed dirt queue entry with given ID

Request Parameters
name type description constraints
id path entry ID required int
Response Codes
code condition
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
204 The dirt queue entry has been refreshed, so that it will be repeated.
404 Dirt queue entry {id} was not found.
409 Dirt queue entry {id} could not be repeated, because it is not marked 'failed'.
Response Body
media type data type description
application/json object (JSON) empty response

Example

Request
PUT /admin/content/dirtqueue/{id}/redo
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...