Get Process View Columns¶

获取流程视图列信息。

请求格式¶

GET https://{apigw-address}/enos-bpm-service/v2.0/work/display-view/{displayViewKey}/columns

请求参数（Header）¶

名称	位置	必需/可选	数据类型	描述
Authorization	Header	必需	String	Access Token，以 Bearer Token 表示，需要通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
displayViewKey	Path	必需	String	流程视图的键。

响应参数¶

名称	数据类型	描述
data	data 结构体数组	流程视图列信息数组。

data 结构体¶

名称	数据类型	描述
id	String	流程视图列 ID。
title	String	流程视图列名称。
displayViewKey	String	流程视图的键。
bindProperty	String	流程视图列展示的流程属性的名称。
defaultVisibility	Boolean	流程视图列默认可见性。
fixedVisibility	Boolean	流程视图列是否设置固定可见。
filterable	Boolean	流程视图列是否支持筛选。
fixedFilterable	Boolean	流程视图列是否设置固定筛选。
type	String	流程视图列类型。
source	String	流程试图列为系统生成或自定义。
order	Integer	流程视图列次序。
warning	Boolean	流程视图列对应变量是否在最新版本流程定义中已经删除。
options	Option 结构体	下拉类型流程视图列选项。

Option 结构体¶

名称	数据类型	描述
name	String	流程视图列选项名称。
value	String	流程视图列选项值。

错误码¶

代码	描述
33404	流程视图的键不存在。

示例¶

请求示例¶

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}"}

返回示例¶

{
  "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 调用示例¶

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);
    }
}