Installing a case solution by using REST APIs

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
Installing a case solution on a production server or Workflow Server makes it a runnable application.

Before you begin

Export the installation package file that will be installed on the Workflow Server by completing the following steps:
  1. In Business Automation Studio, click Case Solutions and then click the View details icon of the case solution you want to install.
  2. On the Versions tab, click the export link of the version.
  3. Select the IBM® Business Automation Workflow Installation Package (.zip) option and then click Export.
The browser will download the installation package file.

Procedure

The following steps use the IBM BPM Explorer ops to run the installation by using REST APIs, although you can use any REST client to run the APIs:

  1. Go to IBM BPM Explorer ops on https://host_name:port_number/ops/explorer. The server address must be the URL of Workflow Server.
  2. Under System, run the POST /system/login REST API with the login_request parameter, using the example values.
    For more information, see the REST APIs reference.
  3. Click Try it out to run the REST API.
  4. Under Container, run the POST /std/bpm/containers/install REST API with these parameters:
    • BPMCSRFToken - The value returned from the /system/login call.
    • install_file - The .zip file you exported for your snapshot.
    • inactive - Deactivates the snapshot after you install it. This parameter is false by default.
    • caseDosName - The name of the case design object store. You can get this from your administrator.
    • caseProjectArea - The target environment or project area for case artifacts. You can omit this value if the default project area is defined. You can get this from your administrator.
    • caseOverwrite - Set this parameter to true.
  5. Click Try it out to run the REST API.
  6. To determine when the case solution has been installed, run the GET /std/bpm/containers/{container}/versions/{version} REST API with these parameters:
    • BPMCSRFToken - The value returned from the /system/login call.
    • container - The acronym for the case solution.
    • version - The acronym for the snapshotversion being installed.

  7. Click Try it out to run the REST API.

Results

Until the case solution is installed, the GET /std/bpm/containers/{container}/versions/{version} REST API returns only 404 messages. After the case solution is installed, the GET /std/bpm/containers/{container}/versions/{version} REST API returns a 200 message.