Get Process View Columns¶
Get the information of process view columns.
Request Format¶
GET https://{apigw-address}/enos-bpm-service/v2.0/work/display-view/{displayViewKey}/columns
Request Parameters (Header)¶
Name | Location | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
Authorization | Header | Mandatory | String | The access token, which is represented by the bearer token. It can be obtained by invoking the Log In or Refresh Access Token API. |
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
displayViewKey | Path | Mandatory | String | The process view key. |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | Data Struct | The information of process view columns. |
Data Struct¶
Name | Data Type | Description |
---|---|---|
id | String | The process view column ID. |
title | String | The process view column name. |
displayViewKey | String | The process view key. |
bindProperty | String | The name of the process property displayed in the process view column. |
defaultVisibility | Boolean | The default visibility of process view column. |
fixedVisibility | Boolean | Whether the process view column is set to be constantly visible. |
filterable | Boolean | Whether filter is enabled for the process view column. |
fixedFilterable | Boolean | Whether filterable can be modified for the process view column. |
type | String | The process view column type. |
source | String | Whether the source of the process view column is system or custom. |
order | Integer | The order of the process view column. |
warning | Boolean | Whether variable corresponding to the process view column has been deleted in the latest version of the process definition. |
options | Option Struct | The options of a drop-down type process view column. |
Option Struct¶
Name | Data Type | Description |
---|---|---|
name | String | The name of an option in the process view column. |
value | String | The value of an option in the process view column. |
Error Codes¶
Code | Description |
---|---|
33404 | The process view key does not exist. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-bpm-service/v2.0/work/display-view/{your_display_view_key}/columns
method: GET
headers: {"Authorization":"Bearer {your_access_token}"}
Return Sample¶
{
"code": 0,
"msg": "",
"data": [
{
"id": "a6574b142f8a511eab997105badde4ea7",
"title": "Process Name",
"displayViewKey": "C10S_TEST11",
"bindProperty": "name",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": true,
"type": "Single-Select List",
"source": "System",
"order": 0
},
{
"id": "a6574b143f8a511eab997105badde4ea7",
"title": "Started by",
"displayViewKey": "C10S_TEST11",
"bindProperty": "startedBy",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Single-Select List",
"source": "System",
"order": 1,
"options": [
{
"name": "user01",
"value": "u15578231118721"
},
{
"name": "user02",
"value": "u15644810865581"
},
{
"name": "user03",
"value": "u15719991268501"
}
]
},
{
"id": "a6574b144f8a511eab997105badde4ea7",
"title": "Time Started",
"displayViewKey": "C10S_TEST11",
"bindProperty": "started",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Time",
"source": "System",
"order": 2
},
{
"id": "a6574b145f8a511eab997105badde4ea7",
"title": "Status",
"displayViewKey": "C10S_TEST11",
"bindProperty": "processStatus",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Single-Select List",
"source": "System",
"order": 3,
"options": [
{
"name": "inProgress",
"value": "inProgress"
},
{
"name": "terminated",
"value": "terminated"
},
{
"name": "completed",
"value": "completed"
}
]
},
{
"id": "a6574b146f8a511eab997105badde4ea7",
"title": "Current Task",
"displayViewKey": "C10S_TEST11",
"bindProperty": "taskName",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": false,
"fixedFilterable": true,
"type": "Single-Select List",
"source": "System",
"order": 4
},
{
"id": "a6574b147f8a511eab997105badde4ea7",
"title": "Current Assignee",
"displayViewKey": "C10S_TEST11",
"bindProperty": "assignee",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": false,
"fixedFilterable": true,
"type": "Single-Select List",
"source": "System",
"order": 5
},
{
"id": "a6574b148f8a511eab997105badde4ea7",
"title": "Time Completed",
"displayViewKey": "C10S_TEST11",
"bindProperty": "completedTime",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Time",
"source": "System",
"order": 6
},
{
"id": "a6574b149f8a511eab997105badde4ea7",
"title": "Time Terminated",
"displayViewKey": "C10S_TEST11",
"bindProperty": "terminatedTime",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Time",
"source": "System",
"order": 7
},
{
"id": "a6574b14af8a511eab997105badde4ea7",
"title": "Terminator",
"displayViewKey": "C10S_TEST11",
"bindProperty": "terminatedBy",
"defaultVisibility": true,
"fixedVisibility": false,
"filterable": true,
"fixedFilterable": false,
"type": "Single-Select List",
"source": "System",
"order": 8,
"options": [
{
"name": "user01",
"value": "u15578231118721"
},
{
"name": "user02",
"value": "u15644810865581"
},
{
"name": "user03",
"value": "u15719991268501"
}
]
},
{
"id": "a6574b14bf8a511eab997105badde4ea7",
"title": "Process Instance ID",
"displayViewKey": "C10S_TEST11",
"bindProperty": "processInstanceId",
"defaultVisibility": true,
"fixedVisibility": true,
"filterable": true,
"fixedFilterable": false,
"type": "Text",
"source": "System",
"order": 9
}
]
}
Java SDK Sample¶
public class BpmSdkTest{
@Test
public void getProcessViewColumnsTest() {
String bearerToken = "your_bearer_token";
String displayViewKey = "your_display_view_key";
DisplayViewColumnsRequest request = new DisplayViewColumnsRequest(displayViewKey, bearerToken);
DisplayViewColumnsResponse response = getPoseidon().getResponse(request, DisplayViewColumnsResponse.class);
assertNotNull("response cannot be null", response);
}
}