IBM Cloud Pak for Business Automation

https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0
Admin
IBM Cloud Pak for Business Automation is a comprehensive platform that provides a suite of...
Tokens:3,178,951
Snippets:16,050
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Navigate to CPFS Installer Scripts Directory

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Changes directory to the CPFS installer scripts folder. Requires an absolute path starting from root directory.

```bash
cd <absolute path to files>/cert-kubernetes/scripts/cpfs/installer_scripts/cp3pt0-deployment
```

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

### Install Cert-Manager and License-Manager Services

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Installs cert-manager and license-manager services using the setup_singleton.sh script. Requires license acceptance and version parameters.

```bash
./setup_singleton.sh --license-accept --enable-licensing -v 1 -c v4.2
```

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

### Launch precondition checker with parameters

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=application-validating-preconditions

Example command to launch the precondition checker utility with required parameters. This command connects to Content Platform Engine and checks specified solutions. Requires CEWS URI, username, password, and target object store. Optional parameters include solution name, file input, batch size, and thread pool size.

```bash
preconditionChecker launch -cews_uri http://myserver:9080/wsi/FNCEWS40MTOM 
-username administrator -password mypassword 
-target_os MyTargetOS -solution 'credit card dispute'
```

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

### Example GET Method Response (JSON)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=lair-get-method

This example demonstrates a typical GET method response in JSON format.  It details the structure of the data returned, including the 'Optional' and 'Required' activity lists represented as JSON objects. The FailureReason element is displayed when an activity fails and might not be available in all languages.

```JSON
{
  "Optional": [
    {
      "RequiredState": 0, "TaskState": 3, "DisabledState": 0,
      "LaunchMode": 0, "DateCreated": "2010-07-16T21:50:36Z",
      "TaskId": "{3B5C8E64-43FE-4188-AC72-457A4B8E374C}",
      "TaskName": "ETECase2 Task number 2",
      "DateLastModified": "2010-07-16T21:50:36Z",
      "IsHidden": false,
      "IsContainer": false,
      "ProcessInstanceId": "0907E35E7DC03B4FA03F6B6767633FB2",
      "LastRestartDate": "2010-07-16T21:50:36Z",
      "RestartCount": "1",
      "RosterName": "MySolution1"
    }
  ],
  "Required": [
    {
      "RequiredState": 1, "TaskState": 1, "DisabledState": 0,
      "LaunchMode": 4, "DateCreated":"2010-07-16T21:50:36Z",
      "TaskId": "{CB3F1916-8D03-44C8-9598-23589D9ED78F}",
      "TaskName": "ETECase2 Task number 1",
      "DateLastModified": "2010-07-16T21:50:36Z"
      "IsHidden": false,
      "IsContainer": false,
      "ProcessInstanceId": "0907E35E7DC03B4FA03F6B6767633FB1",
      "LastRestartDate": null,
      "RestartCount": "0",
      "RosterName": "MySolution1"
    }
  ]
}

```

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

### Example of Generating Mirror Manifests and Mirroring

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Demonstrates the `oc ibm-pak generate mirror-manifests` command with specific values and shows the subsequent `oc mirror` command for both curated and non-curated catalogs. It highlights the output structure and the location of generated configuration files.

```bash
oc ibm-pak generate mirror-manifests ibm-cp-automation --version 25.0.0 target_registry/cp4ba2500
# Example output:
ibm-elasticsearch-operator done
ibm-cp-automation done
...
Generating mirror manifests of CASE: ibm-cp-automation, version: 25.0.0 is complete

# To mirror the curated catalog:
oc mirror --config /root/.ibm-pak/data/publish/latest/image-set-config.yaml docker://target_registry/cp4ba2500 --dest-skip-tls --max-per-registry=6

# To mirror the non curated catalog:
oc mirror --config /root/.ibm-pak/data/mirror/ibm-cp-automation/25.0.0/image-set-config.yaml docker://target_registry/cp4ba2500 --dest-skip-tls --max-per-registry=6
```

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

### Get document count on load

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=api-bpm-file-list

This event is triggered when the control is loaded. It is fired only once per page load. The example demonstrates how to call a method to get the document count.

```javascript
me.getDocumentCount()
```

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

### Date Picker On Load Event Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=api-date-picker-deprecated

This example demonstrates how to handle the On Load event for the Date Picker component. It retrieves the date from a variable and sets it as the start date.

```JavaScript
var workerStart = ${StartDate}.getDate();
me.setStart(workerStart);
```

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

### Starting a New Process Instance

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=examples-retrieving-data-from-xml

Demonstrates how to initiate a new process instance programmatically using JavaScript within the IBM Business Automation environment. Requires process name and parameter object as inputs.

```javascript
function startNewProcess(processName, params) {
  var processInstance = tw.system.startProcess(processName, params);
  return processInstance;
}
```

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

### Setup Singleton Services (Private Catalog)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=icpcoi-option-2-installing-cloud-pak-catalog-operator-instances-by-using-pak

This script command sets up singleton services for a private catalog deployment. It specifies the certificate manager and licensing catalog sources, accepts the license, enables licensing, and indicates private catalog mode.

```bash
./setup_singleton.sh --enable-licensing --cert-manager-source ibm-cert-manager-catalog --licensing-source ibm-licensing-catalog --license-accept -v 1 -c v4.2 --enable-private-catalog
```

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

### Start Kafka and ZooKeeper Servers

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=configuration-configuring-event-output-kafka

Shell commands to start the ZooKeeper and Kafka server processes. These commands assume Kafka is installed and the configuration files are located in the `config` directory.

```bash
./bin/zookeeper-server-start.sh config/zookeeper.properties
./bin/kafka-server-start.sh config/server.properties
```

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

### Verify oc Mirror Installation (Bash)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-setting-up-host-mirror-images-private-registry

This command verifies oc mirror installation by showing help. It depends on the binary being in PATH and oc CLI setup. Displays usage, with no limitations specified.

```bash
oc mirror help
```

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

### Create and Apply Service Account for CP4BA Starter Deployment

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=icfcmsd-preparing-starter-deployment

This snippet demonstrates how to create a YAML file defining a Service Account for the CP4BA starter deployment and then apply it to the target namespace. It also shows how to bind security context constraints to the service account.

```yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: ibm-cp4ba-anyuid
imagePullSecrets:
- name: "ibm-entitlement-key"
```

```bash
oc apply -f service-account-for-starter.yaml -n ${NAMESPACE}
```

```bash
oc adm policy add-scc-to-user anyuid \
-z ibm-cp4ba-anyuid -n ${NAMESPACE}
```

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

### POST /std/bpm/containers/install

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=solutions-installing-case-solution-by-using-rest-apis

Installs a case solution container from a snapshot ZIP file. This endpoint requires the CSRF token from login and various parameters to specify the installation details.

```APIDOC
## POST /std/bpm/containers/install

### Description
Uploads and installs a case solution snapshot as a container in IBM BPM, with options for inactivation, design object store, and overwrite settings.

### Method
POST

### Endpoint
/std/bpm/containers/install

### Parameters
#### Request Body (Form Data)
- **BPMCSRFToken** (string) - Required - CSRF token obtained from /system/login
- **install_file** (file) - Required - ZIP file exported for the snapshot
- **inactive** (boolean) - Optional - Deactivates the snapshot after installation (default: false)
- **caseDosName** (string) - Required - Name of the case design object store
- **caseProjectArea** (string) - Optional - Target environment or project area for case artifacts (omit if default is defined)
- **caseOverwrite** (boolean) - Required - Set to true to allow overwriting

### Request Example
(Form data with files not representable as JSON; use multipart/form-data in client)

### Response
#### Success Response (200)
- **message** (string) - Confirmation of installation initiation

#### Response Example
{
  "message": "Installation started successfully"
}
```

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

### GET /std/bpm/containers/{container}/versions/{version}

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=solutions-installing-case-solution-by-using-rest-apis

Checks the installation status of a specific case solution version. Returns 404 until fully installed, then 200 upon success. Useful for polling to determine completion.

```APIDOC
## GET /std/bpm/containers/{container}/versions/{version}

### Description
Retrieves the status of a deployed case solution container version. Use after installing to poll for completion.

### Method
GET

### Endpoint
/std/bpm/containers/{container}/versions/{version}

### Parameters
#### Path Parameters
- **container** (string) - Required - Acronym for the case solution
- **version** (string) - Required - Acronym for the snapshot version being installed

#### Query Parameters
- **BPMCSRFToken** (string) - Required - CSRF token obtained from /system/login

### Request Example
GET /std/bpm/containers/MYCASE/versions/V1.0?BPMCSRFToken=abc123token

### Response
#### Success Response (200)
- **status** (string) - Installation status details

#### Error Response (404)
- **message** (string) - Not found until installation completes

#### Response Example
{
  "status": "installed"
}
```

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

### Install oc Mirror Binary (Bash)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-setting-up-host-mirror-images-private-registry

This snippet relocates the oc mirror binary to the system bin directory and makes it executable. It assumes sudo for non-root users and the binary from extraction. Produces the installed tool in /usr/local/bin, but may face permission restrictions.

```bash
mv oc-mirror /usr/local/bin/oc-mirror
chmod 755 /usr/local/bin/oc-mirror
```

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

### GET /groups

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=resources-groups

Retrieve information about groups that have been defined to the IBM Business Automation Workflow installation.

```APIDOC
## GET /groups

### Description
Retrieves information about groups defined in the IBM Business Automation Workflow installation.

### Method
GET

### Endpoint
/groups

### Parameters
#### Query Parameters
*(No query parameters are specified in the provided text)*

#### Path Parameters
*(No path parameters are specified in the provided text)*

#### Request Body
*(This endpoint does not typically require a request body for a GET operation)*

### Request Example
*(No specific request example provided)*

### Response
#### Success Response (200)
- **groups** (array) - A list of group objects, where each object contains details about a defined group.

#### Response Example
```json
{
  "groups": [
    {
      "id": "group123",
      "name": "Administrators",
      "description": "Users with administrative privileges"
    },
    {
      "id": "group456",
      "name": "Developers",
      "description": "Team members responsible for development"
    }
  ]
}
```
```

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

### GET /v1/groups

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=apis-rest-interface-process-related-resources

Retrieve information about groups that have been defined to the IBM Business Automation Workflow installation.

```APIDOC
## GET /v1/groups

### Description
Retrieve information about groups that have been defined to the IBM Business Automation Workflow installation.

### Method
GET

### Endpoint
.../v1/groups

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria
- **parts** (string) - Optional - Parts to include
- **includeDeleted** (boolean) - Optional - Include deleted groups

### Response
#### Success Response (200)
- **groups** (array) - List of groups
```

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

### Start Service

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=resources-service

Initiates a new instance of a business process service.

```APIDOC
## POST /start

### Description
Use this method to start a service.

### Method
POST

### Endpoint
/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **service_id** (string) - Identifier for the newly started service instance.

#### Response Example
```json
{
  "service_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

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

### GET /v1/users

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=apis-rest-interface-process-related-resources

Retrieve information about users that have been defined to the IBM Business Automation Workflow installation.

```APIDOC
## GET /v1/users

### Description
Retrieve information about users that have been defined to the IBM Business Automation Workflow installation.

### Method
GET

### Endpoint
.../v1/users

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria
- **maxresult** (integer) - Optional - Maximum number of results
- **assignTaskidFilter** (string) - Optional - Assigned task ID filter
- **collabTaskidFilter** (string) - Optional - Collaboration task ID filter
- **includeTaskExperts** (boolean) - Optional - Include task experts
- **sort** (boolean) - Optional - Sort flag
- **includeInternalMemberships** (boolean) - Optional - Include internal memberships
- **namesonly** (boolean) - Optional - Return names only
- **parts** (string) - Optional - Parts to include
- **refreshUser** (boolean) - Optional - Refresh user data
- **includeFilter** (string) - Optional - Include filter

### Response
#### Success Response (200)
- **users** (array) - List of users
```

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

### startUpload

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=api-bpm-file-uploader

Initiates the upload process for the currently selected document.

```APIDOC
## startUpload()

### Description
Starts uploading the document that is currently selected.

### Method
`startUpload`

### Parameters
None

### Request Example
```javascript
myUploadControl.startUpload();
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### POST /start

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=resources-process

Initiates a new Business Process Definition (BPD) instance.

```APIDOC
## POST /start

### Description
Use this method to start a BPD instance.

### Method
POST

### Endpoint
/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*(Specific request body details not provided in source text)*

### Request Example
```json
{
  "message": "Request to start a new BPD instance"
}
```

### Response
#### Success Response (200)
*(Specific success response details not provided in source text)*

#### Response Example
```json
{
  "status": "instance started",
  "instance_id": "generated_id"
}
```
```

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

### XOM Class Example - ShoppingCart

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=members-defining-custom-their-implementation

This is an example of a Java class representing a ShoppingCart in the eXtended Object Model (XOM). It includes methods to get the total value and the number of items, which can be used to derive computed attributes.

```java
// XOM class
public class ShoppingCart  {
  public double getValue() ...
  public int getNumberOfItems() ...
}
```

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

### Java API Context Setup Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=api-example-java-context

This code snippet demonstrates how to establish a `UserContext` and `CaseMgmtContext` in Java for calling IBM Case Manager or Content Platform Engine Java APIs.

```APIDOC
## Java API Context Setup

### Description
This section provides a Java code example demonstrating the setup of `UserContext` and `CaseMgmtContext` required for interacting with IBM Case Manager Java API or Content Platform Engine Java API directly.

### Method
N/A (Code Example)

### Endpoint
N/A (Code Example)

### Parameters
N/A (Code Example)

### Request Example
```java
P8ConnectionCache connCache = new SimpleP8ConnectionCache();
Connection conn = connCache.getP8Connection(CE_URI);
Subject subject = 
    UserContext.createSubject(conn, USER_NAME, 
                              PASSWORD, "FileNetP8WSI");
UserContext uc = UserContext.get();
uc.pushSubject(subject);
Locale origLocale = uc.getLocale();
uc.setLocale(1);
CaseMgmtContext origCmctx = 
    CaseMgmtContext.set(
        new CaseMgmtContext(
            new SimpleVWSessionCache(), connCache()
        )
    );
try {
    // Code that calls the Case Java API or 
    // directly calls the CE Java API
    ...
} finally {
    CaseMgmtContext.set(origCmctx);
    uc.setLocale(origLocale);
    uc.popSubject();
}
```

### Response
#### Success Response
N/A (This is a code setup example, not an API request/response)

#### Response Example
N/A
```

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

### GET /rest/bpm/wle/v1/processApps

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=applications-get

Retrieves the list of process applications installed in the system. Each process app includes metadata such as ID, name, description, and installed snapshots. This endpoint is essential for understanding available process applications and their versions.

```APIDOC
## GET /rest/bpm/wle/v1/processApps

### Description
Retrieves the list of process applications installed in the IBM Business Automation Workflow system. This endpoint provides metadata about each process app including its identifier, name, description, default version, and all installed snapshots.

### Method
GET

### Endpoint
`/rest/bpm/wle/v1/processApps`

### Parameters
#### Query Parameters
- **None** - This endpoint does not accept query parameters

### Request Example
```json
GET /rest/bpm/wle/v1/processApps
Accept: application/json
```

### Response
#### Success Response (200)
Returns a JSON object containing the list of process applications.

**Response Fields:**
- **status** (string) - HTTP status code representation
- **data** (object) - Container for the process applications data
  - **processAppsList** (array) - List of process app objects
    - **ID** (string) - The ProcessApp identifier
    - **shortName** (string) - The ProcessApp short name
    - **name** (string) - The ProcessApp name
    - **description** (string) - The ProcessApp description
    - **defaultVersion** (string) - For Process Center: default workspace name. For Process Server: default snapshot name
    - **installedSnapshots** (array) - List of installed snapshot objects
      - **name** (string) - Snapshot name
      - **acronym** (string) - Snapshot acronym
      - **active** (boolean) - Whether the snapshot is active
      - **activeSince** (string) - Timestamp when snapshot became active (ISO 8601 format)
      - **ID** (string) - Snapshot identifier

#### Response Example
```json
{
  "status": "200",
  "data": {
    "processAppsList": [
      {
        "shortName": "TWP",
        "name": "Process Portal",
        "description": "",
        "defaultVersion": "Main",
        "installedSnapshots": [
          {
            "name": "7.5.0",
            "acronym": "7.5.0",
            "active": true,
            "activeSince": "2011-04-26T18:49:13Z",
            "ID": "2064.64bbda3f-b456-486a-9679-87d81c4366dd"
          }
        ],
        "ID": "2066.23d3ecec-6fdb-4033-9c57-e931aa13761f"
      },
      {
        "shortName": "HSS",
        "name": "Hiring Sample",
        "description": "Hiring Sample",
        "defaultVersion": "Main",
        "installedSnapshots": [
          {
            "name": "Hiring Sample 3",
            "acronym": "HS3",
            "active": true,
            "activeSince": "2011-04-26T18:50:06Z",
            "ID": "2064.30c63e29-aacd-4b3b-803f-a09ce65486d2"
          }
        ],
        "ID": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
      }
    ]
  }
}
```
```

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

### Example Image Set Configuration YAML

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Example YAML configuration for image-set-config.yaml showing available channels. Used to specify which OLM channels to include during image mirroring.

```yaml
- name: ibm-cp4a-operator
      channels:
      - name: v21.3
      - name: v22.1
      - name: v22.2
      - name: v23.1
      - name: v23.2
      - name: v24.0
      - name: v24.1
      - name: v25.0
```

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

### GET /websites/ibm_en_cloud-paks_cp-biz-automation_25_0_0

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=applications-post

Retrieves a list of process applications installed in the system. This endpoint returns detailed information about each process application, including its ID, short name, name, description, default version, and installed snapshots.

```APIDOC
## GET /websites/ibm_en_cloud-paks_cp-biz-automation_25_0_0

### Description
Retrieves a list of process applications installed in the system. This endpoint returns detailed information about each process application, including its ID, short name, name, description, default version, and installed snapshots.

### Method
GET

### Endpoint
/websites/ibm_en_cloud-paks_cp-biz-automation_25_0_0

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **processAppsList** (object[]) - List of process apps installed in the system.
  - **ID** (string) - The ProcessApp identifier.
  - **shortName** (string) - The ProcessApp short name.
  - **name** (string) - The ProcessApp name.
  - **description** (string) - The ProcessApp description.
  - **defaultVersion** (string) - For the Process Center, this is the name of the default workspace. For the Process Server, this is the name of the default snapshot.
  - **installedSnapshots** (object[]) - The list of installed snapshots associated with this ProcessApp.

#### Response Example
```json
{
   "status": "201",
   "data":{
      "processAppsList":[
         {
            "shortName":"HS",
            "name":"Hiring Sample",
            "description":"Hiring Sample",
            "defaultVersion":"Main",
            "installedSnapshots":[
            ],
            "ID":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         }
      ]
   }
}
```
```

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

### POST /v1/service/{instanceId}

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=apis-rest-interface-process-related-resources

Start a service with various optional parameters for configuration and context.

```APIDOC
## POST /v1/service/{instanceId}

### Description
Use this method to start a service.

### Method
POST

### Endpoint
/v1/service/{instanceId}?action={string}[&createTask={boolean}][&parts={string}][&params={string}][&snapshotId={string}][&callerTaskId={string}][&callerModelId={string}][&callerProcessId={string}][&callerModelBranchId={string}][&callerModelSnapshotId={string}]

### Parameters
#### Path Parameters
- **instanceId** (string) - Required - ID of the service instance

#### Query Parameters
- **action** (string) - Required - Action to perform (start)
- **createTask** (boolean) - Optional - Whether to create a task
- **parts** (string) - Optional - Parts to include
- **params** (string) - Optional - Parameters for the service
- **snapshotId** (string) - Optional - ID of the snapshot
- **callerTaskId** (string) - Optional - ID of the calling task
- **callerModelId** (string) - Optional - ID of the calling model
- **callerProcessId** (string) - Optional - ID of the calling process
- **callerModelBranchId** (string) - Optional - ID of the calling model branch
- **callerModelSnapshotId** (string) - Optional - ID of the calling model snapshot

### Response
#### Success Response (200)
- **serviceInstance** (object) - Information about the started service

#### Response Example
{
  "serviceInstance": {
    "id": "instance123",
    "status": "Running",
    "startTime": "2023-10-01T10:00:00Z"
  }
}
```

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

### GET /v1/group/{groupNameOrID}

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=apis-rest-interface-process-related-resources

Retrieve information about a group that has been defined to the IBM Business Automation Workflow installation.

```APIDOC
## GET /v1/group/{groupNameOrID}

### Description
Retrieve information about a group that has been defined to the IBM Business Automation Workflow installation.

### Method
GET

### Endpoint
.../v1/group/{groupNameOrID}

### Parameters
#### Path Parameters
- **groupNameOrID** (string) - Required - Group name or ID

#### Query Parameters
- **parts** (string) - Optional - Parts to include
- **includeDeleted** (boolean) - Optional - Include deleted groups

### Response
#### Success Response (200)
- **group** (object) - Group information
```

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

### Initialize Content Platform Engine and IBM Business Automation Navigator

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0/index_topic=console-configuring-filenet-content-manager

Sets up the automatic initialization of Content Platform Engine and IBM Business Automation Navigator. Requires specific values for LDAP, object stores, and their configurations.

```yaml
initialize_configuration:
  ic_ldap_creation:
    ic_ldap_admin_user_name: "admin"
    ic_ldap_admins_groups_name: "ldap_admins"
  ic_obj_store_creation:
    object_stores:
    - oc_cpe_obj_store_display_name: "My Object Store"
      oc_cpe_obj_store_symb_name: "MOS"
      oc_cpe_obj_store_conn:
        dc_os_datasource_name: "os_datasource"
        dc_os_xa_datasource_name: "os_xa_datasource"
      oc_cpe_obj_store_admin_user_groups: "object_store_admins"
```
Tokens:
Raw