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

Upgrade and Pre-Upgrade checks REST API endpoints

Owned by Robert Alexander Marshall
Last updated: Sept 27, 2023
2 min read
1 Overview

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.

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

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

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.

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