查询流程列表
功能介绍
查询流程列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id |
|
workspace_id |
是 |
String |
工作空间id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量 |
|
limit |
否 |
Integer |
数据量 |
|
order |
否 |
String |
排序顺序，asc：升序，desc：降序 |
|
sortby |
否 |
String |
排序字段，create_time：创建时间，category：类型分类名称 |
|
enabled |
否 |
Boolean |
是否启用 |
|
last_version |
否 |
Boolean |
最新版本号 |
|
name |
否 |
String |
流程名称 |
|
description |
否 |
String |
流程描述 |
|
dataclass_id |
否 |
String |
数据类ID |
|
dataclass_name |
否 |
String |
数据类名称 |
|
aop_type |
否 |
String |
流程类型 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
|
content-type |
是 |
String |
内容类型 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
返回码 |
|
total |
Integer |
数据总条数 |
|
offset |
Integer |
当前页大小 |
|
limit |
Integer |
当前页码 |
|
message |
String |
请求ID |
|
success |
Boolean |
是否成功 |
|
data |
Array of AopWorkflowInfo objects |
流程信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
流程ID |
|
name |
String |
流程名称 |
|
description |
String |
描述 |
|
project_id |
String |
租户ID |
|
owner_id |
String |
所有者ID |
|
creator_id |
String |
创建者ID |
|
edit_role |
String |
编辑角色 |
|
use_role |
String |
是用角色 |
|
approve_role |
String |
审核人 |
|
enabled |
Boolean |
是否已启用 |
|
workspace_id |
String |
工作空间ID |
|
version_id |
String |
流程版本ID |
|
current_approval_version_id |
String |
当前待审核版本号 |
|
current_rejected_versoin_id |
String |
当前拒绝的版本号 |
|
aop_type |
String |
aop的类型有以下的值 NORMAL, 通用 SURVEY, 调查 HEMOSTASIS,止血 EASE;缓解 |
|
engine_type |
String |
引擎的类型分为共享版和专项版 |
|
dataclass_id |
String |
数据类的ID |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
查询流程列表，偏移量为10，查询3条
{
"limit" : 3,
"offset" : 10
}
响应示例
状态码：200
请求成功
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"message" : "Error message",
"total" : 41,
"limit" : 2,
"offset" : 1,
"success" : true,
"data" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "流程名称",
"description" : "描述",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"edit_role" : "编辑者",
"use_role" : "使用者",
"approve_role" : "审批者",
"enabled" : true,
"workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"current_approval_version_id" : "v2",
"current_rejected_versoin_id" : "v1",
"aop_type" : "EASE;缓解",
"engine_type" : "public_engine",
"dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
查询数据类列表错误返回body体 |
错误码
请参见错误码。
