Free cookie consent management tool by TermsFeed

Install Case API Library Module

On This Page

Before you begin

The Case API Library module ships as a separate module supported on Case Management Studio. Once installation and setup are complete, the Case API Library module provides a library of Web API templates that external systems can use to create, update, and retrieve case data in Case Management Studio.

To install the Case API Library module, complete the following steps:

  1. Download the software package.
  2. Import the application.

Before starting the installation process, review the system requirements to make sure all minimum requirements are met.

System requirements

Your system must meet the following minimum requirements to run the Case API Library module:

  • Appian version 26.3 or greater.
  • An Appian Cloud environment with the advanced or premium platform tiers.
  • A supported web browser.
  • Imported Case Management Studio Base application version 2.3 or higher, which includes the following application containers:
    • CMGT Case Management Studio Base (CMGT)
    • CMGT Control Panel Generated Objects (CMGT)

Step 1: Download the software package

The first step in installing the Case API Library module is to download the software package that contains the following files:

  • CaseWebApiModulev2.3.0.zip
  • CaseWebApiModulev2.3.0.properties

To download the software package:

  1. In My Appian, navigate to the Support tab.
  2. Select DOWNLOADS > SOLUTIONS.
  3. In the grid, find and click Case Management Studio.
  4. Under Downloads, click Case API Library and agree to the License Agreement.
  5. Click Case API Library to download the ZIP file.
  6. Unzip the downloaded file to access the installation files.

Step 2: Import the application

Next, import the application into the target environment.

To import the application:

  1. In the target environment, sign in as the deployment user.
  2. Navigate to Appian Designer.
  3. Click IMPORT.
  4. Click UPLOAD and choose the CaseWebApiModulev2.3.0.zip file downloaded in step 1.
  5. Select the Include related import customization file checkbox and click UPLOAD. Select the CaseWebApiModulev2.3.0.properties file downloaded in step 1.
  6. Click INSPECT to ensure that there are no complications on import.

  7. Click IMPORT.

    Note:  The import may time out due to file size, but it will continue in the background.

  8. Review the import results to verify the CMGT Add-On - Case API Library (CMGT_API) application container was imported.

Next steps

Now that you have installed the Case API Library module, follow the steps in Setting Up the Case API Library to configure authentication and begin using the API endpoints with your external systems.

Feedback