Page Comparison

...

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

...

• name: space name

...

• key: space key

...

• home: space home url

...

• numPagesWithHistory: number of space pages that contains workflow history

...

• totalPages: total space pages

...

• pre-check: object representing the space pre-check process

...

• status: upgrade check process status. Possible values

  • NOT_RUN

  • IN_PROGRESS

  • SUCCESS

  • FAIL

• duration: space upgrade check process spent time. Only available if the status is SUCCESS or FAIL

• startedAt: date when the last space upgrade check process started. Only available when the status is SUCCESS, FAIL or IN PROGRESS

• numErrors: number of pages that failed in the last space upgrade check process. Only available if the status is FAIL

• support: url to download the space upgrade check support package Only available if the status is FAIL

...

metadata

Metadata values related to upgrade statistics

...

• highestNumPagesWithWorkflowPerSpace: highest number of pages with a workflow of all spaces with workflow history

...

• totalPagesWithHistory: total number of pages with workflow history

...

• home: space home url

...

• totalSpaces: total number of Confluence spaces checked

...

• totalSpacesWithHistory: total number of spaces with workflow

...

• totalUpgradeSpacesChecked: total number of spaces with page activity that the upgrade check process has checked

...

• medianPagesWithWorkflowPerSpace: median of pages with workflow history of all spaces with workflow history

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:

...

• key: space key

...

• status: upgrade check process status. Possible values

  • NOT_RUN

  • IN_PROGRESS

  • SUCCESS

  • FAIL

...

• duration: space upgrade check process spent time. Only available if the status is SUCCESS or FAIL

...

• startedAt: date when the last space upgrade check process started. Only available when the status is SUCCESS, FAIL or IN PROGRESS

...

• numErrors: number of pages that failed in the last space upgrade check process. Only available if the status is FAIL

...

• support: url to download the space upgrade check support package Only available if the status is FAIL

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

...

• status: initial upgrade check process status value of IN_PROGRESS

...

• startedAt: process start time

...

• key: space key

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.

• OpenAPI (Swagger) Documentation - Upgrade and pre-upgrade checks REST API endpoints