IBM Business Process Manager on Cloud

https://www.ibm.com/docs/en/bpmoc
Admin
IBM Business Process Manager on Cloud is a cloud-based platform for developing, managing, and...
Tokens:19,844
Snippets:151
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Process Designer (Non-Admin)

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=designer-deprecated-reinstalling-desktop-process

This batch file is for installing IBM Process Designer when the user does not have administrative access. Monitor the command window for a success message or an error log file.

```batch
installProcessDesigner_nonadmin.bat
```

--------------------------------

### Install Process Designer (Admin)

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=designer-deprecated-reinstalling-desktop-process

This batch file is used to install IBM Process Designer when the user has administrative access. It's crucial to run this file with elevated privileges by right-clicking and selecting 'Run as Administrator'.

```batch
installProcessDesigner_admin.bat
```

--------------------------------

### Application Management REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Manage enterprise applications created in IBM Integration Designer. This API allows for installing, uninstalling, starting, and stopping applications on a process server in a cloud environment. The caller requires the Operator role and access to the target environment.

```APIDOC
## Application Management REST API

### Description
Use the API to manage enterprise applications that were created in IBM Integration Designer. The API includes resources for installing, uninstalling, starting, and stopping an application on a process server in a cloud environment. The caller must have the Operator role and access to the target environment.

### Method
POST

### Endpoint
/bpm/services/environments/run/applications

### Description
Installs an application on the process server in the production environment.

---

### Method
POST

### Endpoint
/bpm/services/environments/run/applications/application_name/start

### Description
Starts the application that you uploaded.
```

--------------------------------

### Generate Usage Report - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to generate a usage report for a specific metric and reporting period. Requires the Account Administrator role. Accepts query parameters for start day and metric.

```shell
GET /instance/services/reports?start_day=2019-01-01&metric=maximum_concurrent_users
```

--------------------------------

### Install Process Designer to a Different Location (Non-Admin)

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=designer-deprecated-reinstalling-desktop-process

This command installs IBM Process Designer to a specified location when administrative privileges are not available. If the directory path contains spaces, it must be enclosed in quotation marks.

```batch
installProcessDesigner_nonadmin.bat installLocation
```

--------------------------------

### Install Process Designer to a Different Location (Admin)

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=designer-deprecated-reinstalling-desktop-process

This command installs IBM Process Designer to a specified location when administrative privileges are available. The command line must be run with elevated privileges.

```batch
installProcessDesigner_admin.bat D:\IBM\PD
```

```batch
installProcessDesigner_admin.bat "D:\Process Designer\"
```

--------------------------------

### Get OAuth 2.0 Access Token

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=applications-using-oauth-20-based-authentication

Acquires an OAuth 2.0 access token using client credentials (client ID and secret) and service credentials (username and password). The response includes the access token, refresh token, and expiry duration. Invalid credentials will result in a BAD_REQUEST (400) response.

```bash
curl -k -v -X POST -H 'content-type: application/x-www-form-urlencoded' \
-d grant_type=password -d client_id=<clientId> -d client_secret=<clientSecret> \
-d username=<serviceCredId> -d password=<svcCredSecret> \
https://www.bpm.ibmcloud.com/mga/sps/oauth/oauth20/token
```

--------------------------------

### Cloud Operations APIs Overview

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Provides access to the OpenAPI specification and test tool for the REST APIs. You can directly access the OpenAPI specification by calling GET /api/docs.

```APIDOC
## Cloud operations APIs

### Description
Learn about the cloud operations REST APIs that are provided with IBM® Business Process Manager on Cloud.

You can access the OpenAPI specification and test tool for the REST APIs by using a URL with the following format:
```
https://hostname/api/explorer
```

Where `hostname` is the name of your offering instance. For example, `https://vhost123.mycloud.com/api/explorer`. To directly access the OpenAPI specification, you can use the following REST API call:

### Method
GET

### Endpoint
/api/docs

### Description
This call returns a JSON object that contains the OpenAPI specification of the APIs that are enabled on your instance.
```

--------------------------------

### Get OAuth 2.0 Access Token

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=applications-using-oauth-20-based-authentication

Acquire an access token using client credentials (client ID and secret) and service credentials (username and password). This token is used for subsequent API calls.

```APIDOC
## POST /mga/sps/oauth/oauth20/token

### Description
Obtain an OAuth 2.0 access token and refresh token by providing client and service credentials.

### Method
POST

### Endpoint
https://www.bpm.ibmcloud.com/mga/sps/oauth/oauth20/token

### Parameters
#### Query Parameters
- **grant_type** (string) - Required - Specifies the grant type, e.g., `password` or `refresh_token`.
- **client_id** (string) - Required - The client ID for authentication.
- **client_secret** (string) - Required - The client secret for authentication.
- **username** (string) - Required (for `grant_type=password`) - The service username.
- **password** (string) - Required (for `grant_type=password`) - The service password.
- **refresh_token** (string) - Required (for `grant_type=refresh_token`) - The refresh token to obtain a new access token.

### Request Example
```json
{
  "grant_type": "password",
  "client_id": "<clientId>",
  "client_secret": "<clientSecret>",
  "username": "<serviceCredId>",
  "password": "<svcCredSecret>"
}
```

### Response
#### Success Response (201)
- **access_token** (string) - The obtained access token.
- **refresh_token** (string) - The refresh token for obtaining a new access token.
- **scope** (string) - The scope of the token (not supported in this implementation).
- **token_type** (string) - The type of token, usually 'bearer'.
- **expires_in** (integer) - The duration in seconds until the access token expires.

#### Response Example
```json
{
  "access_token": "CJ7yDymDAfSRz03W7zdX",
  "refresh_token": "fGAv2qzuLnM030Brs8KFaIuY1Kd2P87sLFXI85lH",
  "scope": "",
  "token_type": "bearer",
  "expires_in": 1799
}
```

#### Error Response (400)
Returned if client or service credentials are invalid.
```

--------------------------------

### Retrieve Log Types - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to get a list of available log types from workflow servers. Requires the Operator role. No input parameters are needed.

```shell
GET /instance/services/log_types
```

--------------------------------

### Invite New User

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

This endpoint is used to invite a new user to the system. The caller must have the Account Administrator role.

```APIDOC
## POST /instance/services/users

### Description
Invites a new user to the system. Requires Account Administrator role.

### Method
POST

### Endpoint
/instance/services/users

### Parameters
#### Query Parameters
None

#### Request Body
(Details not provided in source text)

### Request Example
```json
{
  "example": "POST /instance/services/users"
}
```

### Response
#### Success Response (200)
(Details not provided in source text)

#### Response Example
```json
{
  "example": "(Success response example not provided)"
}
```
```

--------------------------------

### Retrieve Metrics List - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to retrieve a list of available metrics for the instance. Requires the Account Administrator role. No input parameters are needed.

```shell
GET /instance/services/metrics
```

--------------------------------

### Invite User via REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

This operation allows for inviting a new user to the system. It requires the Account Administrator role and uses an HTTP POST request to the specified endpoint.

```http
POST /instance/services/users
```

--------------------------------

### Manage OAuth Client Credentials - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to manage client credentials for OAuth 2.0 authentication. Requires Account Administrator role. Accepts a JSON object with an ID prefix and an optional description to generate client ID and secret.

```shell
POST /instance/services/credentials/oauth_clients
...
{
  "id_prefix": "loanapp"
  "description": "OAuth credentials for loan application."
}
```

--------------------------------

### Request Environment Restart - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to request a restart of an environment on the instance. Requires the Operator role. The environment name is specified in the URL path.

```shell
POST /bpm/services/environments/dev/restart_requests
```

--------------------------------

### Restart REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Request and retrieve restart requests for an environment. Requires Operator role.

```APIDOC
## POST /bpm/services/environments/{environment}/restart_requests

### Description
Requests a restart of a specified environment.

### Method
POST

### Endpoint
/bpm/services/environments/{environment}/restart_requests

### Parameters
#### Path Parameters
- **environment** (string) - Required - The name of the environment to restart (e.g., 'dev').

### Response
#### Success Response (200)
- **restart_id** (string) - An identifier for the restart request.
- **status** (string) - The status of the restart request.

#### Response Example
```json
{
  "restart_id": "rst-12345abcde",
  "status": "pending"
}
```
```

```APIDOC
## GET /bpm/services/environments/{environment}/restart_requests

### Description
Retrieves a list of active restart requests for a specified environment.

### Method
GET

### Endpoint
/bpm/services/environments/{environment}/restart_requests

### Parameters
#### Path Parameters
- **environment** (string) - Required - The name of the environment to retrieve restart requests for (e.g., 'dev').

### Response
#### Success Response (200)
- **restart_requests** (array) - A list of active restart requests.

#### Response Example
```json
{
  "restart_requests": [
    {
      "restart_id": "rst-12345abcde",
      "status": "in_progress",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Retrieve Active Restart Requests - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to retrieve a list of active restart requests for a specific environment. Requires the Operator role. The environment name is specified in the URL path.

```shell
GET /bpm/services/environments/dev/restart_requests
```

--------------------------------

### Reports REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Retrieve metrics and generate usage reports for the instance. Requires Account Administrator role.

```APIDOC
## GET /instance/services/metrics

### Description
Retrieves a list of available metrics for the instance.

### Method
GET

### Endpoint
/instance/services/metrics

### Response
#### Success Response (200)
- **metrics** (array) - A list of available metric names.

#### Response Example
```json
{
  "metrics": ["maximum_concurrent_users", "cpu_usage", "memory_usage"]
}
```
```

```APIDOC
## GET /instance/services/reports

### Description
Generates a usage report for a specific metric and reporting period.

### Method
GET

### Endpoint
/instance/services/reports

### Parameters
#### Query Parameters
- **start_day** (string) - Required - The start date for the reporting period (YYYY-MM-DD).
- **metric** (string) - Required - The metric for which to generate the report (e.g., 'maximum_concurrent_users').

### Request Example
```
GET /instance/services/reports?start_day=2019-01-01&metric=maximum_concurrent_users
```

### Response
#### Success Response (200)
- **report_data** (object) - The generated report data.

#### Response Example
```json
{
  "report_data": {
    "metric": "maximum_concurrent_users",
    "period": "2019-01-01",
    "value": 150
  }
}
```
```

--------------------------------

### Access Cloud Operations APIs

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=applications-using-oauth-20-based-authentication

Use the obtained access token in the Authorization header to make requests to cloud operations APIs.

```APIDOC
## GET /baw/dev/rest/bpm/wle/v1/user/current

### Description
Access cloud operations APIs by including the access token in the Authorization header.

### Method
GET

### Endpoint
https://<tenantHost>/baw/dev/rest/bpm/wle/v1/user/current

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - The access token in the format `Bearer <access_token>`.

### Request Example
```json
{
  "Authorization": "Bearer CJ7yDymDAfSRz03W7zdX"
}
```

### Response
#### Success Response
Details of the current user.

#### Error Response (302)
Returned if the access token is invalid or has expired.
```

--------------------------------

### Credentials REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Manage client credentials for OAuth 2.0 authentication. Requires Account Administrator role.

```APIDOC
## POST /instance/services/credentials/oauth_clients

### Description
Creates client credentials (client ID and client secret) for OAuth 2.0 based authentication of client applications.

### Method
POST

### Endpoint
/instance/services/credentials/oauth_clients

### Parameters
#### Request Body
- **id_prefix** (string) - Required - A prefix to generate the client ID.
- **description** (string) - Optional - A description to identify the credentials.

### Request Example
```json
{
  "id_prefix": "loanapp",
  "description": "OAuth credentials for loan application."
}
```

### Response
#### Success Response (200)
- **client_id** (string) - The generated client ID.
- **client_secret** (string) - The generated client secret.

#### Response Example
```json
{
  "client_id": "loanapp_a1b2c3d4e5f67890",
  "client_secret": "s3cr3tK3yF0rL0an4pp"
}
```
```

--------------------------------

### Refresh OAuth 2.0 Access Token

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=applications-using-oauth-20-based-authentication

Refreshes an expired OAuth 2.0 access token using a refresh token. This process requires the client ID, client secret, and the refresh token. It returns a new set of access and refresh tokens. Invalid refresh tokens or client credentials will result in a BAD_REQUEST (400) response.

```bash
curl -k -v -X POST -H 'content-type: application/x-www-form-urlencoded' \
-d grant_type=refresh_token -d refresh_token=fGU3UjAHG0XKTdnInU8ihqTLf48XJIzQtRUjNFVo \
-d client_id=<clientId> -d client_secret=<clientSecret> \
https://www.bpm.ibmcloud.com/mga/sps/oauth/oauth20/token
```

--------------------------------

### Cluster Status REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

Retrieve the status of all clusters in each of your environments. The caller must have the Operator role.

```APIDOC
## Cluster Status REST API

### Description
The API includes operations for retrieving the status of all the clusters in each of your environments. The caller must have the Operator role.

### Method
GET

### Endpoint
/bpm/services/environments/run/clusters

### Description
Gets the status of all the clusters in the production environment.
```

--------------------------------

### Request Specific Log Type - REST API

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=operations-cloud-apis

API to request specific log types from workflow servers. Requires the Operator role. Accepts a JSON object specifying the environment and log type.

```shell
POST /instance/services/logs
	...
	{
	  "environment": "dev",
	  "log_type": "AppCluster"
	}
```

--------------------------------

### Access Cloud Operations API with Access Token

Source: https://www.ibm.com/docs/en/bpmoc/index_topic=applications-using-oauth-20-based-authentication

Uses a previously obtained access token to authenticate requests to cloud operations APIs. The access token must be included in the Authorization header as a Bearer token. An invalid or expired access token will result in a 302 response.

```bash
curl -k -v -H "Authorization: Bearer CJ7yDymDAfSRz03W7zdX" https://<tenantHost>/baw/dev/rest/bpm/wle/v1/user/current
```
Tokens:
Raw