These REST API endpoints are provided for customers and partners to manage and run upgrade checks. It is recommended that partners have an appropriate level of scripting expertise and knowledge.
Global administrator permissions are required to use these endpoints.
Applicable | Comala Document Management v6.17+ for data center and server |
|---|
Comala Document Management has the following upgrade checks reporting actions available with corresponding REST API endpoints.
These REST API endpoints are used to populate the data in the Document Activity Upgrade console in Comala Document Management global administration.
Request list of spaces with page activity and upgrade check status
Comala Document Management upgrade REST API provides a way to request a list of spaces with Comala Document Management workflow page activity and the current upgrade check status for each space with page activity.
Endpoint Definition
Endpoint URL
/rest/cw/2/documentactivity/upgrade/report
Endpoint method
GET
Endpoint response
A JSON object with the following content:
spacesPreChecks List of space upgrade checks and data for each space |
| |
| ||
| ||
| ||
| ||
|
| |
metadata Metadata values related to upgrade statistics |
| |
| ||
| ||
| ||
| ||
| ||
| ||
Response example
List of spaces with workflow activity
{
"spacesPreChecks": [
{
name: "Test Space",
key: "TEST",
home: "/display/TEST/test"
numPagesWithHistory: 5,
totalPages: 18,
pre-check: {
status: "FAIL",
duration: "2 hours 25 minutes",
startedAt: "2021-02-03 14:56:23",
numErrors: 2,
support: "/rest/cw/2/documentactivity/upgrade/support/TEST"
}
},
{
...
},
...
]
"metadata":{
"highestNumPagesWithWorkflowPerSpace": 40,
"totalPagesWithHistory": 40
"totalSpaces": 3
"totalSpacesWithHistory": 1
"totalUpgradeSpacesChecked": 1
"medianPagesWithWorkflowPerSpace": 0
}
}
Get spaces upgrade check progress status
Comala Document Management upgrade REST API provides a way to request the upgrade check process status of a space with page activity.
If the upgrade check process status returned for a space is FAIL, the action supplies a URL to download the space upgrade check support package.
Endpoint Definition
Endpoint URL
/rest/cw/2/documentactivity/upgrade/prechecks/{SPACEKEY}
Replace SPACEKEY with the space key value. Leave blank if require progress status of all spaces with page activity.
Endpoint method
GET
Endpoint response
A JSON object with the following content:
|
|
|
|
|
|
Response example
Space upgrade check process with FAIL status
{
key: "TEST"
status: "FAIL",
startedAt: "2022-02-01 14:55:22",
duration: "2 hours 2 minutes",
numErrors: 2,
progress: 100,
support: "/rest/cw/2/documentactivity/upgrade/support/TEST"
}
Run spaces upgrade check process
Comala Document Management upgrade REST API provides a way to run the upgrade check process for one or more spaces.
Endpoint Definition
Endpoint URL
/rest/cw/2/documentactivity/upgrade/prechecks
The upgrade check status will be returned for spaces defined in the endpoint request below.
Endpoint method
POST
Endpoint request
An array of space keys - Space upgrade check runs
["TEST_1", "TEST_2"]
Endpoint response
A JSON object representing the list of space upgrade processes started
spacesPreChecks List of space upgrade checks, for each one |
|
| |
| |
|
Response example
Upgrade checks process completion process
{
"spacesPreChecks": [
{
"status": "IN_PROGRESS",
"startedAt": 1658391152475,
"progress": 0,
"key": "TEST_1"
},
{
"status": "IN_PROGRESS",
"startedAt": 1658391152489,
"progress": 0,
"key": "TEST_2"
}
]
}
Get space upgrade check support package
Comala Document Management upgrade REST API provides a way to download the support package zip file for the upgrade check of a named space.
Endpoint Definition
Endpoint URL
/rest/cw/2/documentactivity/upgrade/support/{SPACEKEY}
Replace SPACEKEY with the space key value.
Endpoint method
GET
Endpoint response
The response downloads the support package zip file (located in the confluence local temp directory) for the upgrade check of the space provided.
💛 The space must have an upgrade check process FAIL status.