IBM Blueworks Live

https://www.ibm.com/docs/en/blueworks-live
Admin
IBM Blueworks Live is a cloud-based process discovery and business process management tool that...
Tokens:215,628
Snippets:1,047
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example Policy Creation Response

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=policies-

This is an example of a successful response when creating a policy. It returns the ID and name of the newly created policy.

```json
{
  "id" : "5f6000cc60034",
  "name" : "New Policy"
}
```

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

### Example JSON Output for User List

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-userlist

This is an example of the JSON output returned by the GET /scr/api/UserList endpoint when requesting user data in JSON format. It includes the API version and an array of user objects, each with various properties.

```json
{
  "version":"20110917",
  "users":[
    {
      "name":"username1",
      "id":"7000f",
      "email":"user1_email@website.com",
      "avatarId":"70010",
      "license":"Editor",
      "admin":true,
      "date":1310654350393,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150005", "name": "department1" }
    },
    {
      "name":"username2",
      "id":"70022",
      "email":"user2_email@website.com",
      "license":"Community",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150006", "name": "department2" }
    },
    {
      "name":"username3",
      "id":"70021",
      "email":"user3_email@website.com",
      "license":"Contributor",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150007", "name": "department3" }
    },
    {
      "name":"username4",
      "id":"70020",
      "email":"user4_email@website.com",
      "license":"Viewer",
      "admin":false,
      "date":1310653543628,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150008", "name": "department4" }
    }
  ]
}
```

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

### Compile Java Examples

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=blueworks-live-api

Commands to compile the provided Java examples. These commands include the necessary JSON4J JAR file in the classpath. Separate commands are provided for Windows and Linux operating systems.

```Windows Batch
javac -cp .;wink-json4j-1.3.0.jar RestApiClientTemplate.java
javac -cp .;wink-json4j-1.3.0.jar RestApiRateLimitClientTemplate.java
javac -cp .;wink-json4j-1.3.0.jar SearchExample.java
```

```Linux Shell
javac -cp ./wink-json4j-1.3.0.jar RestApiClientTemplate.java
javac -cp ./wink-json4j-1.3.0.jar RestApiRateLimitClientTemplate.java
javac -cp ./wink-json4j-1.3.0.jar SearchExample.java
```

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

### Run Java Examples

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=blueworks-live-api

Commands to run the compiled Java examples. These commands include the necessary JSON4J JAR file in the classpath. Separate commands are provided for Windows and Linux operating systems. Remember to change credentials to valid values before running.

```Windows Batch
java -cp .;wink-json4j-1.3.0.jar RestApiClientTemplate
java -cp .;wink-json4j-1.3.0.jar RestApiRateLimitClientTemplate
java -cp .;wink-json4j-1.3.0.jar SearchExample
```

```Linux Shell
java -cp .:./wink-json4j-1.3.0.jar RestApiClientTemplate
java -cp .:./wink-json4j-1.3.0.jar RestApiRateLimitClientTemplate
java -cp .:./wink-json4j-1.3.0.jar SearchExample
```

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

### GET /scr/api/AppList

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-applist

Retrieves a list of process apps that the user can start instances of. This endpoint requires authentication and supports OAuth 2 client credentials.

```APIDOC
## GET /scr/api/AppList

### Description
Use this method to retrieve a list of process apps that the user can start instances of.

### Method
GET

### Endpoint
/scr/api/AppList

### Parameters
#### Query Parameters
- **version** (String) - Required - The version of the requested API. The only allowed value is `20110917`.

#### Header Parameters
- **X-On-Behalf-Of** (String) - Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. - The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.

### Request Example
* Using User Service ID OAuth 2 client credentials:
```curl
curl -i -H "Authorization: Bearer access_token" \
"https://your_server_url/scr/api/AppList?version=20110917"
```
* Using Service ID OAuth 2 client credentials:
```curl
curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" \
    "https://your_server_url/scr/api/AppList?version=20110917"
```

### Response
#### Success Response (200)
- **version** (String) - The version of the API used to create the response.
- **more** (Boolean) - `true` if there are more process app definition instances on the server, `false` otherwise.
- **apps** (Array) - An array of process app instances listed in alphabetical order by name.
  - **app.name** (String) - The name of the process app.
  - **app.id** (String) - The ID of the process app.
  - **app.processId** (String) - The ID of the process related to this app.
  - **app.type** (String) - The app type (`workflow` or `checklist`).
  - **app.new** (Boolean) - Present only if `true`, indicating a process app the user did not see before.
- **favorites** (Array) - An array of apps that the user selected as favorites.
  - **favorites.id** (String) - The ID of the favorite process app.

#### Response Example
```json
{
  "more": false,
  "apps": [
    {
      "id": "31ea912ac7",
      "new": true,
      "processId": "31ea912ac3",
      "name": "develop process diagram",
      "type": "workflow"
    },
    {
      "id": "9bea79df89",
      "new": true,
      "processId": "9bea79df85",
      "name": "any process app",
      "type": "checklist"
    }
  ],
  "favorites": [],
  "version": "20110917"
}
```

#### Error Responses
- **400**: Bad Request - There is an error processing the request. Required parameters were missing or contained invalid values.
- **401**: Unauthorized - The user isn't authorized to make the request.
```

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

### Search Process by Name API Response Example (JSON)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=api-how-do-i-use-search

This is an example of the JSON response received when searching for a process by its name in IBM Blueworks Live. It returns the parent space containing the process, along with the process details.

```json
{
 "spaces": [
   {
     "id": "27260049",
     "name": "Parent Space",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [...],
         "name": "Parent Process"
       }
     ]
   }
 ]
}
```

```json
{
 "spaces": [
   {
     "id": "2737002c",
     "name": "Grandparent Space",
     "processes": [
       {
         "id": "27370032",
         "milestones": [...],
         "name": "Grandparent Process"
       }
     ]
   }
 ]
}
```

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

### Example CSV Output for User List

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-userlist

This is an example of the CSV output returned by the GET /scr/api/UserList endpoint when requesting user data in CSV format. It includes headers and rows of user information.

```csv
"License Type","Full Name","Email Address","Business Unit","Administrator",
"Last Login / Invite / Archive Date (Eastern Standard Time)","Archived","Invited","Licensed","Locked"
Editor, "username1", "user1_email@website.com", "Department 1", Yes, "2011/07/14 02:39:10", No, No, Yes, No
Community, "username2", "user2_email@website.com", "", No, "", No, No, Yes, No
Contributor, "username3", "user3_email@website.com", "", No, "", No, No, Yes, No
Viewer, "username4", "user4_email@website.com", "", No, "2011/07/14 02:25:43", No, No, Yes, No
```

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

### Example Output: Specific Group Details JSON

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-managegroup

This is an example of the JSON output when retrieving details for a specific group. The output includes information about the group itself, as well as lists of its associated users and subgroups.

```json
{
  "id": "4f0001",
  "name": "group admin",
  "description": "This is a custom group for admins",
  "groups": [
    {
      "name": "group2",
      "description": "",
      "id": "4f000b",
      "activeState": "active"
    },
    {
      "name": "group3",
      "description": "",
      "id": "520001",
      "activeState": "active"
    }
  ],
  "users": [
    {
      "name": "admin",
      "id": "40019",
      "email": "admin_user_email@website.com"
    },
    {
      "name": "user",
      "id": "4001e",
      "email": "super_user_email@website.com"
    }
  ]
}
```

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

### Example JSON Response for User List

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-userlistforwork

An example of the JSON output returned by the API when fetching the user list for work. It includes an array of user objects, each with name, ID, and optionally avatar ID and license type.

```json
{
  "users":[
    {
      "name":"username1",
      "id":"7000f",
      "avatarId":"70010",
      "license":"Editor"
    },
    {
      "name":"username2",
      "id":"70022",
      "license":"Contributor"
    },
    {
      "name":"username3",
      "id":"70020",
      "license":"Editor",
      "avatarId":"7612738"
    }
  ]
}
```

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

### Example Output: List All Groups JSON

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-managegroup

This is an example of the JSON output when requesting a list of all groups, including archived ones. It shows a JSON array where each element is an object representing a group with properties like name, description, id, and activeState.

```json
[
 {
    "name": "group admin",
    "description": "This is a custom group for admins",
    "id": "4f0001",
    "activeState": "active"
  },
  {
    "name": "group1",
    "description": "",
    "id": "4f0004",
    "activeState": "active"
  },
  {
    "name": "group2",
    "description": "",
    "id": "4f000b",
    "activeState": "active"
  },
  {
    "name": "group3",
    "description": "",
    "id": "520001",
    "activeState": "archived"
  }
]
```

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

### Search for Input on Milestone in Blueworks Live

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=api-how-do-i-use-search

This example demonstrates how to search for an input on a milestone within IBM Blueworks Live. The search returns the milestone, its direct parent process, and the direct parent space. It uses 'searchValue' and 'searchFieldName' parameters to filter results.

```json
{
 "spaces": [
   {
     "id": "27260049",
     "name": "Parent Space",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [
           {
             "business owners": [
               {
                 "id": "27373507",
                 "name": "parent process business owner"
               }
             ],
             "id": "27260053",
             "inputs": [
               {
                 "id": "27372d07",
                 "name": "Parent process input"
               }
             ],
             "name": "Milestone 1"
           }
         ],
         "name": "Parent Process"
       }
     ]
   }
 ]
}
```

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

### Example JSON Response for AppDetail API

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-appdetail

This is an example of the JSON output returned by the GET /scr/api/AppDetail endpoint. It includes details about the process app, such as its ID, name, type, and associated tasks, as well as a list of users.

```json
{
  "app": {
    "id": "44eaaadd6d",
    "mailOnCompletion": false,
    "instructions": null,
    "subjectTitle": null,
    "processId": "44eaaadd69",
    "name": "ProcApp",
    "attachments": [],
    "tasks": [
      {
        "id": "44eaaade02",
        "approvalStep": false,
        "name": "",
        "assignedTo": null
      }
    ],
    "type": "workflow",
    "detailsTitle": null
  },
  "users": [],
  "version": "20110917"
}
```

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

### API Response: Provisioning a User with All Parameters

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-provisionuser

This example illustrates a successful HTTP 200 OK response when provisioning a user with all available parameters, including username, full name, license, admin status, and user groups. The response confirms the successful creation of the user with specified details.

```http
HTTP/1.1 200 OK 
Content-Length: 155
{"username":"john.smith@us.ibm.com","fullname":"John Smith","license":"EDITOR","admin":true,"active":true, 
"usergroups":[{"groupname":"group1"},{"groupname":"group2"}]}
```

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

### ListFiles API Response Example

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=attachments-listfiles

This is an example of the JSON response received from the GET /scr/api/ListFiles API call. It includes a list of files, each with properties like fileId, uploadUserId, uploadDate, fileSize, fileName, attachedToId, and attachedToType.

```JSON
{
  "files":[
    {
      "fileId":"b0050",
      "uploadUserId":"bob@foo.com",
      "uploadDate":"2012-08-13T15:37:08.770-05:00",
      "fileSize":591728,
      "fileName":"Earth.tif",
      "attachedToId":"b000f",
      "attachedToType":"process"
    }
  ]
}
```

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

### Example Activity Documentation Response

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=blueprints-activitydocumentation

A sample JSON response received after successfully retrieving activity documentation. It includes the activity ID and its description, which may contain HTML markup.

```json
{
   "activityId":"5f500e10928f0",
   "description":"<b><i><u>ActivityDocumentation API test</u></i></b>"
}
```

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

### Task List Count Response Structure

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-tasklistcount

Example JSON output for the GET /scr/api/TaskListCount endpoint. The response contains a single 'count' property indicating the total number of tasks matching the specified criteria.

```json
{
    "count":17
}
```

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

### POST /scr/api/LaunchInstance

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-launchinstance

Starts a new work instance from an application definition. This endpoint requires authentication and supports OAuth 2 client credentials.

```APIDOC
## POST /scr/api/LaunchInstance

### Description
Use this method to start a new work instance from an application definition.

### Method
POST

### Endpoint
/scr/api/LaunchInstance

### Parameters
#### Query Parameters
- **instance** (string) - Required - The definition for the instance to create. The instance format is shown in the example.
- **version** (string) - Required - The version of the requested API. The only allowed value is `20110917`.

#### Header Parameters
- **X-On-Behalf-Of** (string) - Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. - The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.
- **Authorization** (string) - Required - Bearer token for authentication.
- **Accept** (string) - Optional - Specifies the response format, typically `application/json`.

#### Request Body
(The `instance` parameter is a JSON string that represents the request body structure)
- **app.attachments** (array of objects) - Required - The array of attachments to associate with this instance. Each attachment is identified by its ID.
  - **app.attachments.id** (string) - Required, if an attachment is provided - The ID of the attachment.
- **app.id** (string) - Required - The ID of the application.
- **app.subject** (string) - Required - The subject for the new work instance.
- **app.tasks** (array of objects) - Required - The array of tasks associated with the instance.
  - **app.tasks.assignedTo** (string) - Required - The ID of the user to whom the task is assigned.
  - **app.tasks.id** (string) - Required, unless it's a new task - The ID of the task.
  - **app.tasks.name** (string) - Required - The name of the task.
- **app.details** (string) - Optional - The details for the new work instance.
- **app.mailOnCompletion** (boolean) - Optional - Set to `true` to send a notification email when the work item is completed, or `false` to omit sending an email.
- **app.tasks.approvalStep** (boolean) - Optional - Set to `true` for an approval step, and omit or set to `false` for a step that is not an approval.
- **app.tasks.dueDateExpression** (string) - Optional - The expression that specifies the due date must be in the following format: `yyyy/mm/dd`.
- **app.timeZoneId** (string) - Optional - The timezone to start the instance in.

### Request Example
* Using User Service ID OAuth 2 client credentials:
```bash
curl -i -X POST \
  'https://your_server_url/scr/api/LaunchInstance?version=20110917' \
  --data-urlencode 'instance={"app":{"subject":"New for test.","id":"5f500e12a00ee","details":"my sample details","mailOnCompletion":false,"tasks":[{"name":"task1","id":"5f501e134ae2f","assignedTo":"7f0002","approvalStep":false}],"attachments":[]}}' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer access_token'
```
* Using Service ID OAuth 2 client credentials:
```bash
curl -i -X POST \
  'https://your_server_url/scr/api/LaunchInstance?version=20110917' \
  --data-urlencode 'instance={"app":{"subject":"New for test.","id":"5f500e12a00ee","details":"my sample details","mailOnCompletion":false,"tasks":[{"name":"task1","id":"5f501e134ae2f","assignedTo":"7f0002","approvalStep":false}],"attachments":[]}}' \
  --header 'Accept: application/json' \
  --header 'X-On-Behalf-Of:user_name@domain.com' \
  --header 'Authorization: Bearer access_token'
```

### Response
#### Success Response (200)
- **work** (object) - Contains details of the launched work instance.
  - **runtimeVersion** (array of strings) - Runtime version information.
  - **details** (string) - Details of the work instance.
  - **canManageWork** (boolean) - Indicates if the user can manage the work.
  - **name** (string) - The name of the work instance.
  - **subject** (string) - The subject of the work instance.
  - **tasks** (array of objects) - Array of tasks associated with the work instance.
    - **status** (string) - The status of the task.
    - **assignedTo** (string) - The user assigned to the task.
    - **name** (string) - The name of the task.
    - **id** (string) - The ID of the task.
    - **approvalStep** (boolean) - Indicates if the task is an approval step.
  - **attachments** (array) - Array of attachments associated with the work instance.
  - **status** (string) - The status of the work instance.
  - **comments** (array) - Array of comments for the work instance.

#### Response Example
```json
{
   "work":{
      "runtimeVersion":[
         "ede1c9df-61be-4774-99ab-196ec6742d57",
         "5f501e134ae25",
         1
      ],
      "details":"my sample details",
      "canManageWork":true,
      "name":"ProcessApp with multiple tasks A - New for test.",
      "subject":"New for test.",
      "tasks":[
         {
            "status":"NotStarted",
            "assignedTo":"7f0002",
            "name":"task 1",
            "id":"5f501e134ae2f",
            "approvalStep":false
         }
      ],
      "attachments":[

      ],
      "status":"Active",
      "comments":[

      ]
   }
}
```
```

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

### LaunchInstance API

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-launchinstance

This API endpoint allows you to start a new work instance from an application definition.

```APIDOC
## POST /scr/api/LaunchInstance

### Description
Use this resource to start a new work instance from an application definition.

### Method
POST

### Endpoint
/scr/api/LaunchInstance

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **applicationDefinitionId** (string) - Required - The ID of the application definition to launch an instance from.
* **initialData** (object) - Optional - Initial data for the work instance.

### Request Example
```json
{
  "applicationDefinitionId": "app-def-123",
  "initialData": {
    "field1": "value1",
    "field2": 123
  }
}
```

### Response
#### Success Response (200)
- **instanceId** (string) - The ID of the newly created work instance.
- **status** (string) - The status of the launched instance.

#### Response Example
```json
{
  "instanceId": "instance-abc-456",
  "status": "Launched"
}
```
```

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

### Get All Revisions (cURL)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=reporting-revision

This example shows how to retrieve all revisions, including system-created ones, for a given artifact ID using cURL. It includes options for different OAuth 2 authentication methods and the 'X-On-Behalf-Of' header.

```curl
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/revision/process/130024?showAll=true"
```

```curl
curl -i -H "Authorization: Bearer access_token 
"https://your_server_url/scr/api/revision/process/130024?showAll=true"
```

```curl
curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/revision/process/130024?showAll=true"
```

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

### Provision User with All Parameters (cURL)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-provisionuser

This cURL command demonstrates provisioning a user with all available parameters, including username, full name, license level, administrator status, and user groups. It requires authentication and specifies JSON content type and API version.

```curl
curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
    -X PUT --data "{\"username\":\"john.smith@us.ibm.com\",\"fullname\":\"John Smith\",\"license\":\"EDITOR\",\"admin\":true,
    \"usergroups\":[{\"groupname\":\"group1\"},{\"groupname\":\"group2\"}]}" "https://your_server_url/scr/api/provision/user/"
```

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

### Example Blueprint Work Summary Response (JSON)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=blueprints-blueprintsblueprint-idwork-summary

This JSON structure represents the successful response when retrieving the work summary for a blueprint. It includes details such as work ID, instance name, status, and information about who started the process and when.

```json
[
  {
    "workId": "3e0001",
    "instanceName": "workHistory-processApp - in progress pa",
    "status": "In progress",
    "processStartedBy": {
      "userId": "7f0002",
      "fullName": "admin"
    },
    "processStartedOn": "2025-01-16T11:36:50.671+0000"
  },
  {
    "workId": "1e0025",
    "instanceName": "workHistory-processApp - Review for Process test process",
    "status": "Completed",
    "completedTime": "2025-01-09T06:11:42.180+0000",
    "processStartedBy": {
      "userId": "7f0002",
      "fullName": "admin"
    },
    "processStartedOn": "2025-01-09T06:11:34.699+0000"
  }
]
```

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

### IBM Blueworks Live - Screening Visit Activity Example

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=reporting-search

This JSON snippet details the 'Screening Visit' activity within an IBM Blueworks Live project. It highlights multiple inputs required for the visit, such as candidate instructions and directions, along with the expected output (Sample) and participants like the 'Candidate'.

```json
{
   "business owners": [
      {
         "id": "d0002",
         "name": "Human Resources"
      }
   ],
   "cycleTime": [
      {
         "name": "60"
      }
   ],
   "experts": [
      {
         "id": "d0002",
         "name": "Human Resources"
      }
   ],
   "id": "d0201",
   "inputs": [
      {
         "id": "d002b",
         "name": "Candidate Instructions"
      },
      {
         "id": "d002c",
         "name": "Schedule time for visit"
      },
      {
         "id": "d002d",
         "name": "Directions to Screening Firm"
      }
   ],
   "name": "Screening Visit",
   "outputs": [
      {
         "id": "d002e",
         "name": "Sample"
      }
   ],
   "participants": [
      {
         "id": "d002a",
         "name": "Candidate"
      }
   ]
}
```

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

### Get Specific User Response (JSON)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-provisionuser

Example JSON output for retrieving details of a specific user in IBM Blueworks Live. This includes user's full name, username, license, business unit, and administrative/active status.

```json
{
  "fullname": "John Smith",
  "username": "john.smith4@acme.com",
  "license": "VIEWER",
  "businessunit": {
      "name": "Shipping",
      "id": "150007"
  },
  "admin": false,
  "active": true
}
```

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

### Launch New Work Instance using cURL (Service ID)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-launchinstance

This cURL example shows how to launch a new work instance using the LaunchInstance API with Service ID OAuth 2.0 client credentials. It includes the necessary 'X-On-Behalf-Of' header to specify the user context, along with the instance payload and authorization token.

```bash
curl -i -X POST \
  'https://your_server_url/scr/api/LaunchInstance?version=20110917' \
  --data-urlencode 'instance={"app":{"subject":"New for test.","id":"5f500e12a00ee","details":"my sample details","mailOnCompletion":false,"tasks":[{"name":"task1","id":"5f501e134ae2f","assignedTo":"7f0002","approvalStep":false}],"attachments":[]}}' \
  --header 'Accept: application/json' \
  --header 'X-On-Behalf-Of:user_name@domain.com' \
  --header 'Authorization: Bearer access_token'
```

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

### JSON Response Structure for Work Detail

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-workdetail

Example JSON output returned by the GET /scr/api/WorkDetail endpoint. This structure contains comprehensive details about the work item, including its status, name, tasks, attachments, and associated application information.

```json
{
  "work": {
    "runtimeVersion": [
      "ede1c9df-61be-4774-99ab-196ec6742d57",
      "5f501e134c6bf",
      2
    ],
    "details": "my sample details",
    "canManageWork": true,
    "name": "ProcessApp 1 approval task - New for test.",
    "subject": "New for test.",
    "tasks": [
      {
        "isApproved": false,
        "status": "Completed",
        "assignedTo": "7f0002",
        "name": "toBeApproved/Rejected",
        "id": "5f501e134c6ce",
        "approvalStep": true
      },
      {
        "status": "NotStarted",
        "dueDate": 2554358399278,
        "assignedTo": "7f0002",
        "name": "New task.",
        "id": "5f501e134c6e2",
        "approvalStep": false
      }
    ],
    "attachments": [
      {
        "size": 3.0,
        "uploadedBy": "7f0002",
        "type": 9,
        "name": "foo.txt",
        "id": "5f500e1349358",
        "canDelete": true,
        "uploadedOn": 1441206442048
      }
    ],
    "status": "Active",
    "comments": [],
    "startedAt": 1441219222958,
    "startedBy": "7f0002",
    "id": "5f501e134c6bf",
    "appId": "5f500e1349338"
  },
  "app": {
    "detailsTitle": null,
    "type": "workflow",
    "name": "ProcessApp 1 approval task",
    "id": "5f500e1349338",
    "subjectTitle": null
  },
  "version": "20110917",
  "users": [
    {
      "avatarId": "5f500e1260203",
      "name": "admin",
      "id": "7f0002"
    }
  ]
}
```

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

### Get User-Created Revisions (cURL)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=reporting-revision

This example demonstrates how to retrieve only user-created revisions for a specific artifact ID using cURL. It shows variations for User Service ID and Service ID OAuth 2 authentication, including the use of the 'X-On-Behalf-Of' header for user context.

```curl
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/revision/process/130024"
```

```curl
curl -i -H "Authorization: Bearer access_token 
 "https://your_server_url/scr/api/revision/process/130024"
```

```curl
curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/revision/process/130024"
```

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

### Sample CSV Data for User Details

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=management-provisionuser

This is a sample content for the 'usersdetail.csv' file, which is used by the MS-DOS script to provide user information for provisioning. Each line represents a user, with comma-separated values for username, full name, license, admin status, and group memberships.

```csv
abc@ibm.com,john smith,editor,true, groupA, groupB
bac@ibm.com,smith john,community,false,group1, groupB
```

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

### Example Response with System Revisions (JSON)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=reporting-revision

This JSON output illustrates the response when fetching all revisions, including system-created ones, for a process. It expands the 'revisions' array to include system snapshots alongside user snapshots, indicating the full history.

```json
{
   "creationTime": "2013-01-14T07:22:03-0500",
   "id": "130024",
   "hasDiagram": "true",
   "lastModified": "2013-01-14T07:51:22-0500",
   "revisions": [
      {
         "id": "130089", 
         "hasDiagram": "true",
         "label": "Second Snapshot",
         "time": "2013-01-14T07:51:22-0500",
         "revisionType": "userSnapshot"
      },
      {
         "id": "130065", 
         "hasDiagram": "true",
         "label": "First Snapshot",
         "time": "2013-01-14T07:48:00-0500",
         "revisionType": "userSnapshot"
      },
      {
         "id": "130055",
         "hasDiagram": "false",
         "label": "Before diagram creation",
         "time": "2013-01014T07:20:22-0500",
         "revisionType": "systemSnapshot"
      },
   ],
   "tip": "130089"
}
```

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

### Get Task List Count (cURL)

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-tasklistcount

Example cURL requests to retrieve the count of assigned or completed tasks for a user. Supports both User Service ID and Service ID OAuth 2.0 client credentials. Requires specifying the task 'type' and API 'version'.

```curl
curl -i -H "Authorization: Bearer access_token" \
"https://your_server_url/scr/api/TaskListCount?type=completed&version=20110917"
```

```curl
curl -i -H "Authorization: Bearer access_token" \
    -H "X-On-Behalf-Of:user_name@domain.com" \
    "https://your_server_url/scr/api/TaskListCount?type=completed&version=20110917"
```

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

### Deprecated `GET /api/Auth` API

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=notes-deprecated-features

The `GET /api/Auth` API, used for validating user accounts, is deprecated.

```APIDOC
## Deprecation Notice: `GET /api/Auth` API

### Description
The `GET /api/Auth` API method to validate a user account is deprecated.

### Action
No specific action is listed, but implies a need to find an alternative method.
```

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

### Application Information API

Source: https://www.ibm.com/docs/en/blueworks-live/index_topic=apis-launchinstance

Provides details about the application that initiated a work instance, including its name, ID, and titles for subject and details fields.

```APIDOC
## Application Information API

### Description
This section details the application context for a work instance. It includes information about the originating application, such as its name, ID, and the labels used for user-entered subject and details.

### Method
(Not applicable for data structure description)

### Endpoint
(Not applicable for data structure description)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for data structure description)

### Response
#### Success Response (200)
- **app** (object) - Information about the application.
  - **app.name** (string) - The name of the application that started the work instance.
  - **app.id** (string) - The unique identifier of the application.
  - **app.subjectTitle** (string) - The title for the subject field in the application's user interface.
  - **app.detailsTitle** (string) - The title for the details field in the application's user interface.
  - **app.type** (string) - The type of the application. Possible values: `workflow`, `checklist`.

#### Response Example
```json
{
  "app": {
    "name": "Blueworks Live Workflow",
    "id": "BWL-WF-101",
    "subjectTitle": "Process Name",
    "detailsTitle": "Process Description",
    "type": "workflow"
  }
}
```
```
Tokens:
Raw