IBM Case Manager

https://www.ibm.com/docs/en/case-manager
Admin
IBM Case Manager is an enterprise software solution designed to help organizations manage and...
Tokens:1,050,058
Snippets:7,533
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET Request Example for Case Types

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=lctr-get-method

This example demonstrates how to make a GET request to retrieve a list of case types for a specific deployed solution. It specifies the solution name and the target object store. The request includes standard HTTP headers like Host.

```http
GET http://example.com:9080/CaseManager/CASEREST/v1/solution/Auto+Claims
/casetypes?TargetObjectStore=MyTOS HTTP/1.1
Host: www.example.net
```

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

### Start IBM Case Manager Configuration Tool on Windows

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=deployment-running-development-environment-configuration-tasks

This command starts the IBM Case Manager configuration tool on a Windows operating system. Alternatively, you can launch it from the Start menu. '_install_path' refers to the installation directory, e.g., 'C:\Program Files\IBM\CaseManagement'.

```batch
@echo off
_install_path\configure\configmgr.exe
```

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

### Example GET Request for Case Tasks

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=ltir-get-method

This example demonstrates how to make a GET request to retrieve a list of tasks for a given case folder. It specifies the case folder ID, the target object store, and the grouping parameter for tasks.

```HTTP
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/9E45A997-0E42-406E-AAC4-EE55D8BCF2ED/tasks
?TargetObjectStore=MyExampleObjectStore&Grouping=ROD
HTTP/1.1
Host: www.CaseMgmtExample.net
```

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

### List Case Types GET Request Example (HTTP)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=lctr-get-method

This snippet demonstrates an HTTP GET request and its successful JSON response, detailing the available case types for a deployed solution. It includes the response status, content type, and a structured list of case types with their properties.

```HTTP
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "CaseTypes":
  [
    {
      "CaseType": "AUTO_CollisionClaim",
      "DisplayName": "Collision Claim",
      "Description": "process a collision claim"
      "HasInstanceCreationRights": true,
      "HasAnnotationRights": true
    },
    {
      "CaseType": "AUTO_LiabilityClaim",
      "DisplayName" : "Liability Claim",
      "Description": "process a liability claim"
      "HasInstanceCreationRights": true,
      "HasAnnotationRights": true
    },
    ...
  ]
}
```

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

### Example: Generate Configuration for Production1 Profile

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=cpebucl-configuring-additional-object-stores-production-environment-by-using-command-line

This example demonstrates generating a configuration file for the 'Production1' profile.

```bash
configmgr_cl generateConfig \
 -task configcmos \
 -profile Production1
```

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

### Start Security Directory Server

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=system-starting-your

Starts the IBM Security Directory Server. This involves changing to the server's binary directory and then executing the start command with connection parameters.

```bash
cd /opt/ibm/ldap/V6.3/bin
./ibmdirctl -h localhost -D cn=root -w password start
```

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

### Start IBM Content Manager Configuration Wizard

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=manager-resetting-test-environment-content

This command starts the IBM Content Manager configuration wizard, which is used to add or modify configurations for various components. Ensure you are logged in as the root user. The IBMCMROOT variable specifies the installation directory.

```Shell
IBMCMROOT/bin/config_CM
```

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

### Create Solution Template Input File Example

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=line-converting-solution-template-by-using-command

An example command demonstrating the creation of an input file for converting a solution to a template. It specifies the output file path for the configuration details.

```bash
configmgr_cl generate_input_sa -operation createFromTemplate 
 -file C:\solutions\to_template_input.txt
```

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

### Start IBM Case Manager Configuration Tool on AIX, Linux, or Linux for System z

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=environment-importing-profile-properties

This command initiates the IBM Case Manager configuration tool on Unix-like systems. Ensure you navigate to the correct installation directory before running the command.

```shell
#!/bin/bash
cd _install_path/configure
./configmgr
```

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

### Start Tivoli Directory Server

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Commands to start, and verify the status of, Tivoli Directory Server. This component is essential for user authentication and management.

```shell
cd /opt/ibm/ldap/V6.3/bin
./ibmdirctl -h localhost -D cn=root -w password start
```

```shell
./ibmdirctl -h localhost -D cn=root -w password status
```

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

### Start IBM Case Manager Configuration Tool on AIX, Linux, or Linux for System z

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=deployment-running-development-environment-configuration-tasks

This command is used to start the IBM Case Manager configuration tool on Unix-like operating systems. Ensure you navigate to the '_install_path/configure' directory before running the command. '_install_path' is the directory where IBM Case Manager is installed.

```shell
#!/bin/bash
cd /opt/IBM/CaseManagement/configure
./configmgr
```

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

### Example: Generating input file for copying a solution

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=line-copying-existing-solution-by-using-command

An example command to generate the input file for copying a solution, specifying a full path for the input file. This demonstrates the usage of the -file parameter with a Windows path.

```shell
configmgr_cl generate_input_sa -operation copy -file C:\solutions\copy_input.txt
```

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

### Example: Generate Input File for Copy Operation

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=line-copying-existing-solution-by-using-command

An example command demonstrating the generation of an input file named 'copy_input.txt' in the 'C:\solutions' directory. This file will be used to configure the copy operation.

```shell
configmgr_cl generate_input_sa -operation list -file C:\solutions\copy_input.txt
```

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

### Run Configuration Tool (AIX, Linux)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=environments-defining-registering-target

This command initiates the IBM Case Manager configuration tool on AIX and Linux systems. Navigate to the installation directory and execute the script to start the configuration process.

```shell
cd install_path/configure
./configmgr
```

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

### Start IBM Case Manager Configuration Tool (AIX, Linux, Linux for System z)

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=system-updating-content-platform-engine-client-connector-files

This command is used to start the IBM Case Manager configuration tool on Unix-like operating systems including AIX, Linux, and Linux for System z. Navigate to the installation directory's 'configure' subfolder and execute the 'configmgr' script.

```shell
# Navigate to the installation directory's configure folder
cd _install_path/configure

# Run the configuration tool
./configmgr
```

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

### Start IBM Case Manager Configuration Tool (Windows)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=deployment-running-production-environment-configuration-tasks

This command launches the IBM Case Manager configuration tool on Windows operating systems. Alternatively, you can access it via the Start menu. The '_install_path' indicates the installation directory, and the tool is located in the 'configure' subdirectory.

```batch
_install_path\configure\configmgr.exe
```

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

### Launch Case Synchronizer Command Example

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=configuration-synchronizing-cases-solution-data

This example demonstrates how to launch the case synchronizer utility with specific parameters. It sets the connection URI, user credentials, target object store, and the case type to be updated. Ensure the case type name is enclosed in single quotes if it contains spaces.

```shell
caseSynchronizer launch -cews_uri http://myserver:9080/wsi/FNCEWS40MTOM \
-username administrator -password mypassword \
-target_os MyTargetOS -caseType 'Accident Report'
```

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

### Example: Generate WAS Production Environment Configuration

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=line-configuring-production-environment-by-using-command

An example command demonstrating how to generate configuration XML files for a WebSphere Application Server production environment. This specific command is for a standard deployment, using DB2, a standalone environment, and a profile named 'production1'.

```command line
configmgr_cl generateConfig \
 -deploy standard \
 -db db2 -env standalone \
 -profileType wasproductionenvironment \
 -profile production1
```

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

### Start Oracle WebLogic Server (Console)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Shell command to start Oracle WebLogic Server. By default, logs are displayed in the console.

```shell
startWeblogic.sh
```

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

### GET Method Request for Case Types

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=psr-get-method

This example demonstrates how to use the GET method to retrieve information about case types within a specific solution in IBM Case Manager. It includes the target object store and host details.

```HTTP
GET /CASEREST/v1/solution/Auto+Loan+Solution
?TargetObjectStore=MyTargetObjectStore HTTP/1.1
Host: "www.example.net"
```

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

### Oracle WebLogic Server Boot Properties

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Example content for the 'boot.properties' file to avoid repeated login prompts when starting Oracle WebLogic Server. The username and password will be encrypted upon the first restart.

```properties
username=web_admin_user_name
password=user_password
```

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

### Start WebSphere Application Server

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Shell command to start the default server ('server1') on WebSphere Application Server. Ensure you navigate to the correct profile directory first.

```shell
./startServer.sh server1
```

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

### Start DB2 Component

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Command to start the DB2 database system. This is a prerequisite for IBM Case Manager operations.

```shell
su - dsrdbm01 -c db2start
```

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

### Example POST Request for IBM Case Manager Task Creation

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=cntr-post-method

This example demonstrates a complete HTTP POST request to create a user-created task in IBM Case Manager. It includes the endpoint, headers, and a detailed JSON body with all necessary parameters for task creation and launch.

```http
POST http://example.com:9080/CaseManager/CASEREST/v1/case
/9E45A997-0E42-406E-AAC4-EE55D8BCF2ED/tasks?TargetObjectStore=MyExampleObjectStore HTTP/1.1
Host: www.CaseMgmtExample.net
Content-Type: charset.json;charset-UTF-8
{
  "TaskTypeName": "AUTO_TakeCustomerToLunch",
  "TaskName": "Take customer to lunch",
  "StepElement":
  {
    "attachments": {},
    "systemProperties":
    {
      "responses": ["yes","no"],
      "mapName": "Workflow",
      "stepId": 0,
      "stepName": "LaunchStep",
      "caseFolderId": "{8CA37883-9BA1-4513-AF94-120EA4255A2B}",
      "workflowName": "ETE_ETECase3_ETECase3Task1",
      "selectedResponse": "yes",
      "workObjectNumber": "D931E58C31E1DE44BDF519E88565614F",
      "subject": "ETE_ETECase3_ETECase3Task1",
      "authoredMapName": "Workflow",
      "instruction": ""
    },
    "workflowGroups":
    {
      "F_Trackers":
      {
        "value": [],
        "desc": "",
        "mode": 3,
        "modified": false,
        "type": 64,
        "name": "F_Trackers",
        "isArray": true
      }
    },
    "dataFields":
    {
      "ETEProperty1":
      {
        "value": true,
        "desc": "", 
        "mode": 3,
        "modified": false,
        "type": 4,
        "name": "ETEProperty1", 
        "isArray": false
      },
      "ETEProperty2":
      {
        "value": 163,
        "desc": "",
        "mode": 3,
        "modified": false,
        "type": 1,
        "name": "ETEProperty2",
        "isArray": false
      },
      "ETEProperty3":
      {
        "value": "TestStringChoice1",
        "desc": "",
        "mode": 3,
        "modified": false,
        "type": 2,
        "name": "ETEProperty3",
        "isArray": false
      },
      "ETEProperty4":
      {
        "value": 3.1415926535,
        "desc": "",
        "mode": 3,
        "modified": false,
        "type": 8,
        "name": "ETEProperty4",
        "isArray": false
      },
      "ETEProperty5":
      {
        "value": "2010-07-05T19:21:24Z",
        "desc":"",
        "mode": 3,
        "modified": false,
        "type": 16,
        "name": "ETEProperty5",
        "isArray": false
      }
    },
    "stepProcessor":
    {
      "width":800,
      "height":600,
      "applicationName":"",
      "appType":32,
      "id":455,
      "name":"ETE_LaunchPage",
      "processorType":4,
      "locations":{"8":"123456"}
    }
  }
}
```

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

### GET Request for Case History Entries

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=resource-get-method-case-history

This example demonstrates how to make a GET request to retrieve a batch of case history entries. It specifies the target case, object stores, batch size, and event types. The response may include a continuation token for subsequent requests.

```http
#Request to get comment history of a particular case
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/19278CB3-C71C-4DE5-95FE-7C7544020A31/history
?TargetObjectStore=ATOSME&BatchSize=5
&ObjectTypes=CmAcmCaseComment+CmAcmWorkItemComment+
CmAcmVersionSeriesComment&EventTypes=CreationEvent
HTTP/1.1
Host: www.example.net
```

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

### Start Oracle WebLogic Server (Background with Logging)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=system-starting-your

Command to start Oracle WebLogic Server in the background and redirect logs to a file. This is useful for long-running server processes.

```shell
nohup ./startWebLogic.sh >>log_file_name.log 2>&1 &
```

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

### Command-Line Parameter Examples

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=syntax-listimporttargettasks-command

Examples of common command-line parameters used for IBM Case Manager tasks, including specifying source task names, target profiles, and silent/force options.

```bash
# Example with spaces in task name:
-sourceTaskName "Configure LDAP"

# Example specifying target profile:
-target /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/IBMIMSharedData

# Example using silent and force for non-interactive execution:
-silent -force

# Example to display help:
-help
```

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

### Example XML Configuration for LDAP

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=ccmfcl-configuring-additional-directory-service-providers-ldap-by-using-command-line

An example snippet showing how to edit the `configureldap.n.xml` file. This involves replacing placeholders like `****INSERT VALUE****` with actual values and ensuring the `enabled` attribute is set to `true` to activate the task. The structure uses XML format with `<value>` tags for properties.

```xml
<configuration enabled="true">
  <!-- ... other properties ... -->
  <property name="ldap_host">
    <value>your_ldap_host</value>
  </property>
  <property name="ldap_port">
    <value>389</value>
  </property>
  <!-- ... -->
</configuration>
```

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

### Get Start Date

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=comibmcasemgmtapitasks-task

Returns the date when the task was started. This is associated with the 'DateStarted' property.

```java
public java.util.Date getDateStarted()

```

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

### Example GET Request Parameters for Case History

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=resource-get-method-case-history

Demonstrates how to combine object types and event types in the GET request to filter case history results. This example specifies that only documents and case folders created should be returned.

```http
&ObjectTypes=Document+CmAcmCaseFolder+CmAcmCaseSubfolder&EventTypes=Creation
```

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

### Get Task Start Date

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=comibmcasemgmtapitasks-task

Returns the date when the task was started. Note that the return type is java.lang.String, which may require parsing.

```java
public java.lang.String getDateStarted()
```

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

### GET Request for Case Comments

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=resource-get-method-case-comments

This example demonstrates how to make a GET request to retrieve all comments for a specific case. It requires the case folder ID in the URI and specifies the target object store and comment type as query parameters.

```HTTP
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/9E45A997-0E42-406E-AAC4-EE55D8BCF2ED/comments?
TargetObjectStore=MyExampleObjectStore&CommentType=Case HTTP 1.1
Host: www.example.net
```

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

### GET Method Request for Task Type Information (HTTP)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=cntr-get-method

This example demonstrates how to make a GET request to retrieve task type information for a specific task within a case. It includes the URI with path elements and query parameters, as well as standard HTTP headers.

```http
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/12345678-abcd-dcba-4321-12345678/tasktype/
AUTO_ContactCustomer?TargetObjectStore=MyTOS HTTP/1.1
Host: www.example.net
```

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

### Get Localized User Response Message in Java

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=comibmcasemgmtapiexception-casemgmtexception

Retrieves the localized message intended for user response or action. This guides the user on how to proceed.

```java
public final java.lang.String getLocalizedUserResponse( )
```

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

### LaunchStep API Methods

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=comibmcasemgmtapitasks-launchstep

Provides a summary of available methods for the LaunchStep object, categorized by their functionality.

```APIDOC
## LaunchStep API Methods

This section outlines the various methods available on the `LaunchStep` object for interacting with case management workflows.

### Fetching and Managing Parameters

- **`fetchDependentParameterChanges()`**: Fetches changes for parameters with `hasDependentProperties()` set to true.
- **`getParameter(java.lang.String name)`**: Retrieves a `StepParameter` from the cache by name.
- **`getParameterAuthoredNames()`**: Returns authored names of parameters in the cache.
- **`getParameterByAuthoredName(java.lang.String authName)`**: Retrieves a `StepParameter` by its authored name.
- **`getParameterBySymbolicName(java.lang.String propertyProvider, java.lang.String propertySymbolicName)`**: Retrieves a `StepParameter` by provider and symbolic name.
- **`getParameterNames()`**: Returns names of parameters in the cache.
- **`getParameterSymbolicNames(java.lang.String propertyProvider)`**: Returns symbolic names for parameters with a specific provider.
- **`getParameterValue(java.lang.String name)`**: Retrieves the value of a `StepParameter`.
- **`setParameterValue(java.lang.String name, java.lang.Object value)`**: Sets the value of a `StepParameter`.
- **`setReferenceParameterValue(java.lang.String name, java.lang.Object value, int valueType)`**: Sets a parameter value as a reference.

### Managing Properties

- **`getNonStepPropertyDescription(java.lang.String name)`**: Obtains `PropertyDescription` for a non-step property.
- **`getNonStepPropertyNames()`**: Obtains the names of non-step properties.
- **`getNonStepPropertyValue(java.lang.String name)`**: Obtains the value of a non-step property.
- **`setNonStepPropertyValue(java.lang.String name, java.lang.Object value)`**: Sets the value of a non-step property.

### Workflow and Step Information

- **`getAuthoredMapName()`**: Obtains the authored map name.
- **`getComment()`**: Returns the comment associated with the launch step.
- **`setComment(java.lang.String comment)`**: Specifies a comment for the launch step.
- **`getExternalDataIdentifier()`**: Returns the external data identifier for the current step.
- **`setExternalDataIdentifier(java.lang.String externDataIdent)`**: Sets the current external data identifier.
- **`getMapName()`**: Obtains the map name.
- **`getSelectedResponse()`**: Retrieves the selected response value.
- **`setSelectedResponse(java.lang.String response)`**: Sets the selected response.
- **`getStepDescription()`**: Returns the description of the step.
- **`getStepId()`**: Obtains the step ID.
- **`getStepName()`**: Obtains the step name.
- **`getStepProcessorInfo()`**: Returns information about the step processor.
- **`getStepResponses()`**: Retrieves the possible response values.
- **`getSubject()`**: Retrieves the subject of the launch step.
- **`setSubject(java.lang.String subject)`**: Specifies the subject of the launch step.
- **`getWorkflowName()`**: Retrieves the workflow name.
- **`getWorkObjectNumber()`**: Retrieves the work object number.

### Status Checks

- **`isNewLaunchStep()`**: Indicates if the launch step was initialized as new.
```

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

### Generate Input File for Solution to Template Conversion

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=line-converting-solution-template-by-using-command

Generates a text input file required for the `convertToTemplate` operation. This command is run from the CaseManagement/configure directory. The output is a file that will be edited with specific solution details.

```bash
configmgr_cl generate_input_sa -operation convertToTemplate 
 -file input_file_name
```

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

### Task Initialization API

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=comibmcasemgmtapitasks-task

This section details how to initialize a launch step for a task, either as a new or an in-progress task.

```APIDOC
## POST /websites/ibm_en_case-manager/initializeInProgressLaunchStep

### Description
Initializes an in-progress launch step with the provided work object number. No parameters are preset, and callers can add values by interacting with the returned `LaunchStep` object. This method can only be called once per launch step.

### Method
POST

### Endpoint
/websites/ibm_en_case-manager/initializeInProgressLaunchStep

### Parameters
#### Path Parameters
- **workObjectNumber** (String) - Required - The work object number obtained previously.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "workObjectNumber": "12345"
}
```

### Response
#### Success Response (200)
- **LaunchStep** (Object) - The initialized LaunchStep object.

#### Response Example
```json
{
  "launchStep": {
    "initialized": true
  }
}
```
```

```APIDOC
## GET /websites/ibm_en_case-manager/getLaunchStep

### Description
Retrieves the launch step used for launching the workflow associated with the new task. The launch step must have been previously established using `initializeNewLaunchStep()` or `initializeInProgressLaunchStep()`.

### Method
GET

### Endpoint
/websites/ibm_en_case-manager/getLaunchStep

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

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

### Response
#### Success Response (200)
- **LaunchStep** (Object) - The launch step object.

#### Response Example
```json
{
  "launchStep": {
    "initialized": true
  }
}
```
```

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

### GET Method Request for Case History Summary

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=resource-get-method-case-history

This example demonstrates how to make a GET request to retrieve a summary of case history entries, such as comments and audit details, for a specific case. It includes parameters for batch size and object/event types. The request targets a specific case ID and object store.

```http
#Request to get comment history of a particular case
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/19278CB3-C71C-4DE5-95FE-7C7544020A31/history
?TargetObjectStore=ATOSME&BatchSize=5
&ObjectTypes=CmAcmCaseComment+CmAcmWorkItemComment+
CmAcmVersionSeriesComment&EventTypes=CreationEvent
HTTP/1.1
Host: www.example.net

```

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

### GET Method Response for Launch Step Information (JSON)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=cntr-get-method

This code snippet illustrates a typical HTTP 200 OK response for a GET request to retrieve launch step information for a task in IBM Case Manager. It includes details about system properties, workflow groups, data fields, and the step processor.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "attachments": {},
  "systemProperties":
  {
    "responses": ["yes", "no"],
    "mapName": "Workflow",
    "stepId": 0,
    "stepName": "LaunchStep",
    "caseFolderId": "{8CA37883-9BA1-4513-AF94-120EA4255A2B}",
    "workflowName": "ETE_ETECase3_ETECase3Task1",
    "selectedResponse": "",
    "workObjectNumber": "D931E58C31E1DE44BDF519E88565614F",
    "subject": "ETE_ETECase3_ETECase3Task1",
    "authoredMapName": "Workflow",
    "instruction": ""
  },
  "workflowGroups":
  {
    "F_Trackers":
    {
      "value" : [],
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 64,
      "name": "F_Trackers",
      "isArray": true
    }
  },
  "dataFields":
  {
    "ETEProperty1":
    {
      "value": true,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 4,
      "name": "ETEProperty1",
      "isArray": false
    },
    "ETEProperty2":
    {
      "value": 163,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 1,
      "name": "ETEProperty2",
      "isArray":false
    },
    "ETEProperty3":
    {
      "value": "TestStringChoice1",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 2,
      "name": "ETEProperty3",
      "isArray": false
    },
    "ETEProperty4":
    {
      "value": 3.1415926535,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 8,
      "name": "ETEProperty4",
      "isArray": false
    },
    "ETEProperty5":
    {
      "value": "2010-07-05T19:21:24Z",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 16,
      "name": "ETEProperty5",
      "isArray":false
    }
  },
  "stepProcessor":
  {
    "width":800,
    "height":600,
    "applicationName":"",
    "appType":32,
    "id":455,
    "name":"ETE_LaunchPage",
    "processorType":4,
    "locations":{"8":"123456"}
  }
}
```

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

### Step and Workflow Information

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=comibmcasemgmtapitasks-launchstep

Methods for retrieving general information about the launch step and its associated workflow.

```APIDOC
## GET /launchstep/stepResponses

### Description
Retrieves the possible response values for the launch step. This information is only available if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/stepResponses

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **responses** (string[]) - An array of possible response strings.

#### Response Example
{
  "responses": ["Approve", "Reject"]
}

## GET /launchstep/workflowName

### Description
Retrieves the name of the workflow associated with this launch step.

### Method
GET

### Endpoint
/launchstep/workflowName

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **workflowName** (string) - The name of the workflow.

#### Response Example
{
  "workflowName": "Document Approval Workflow"
}

## GET /launchstep/workObjectNumber

### Description
Retrieves the work object number. This number is assigned during the initialization of a new launch step or provided as an argument for an in-progress launch step.

### Method
GET

### Endpoint
/launchstep/workObjectNumber

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **workObjectNumber** (string) - The work object number.

#### Response Example
{
  "workObjectNumber": "12345"
}

## GET /launchstep/stepName

### Description
Obtains the name of the step. This information is available only if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/stepName

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **stepName** (string) - The name of the step.

#### Response Example
{
  "stepName": "Review Document"
}

## GET /launchstep/stepId

### Description
Obtains the unique identifier (ID) of the step. This information is available only if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/stepId

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **stepId** (integer) - The ID of the step.

#### Response Example
{
  "stepId": 101
}

## GET /launchstep/mapName

### Description
Obtains the map name associated with the step. The map name may be translated if a translation source is available. This information is available only if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/mapName

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **mapName** (string) - The translated map name.

#### Response Example
{
  "mapName": "Translated Map Name"
}

## GET /launchstep/authoredMapName

### Description
Obtains the authored map name, which is the original map name from the workflow definition and is not translated. This information is available only if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/authoredMapName

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **authoredMapName** (string) - The authored map name.

#### Response Example
{
  "authoredMapName": "Original Map Name"
}

## GET /launchstep/stepDescription

### Description
Returns the description of the step. This information is available only if the object was initialized as a new launch step.

### Method
GET

### Endpoint
/launchstep/stepDescription

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **stepDescription** (string) - The description of the step.

#### Response Example
{
  "stepDescription": "This step requires document review."
}
```

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

### Retrieve Case Comments using GET Method

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=resource-get-method-case-comments

This example demonstrates how to retrieve all comments for a specific case using a GET request to the Case Management REST API. It shows the expected JSON response format containing an array of comment objects, each with details like ID, creator, date, and text. No external dependencies are required beyond an HTTP client.

```json
{
  "Comments":
  [
    {
      "Id": "{5E42A997-0F47-446E-AFC4-EE55D8BCF5PP}",
      "Creator": "Bob",
      "CommentContext": 101,
      "DateCreated": "2010-04-07T14:30Z",
      "CommentText": "New request from Bob at GimmeCars.com"
    },
    {
      "Id": "{9E45A997-0E42-406E-AAC4-EE55D8BCF2EA}",
      "Creator": "Mary",
      "CommentContext": 102,
      "DateCreated": "2010-04-07T15:30Z",
      "CommentText": "Fast-track Bob's request – very good customer"
    }
  ]
}
```

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

### Show Help for generateConfig Command

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=syntax-generateconfig-command

This command displays the help information for the 'generateConfig' command, outlining its available options and usage.

```bash
configmgr_cl generateConfig -help
```

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

### Example GET Request for Case Folder Properties

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=pcir-get-method

This snippet demonstrates how to make a GET request to the IBM Case Manager REST API to retrieve the current property values for a specific case folder. It requires the case folder ID and the target object store as parameters. The response will contain the case properties and their values, along with an HTTP status code.

```http
GET
http://localhost:9081/CaseManager/CASEREST/v1/case/
C5AB1E9D-30D1-4D21-ADDF-F248FF1354B7
?TargetObjectStore=CMTOSDH
```

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

### Create Case Analyzer Store Command

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=ccmfcl-creating-enabling-case-analyzer-store-by-using-command-line

This command creates and enables a Case Analyzer store. It requires parameters for profile, target object store, schema name, database connection, pruning schedule, and publish interval. Optional parameters include silent, force, and help.

```bash
configmgr_cl createCaseAnalyzerStore \
 -profile myprofile \
 -cmtos target_object_store \
 -schemaName schema_name \
 -dbConnName database_connection \
 -eventPruneSchedule pruning_time \
 -publishInterval update_interval \
 [-silent][-force][-help]
```

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

### Generate Solution Template Input File (configmgr_cl)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=ccmfcl-creating-solution-from-template-by-using-command-line

Generates a text input file for creating an IBM Case Manager solution from a template. This command requires the operation type and an output file name. The directory for the output file must exist. The `-help` flag provides syntax information.

```Shell
configmgr_cl generate_input_sa -operation createFromTemplate \
 -file input_file_name
[-help]
```

```Shell
configmgr_cl generate_input_sa -operation createFromTemplate \
 -file C:\solutions\from_template_input.txt
```

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

### Execute Solution to Template Conversion

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=line-converting-solution-template-by-using-command

Applies the configuration specified in the input file to convert the current solution into a template. This command finalizes the conversion process.

```bash
configmgr_cl execute_sa -operation convertToTemplate 
 -file input_file_name
```

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

### IBM Case Manager GET Response Example

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=pcir-get-method

This code snippet demonstrates a sample HTTP 200 OK response for a GET request to retrieve properties of a case instance. It includes common case properties such as DateCreated, CmAcmCaseIdentifier, CmAcmCaseState, and DH2_State, along with their respective attributes like SymbolicName, DisplayName, Value, and PropertyType. The response is in JSON format and may contain additional properties not shown.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "Properties": [

    {
      "SymbolicName": "DateCreated", 
      "DisplayName": "Date Created", 
      "Value": "2011-04-28T18:49:55Z", 
      "OriginalValue": "2011-04-28T18:49:55Z", 
      "DisplayMode": "readwrite", 
      "Description": "The date and time this object was created.", 
      "PropertyType": "datetime", 
      "Cardinality": "single", 
      "Updatability": "readonly", 
      "Required": false, 
      "Queryable": true, 
      "Orderable": true, 
      "Hidden": false, 
      "Inherited": true, 
      "DefaultValue": null, 
      "MaxValue": "9999-12-31T23:59:59Z", 
      "MinValue": "1753-01-01T00:00:00Z", 
      "HasDependentProperties": false
    },

    {
      "SymbolicName": "CmAcmCaseIdentifier", 
      "DisplayName": "Case Identifier", 
      "Value": "DH2_MyCase_000000100602", 
      "OriginalValue": "DH2_MyCase_000000100602", 
      "DisplayMode": "readwrite", 
      "Description": "A specially formatted identifier for 
        Case Folder instances, consists of Case Folder subclass 
        symbolic class name, \"_\" and then a  12 digit sequence
        number with leading zeros.", 
      "PropertyType": "string", 
      "Cardinality": "single", 
      "Updatability": "readwrite", 
      "Required": false, 
      "Queryable": true, 
      "Orderable": true, 
      "Hidden": false, 
      "Inherited": true, 
      "DefaultValue": null, 
      "MaxLength": 85, 
      "HasDependentProperties": false
    },
    {
      "SymbolicName": "CmAcmCaseState", 
      "DisplayName": "Case State", 
      "Value": 2, 
      "OriginalValue": 2, 
      "DisplayMode": "readwrite", 
      "Description": "An integer choice property that defines the possible
        the possible states of Case Folder instance.", 
      "PropertyType": "integer", 
      "Cardinality": "single", 
      "Updatability": "readwrite", 
      "Required": true, 
      "Queryable": true, 
      "Orderable": true, 
      "Hidden": false, 
      "Inherited": true, 
      "DefaultValue": 0, 
      "MaxValue": null, 
      "MinValue": null, 
      "ChoiceList": {
        "DisplayName": "CmAcmCaseStateChoiceList", 
        "Choices": [
         {
          "ChoiceName": "New", 
          "Value": 0
         },
         {
          "ChoiceName": "Initializing", 
          "Value": 1
         },
         {
          "ChoiceName": "Working", 
          "Value": 2
         },
         {
          "ChoiceName": "Complete", 
          "Value": 3
         },
         {
          "ChoiceName": "Failed", 
          "Value": 4
         }
        ]
      },
      "HasDependentProperties": false
    },
    {
      "SymbolicName": "DH2_State", 
      "DisplayName": "State", 
      "Value": "CA", 
      "OriginalValue": "CA", 
      "DisplayMode": "readwrite", 
      "Description": "State where home office is located", 
      "PropertyType": "string", 
      "Cardinality": "single", 
      "Updatability": "readwrite", 
      "Required": true, 
      "Queryable": true, 
      "Orderable": true, 
      "Hidden": false, 
      "Inherited": false, 
      "DefaultValue": null, 
      "MaxLength": 2, 
      "ChoiceList": {
        "DisplayName": "StateChoiceList", 
        "Choices": [
        {
          "ChoiceName": "New York", 
          "Value": "NY"
        },
        {
          "ChoiceName": "California", 
          "Value": "CA"
        },
        {
          "ChoiceName": "Nevada", 
          "Value": "NV"
        }
        ]
      },
      "HasDependentProperties": true
    }

  ]
}
```

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

### IBM Case Manager GET Response - JSON Example

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=ltir-get-method

This JSON snippet illustrates a successful HTTP 200 OK response to a GET request in IBM Case Manager. It outlines the structure for both optional and required tasks associated with a case, including properties like TaskState, DateCreated, and TaskId. The response may also include a FailureReason element for tasks in a failed state, though this text may only be available in English.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "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"
    }
  ]
}
```

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

### Request Page ID for Case Type - HTTP

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=cpr-get-method

This example demonstrates how to request a page ID for a specific case type using the HTTP GET method. It requires the target object store and the type of page (e.g., CasePage for Case Details). An optional role parameter can be used to retrieve role-specific page IDs.

```HTTP
GET http://example.com:9080/CaseManager/CASEREST/v1/casetype
/AUTO_CollisionClaim/page?TargetObjectStore=MyTOS
&PageType=CasePage&Role=caseWorker HTTP/1.1
Host: www.example.net
```

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

### Apply Solution Security Manifest (IBM Case Manager CLI)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=line-applying-security-configuration-by-using-command

This command applies a security configuration manifest to a specified solution within an IBM Case Manager environment. It requires details about the profile, target environment, solution name, and the manifest file itself. The `-help` option can be used for syntax information.

```shell
configmgr_cl applySolutionSecurityManifest \
 -profile myprofile \
 -targetEnvName target_environment_name \
 -solutionName solution_name \
 -manifestName manifest_name \
 [-help]
```

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

### HTTP GET Response for Related Cases (JSON Example)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=rcpcr-get-method

This code snippet demonstrates the structure of a successful HTTP 200 OK response when retrieving a list of cases related to a specific case in IBM Case Manager. It includes common fields like Status, CaseTitle, CaseIdentifier, and RelationshipType. The response is in JSON format.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
[
{
    "Status": "Working",
    "CaseTitle": "MY_Case_000000100105",
    "CaseIdentifier":"MY_Case_000000100105",
    "CaseFolderId":"1D56A997-0E42-406E-AAC4-EE55D8BCF2ED",
    "DateCreated":" 2010-07-16T21:50:36Z",
    "Creator": "Admin",
    "RelationshipType": "split source",
    "RelationshipId": "{12345678-1234-1234-1234-aabbccddeeff}"
},
{
    "Status": "Working",
    "CaseTitle": "MyCaseTitle",
    "CaseIdentifier":"MY_Case_000000100106",
    "CaseFolderId":"2E67A997-0E42-406E-AAC4-EE55D8BCF2ED",
    "DateCreated":" 2010-07-16T21:50:36Z",
    "Creator": "Admin",
    "RelationshipType": "split target",
    "RelationshipID": "{22345678-1234-1234-1234-aabbccddeeff}"
},
{
    "Status": "Working",
    "CaseTitle": "MY_Case_000000100107",
    "CaseIdentifier":"MY_Case_000000100107",
    "CaseFolderId":"3F47B997-0E42-406E-AAC4-EE55D8BCF2ED",
    "DateCreated":" 2010-07-16T21:50:36Z",
    "Creator": "Admin",
    "RelationshipType": "split target"
    "RelationshipID": "{32345678-1234-1234-1234-aabbccddeeff}"
},
{
    "Status": "Working",
    "CaseTitle": "MY_Case_000000100107",
    "CaseIdentifier": "MY_Case_000000100107",
    "CaseFolderId": "3F47B997-0E42-406E-AAC4-EE55D8BCF2ED",
    "DateCreated": "2010-07-16T21:50:36Z",
    "Creator": "Admin",
    "RelationshipType”: "Related",
    "RelationshipId": "{42345678-1234-1234-1234-aabbccddeeff}",
    "RelationshipCategory": "user profile"
}]

```

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

### Execute Solution Creation from Template (configmgr_cl)

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=ccmfcl-creating-solution-from-template-by-using-command-line

Applies the configurations specified in the input file to create a new IBM Case Manager solution from a template. This command requires the operation type and the path to the input file. Dependencies: A correctly formatted input file generated previously.

```bash
configmgr_cl execute_sa -operation createFromTemplate -file input_file_name
```

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

### Start IBM Case Manager Configuration Tool (AIX, Linux, Linux for System z)

Source: https://www.ibm.com/docs/en/case-manager/5.2_topic=deployment-running-production-environment-configuration-tasks

This command initiates the IBM Case Manager configuration tool on AIX, Linux, and Linux for System z operating systems. Ensure you navigate to the '_install_path/configure' directory before running the command. The '_install_path' is the root directory where IBM Case Manager is installed.

```shell
./configmgr
```

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

### Start To-Do Task Action

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=wiring-action-events

Starts the current to-do task. This action is of type Wired.

```APIDOC
## Start To-Do Task Action

### Description
The current to-do task is started.

### Method
WIRED

### Endpoint
N/A (Internal Action)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **caseEditable** (icm.model.CaseEditable) - An object representing the case to be split.
- **ToDoTaskEditable** (icm.util.Coordination) - An object used internally by widgets on the same page.
```

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

### Generate Solution Deployment Configuration

Source: https://www.ibm.com/docs/en/case-manager/5.3_topic=dscm-deploying-solution-production-target-object-store-by-using-command-line

Generates a `deploysolution.n.xml` file for a given profile. This task requires the `deploysolution` task, a profile name, and optionally can be run silently and with force. The profile can be specified by name, path, or configuration file.

```Shell
configmgr_cl generateConfig \
 -task deploysolution \
 -profile myprofile \
 -profileType wasproductionenvironment

```

```Shell
configmgr_cl generateConfig \
 -task deploysolution \
 -profile deploy_solution

```
Tokens:
Raw