This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

DATA CENTER DOCUMENT ACTIVITY REST API 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.

A document activity REST API is also available to retrieve workflow document activity information

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

Upgrade checks REST API endpoints

Available ONLY in

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

The check details includes details of the check process including space key; check progress; check status; duration of check process; start date of check; number of errors; support package url (if errors); check phase

  • 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}

Leave {spaceKey} blank to retrieve the progress status of all spaces with page activity.

  • Method: GET

If the progress status returned for a space is CHECK_FAIL, the action supplies a URL to download the space check support package

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.

The space must have an upgrade check process CHECK_FAIL status to get the support package.

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

Upgrade and pre-upgrade checks REST API documentation

The upgrade and pre-upgrade checks REST API is available as Open API (Swagger) Documentation.

This includes details of the JSON objects and response examples.

  • No labels