Excerpt
hidden true name refinedpageimage
Image Removed
Excerpt
name upgradechecks_restapi_1
Table of Contents minLevel 1 maxLevel 2 outline false type flat separator pipe printable false Status colour Green title DATA CENTER Status colour Purple title Document Activity REST API Status colour Blue title UPGRADE CHECKS REST API Overview There are a number of upgrade checks and pre-upgrade checks REST API endpoints that can be used to retrieve information or run/cancel the pre-upgrade/upgrade checks process for the document activity upgrade. These REST API endpoints are provided for customers and partners to manage and run pre-upgrade checks 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. Pre-upgrade checks REST API endpoints Available in Comala Document Management v6.17+ for data center and server Comala Document Management v7.0+ for data center Upgrade checks REST API endpoints Available ONLY in Comala Document Management v7.0+ for data center

Upgrade and pre-upgrade checks REST API endpoints

Spaces with page activity and current upgrade status

Request a list of spaces with Comala Document Management workflow activity and the current upgrade check status for each space with workflow activity

• Endpoint: http://<confluencehostname>/rest/cw/2/documentactivity/upgrade/report

• Method: GET

Endpoint response is a list of spaces with workflow activity. This JSON object includes

• spacesPreChecks - a list of spaces with data for each space including

  • space name; space key; space home URL; number of pages containing workflow history; total space pages; check details

• metadata - values related to check statistics for the check across the spaces selected

Spaces upgrade check progress status

Request the upgrade process status of a space with page activity.

• Endpoint: http://<confluencehostname>/rest/cw/2/documentactivity/upgrade/status/{spaceKey}

• Method: GET

Endpoint response is a list of space with workflow activity progress check status. This JSON object includes

• spacekey; check status; duration of process time; start date; number of errors; support package URL (if check status is CHECK_FAIL or UPGRADE_FAIL); current phase of check progress

Run spaces upgrade check process

Run the upgrade/pre-upgrade check process for one or more spaces.

• http://<confluencehostname>/rest/cw/2/documentactivity/upgrade/content/run

• Method: POST

The endpoint request is a contentID or an array of space keys

• ["TESTSPACE_1", "TESTSPACE_2",]

Endpoint response is a list of spaces with checks in progress. The JSOn object includes

• spacesPreChecks - check status; start time for check process; progress percentage; space key

Get space upgrade check support package

A way to download the support package zip file for the upgrade check of a named space.

• Endpoint: http://<confluencehostname>/rest/cw/2/documentactivity/upgrade/support/{spaceKey}

• Method: GET

Endpoint response downloads the support package zip file (located in the Confluence local temp directory) for the added space.

Cancel space upgrade check process

Cancel an upgrade/pre-upgrade check task that is in progress for a named space.

• Endpoint: http://<confluencehostname>/rest/cw/2/documentactivity/upgrade/cancel/{spaceKey}

• Method: POST

Endpoint response is

• http 200 (OK) status code - if process has been cancelled

• http 404 (NOT FOUND) status code - if the check process selected was not in the IN_PROGRESS status

...

The following actions can be performed using this REST API:

• Get a list of the spaces that have workflows and their upgrade status

• Get the specific upgrade status of a space

• Run the upgrade or pre-checks of a space

• Cancel a running upgrade or pre-checks execution of a space

• Get the support package zip file of a failing upgrade or pre-checks execution of a space

Upgrade and pre-upgrade checks REST API documentation

...