获取用户所属空间的流程列表
功能介绍
获取用户所属空间的流程列表。
URI
GET /v1/{project_id}/eihealth-projects/workflows
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
is_creator |
否 |
Boolean |
参数解释: 是否仅展示本人创建资源。 约束限制: 不涉及 取值范围:
默认取值: true |
id |
否 |
String |
参数解释: 流程ID,仅支持精确搜索。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
name |
否 |
String |
参数解释: 流程名称,支持模糊搜索。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线,长度为[1-56]个字符。 默认取值: 不涉及 |
summary |
否 |
String |
参数解释: 短描述,支持模糊搜索。 约束限制: 不涉及 取值范围: 长度为[1-1024]个字符。 默认取值: 不涉及 |
eihealth_project_names |
否 |
Array of strings |
参数解释: 空间名称列表,多个值之间使用逗号分隔。 约束限制: 空间名称数量限制为[0,10]个,每个空间名称长度限制为[1-512]个字符。 取值范围: 不涉及 默认取值: 不涉及 |
labels |
否 |
Array of strings |
参数解释: 标签列表。 约束限制: 标签数量限制为[0,5]个,每个标签长度限制为[1-32]个字符。 取值范围: 不涉及 默认取值: 不涉及 |
start_create_time |
否 |
Long |
参数解释: 开始创建时间。 约束限制: 不涉及 取值范围: [1000000000000-9999999999999] 默认取值: 不涉及 |
end_create_time |
否 |
Long |
参数解释: 结束创建时间。 约束限制: 不涉及 取值范围: [1000000000000-9999999999999] 默认取值: 不涉及 |
start_update_time |
否 |
Long |
参数解释: 开始更新时间。 约束限制: 不涉及 取值范围: [1000000000000-9999999999999] 默认取值: 不涉及 |
end_update_time |
否 |
Long |
参数解释: 结束更新时间。 约束限制: 不涉及 取值范围: [1000000000000-9999999999999] 默认取值: 不涉及 |
sort_dir |
否 |
String |
参数解释: 排序规则。 约束限制: 不涉及 取值范围:
默认取值: DESC |
sort_key |
否 |
String |
参数解释: 排序规则,默认根据创建时间降序,支持根据create_time|update_time排序。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: 必须由数字组成,默认为100,取值范围[1,1000]。 默认取值: 100 |
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: 必须由数字组成,默认为0,取值范围[0,100000000]。 默认取值: 0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
workflows |
Array of WorkflowListDto objects |
参数解释: 所查询类型的流程总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
count |
Integer |
参数解释: 当前页的流程列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 流程ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
String |
参数解释: 流程名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_id |
String |
参数解释: 流程所属空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_name |
String |
参数解释: 流程所属空间名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
version |
String |
参数解释: 流程版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
summary |
String |
参数解释: 简短描述信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
description |
String |
参数解释: 描述信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels |
Array of strings |
参数解释: 流程标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time |
String |
参数解释: 创建流程时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time |
String |
参数解释: 更新流程时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_name |
String |
参数解释: 创建用户名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_project_name |
String |
参数解释: 源项目名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_resource_id |
String |
参数解释: 源资源ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取用户所属空间的流程列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/workflows
响应示例
状态码:200
OK
{ "workflows" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-workflow", "eihealth_project_id" : "d57g37ee-831d-4f64-afca-e2fd05f0824d", "eihealth_project_name" : "demo-project", "version" : "1.0.0", "summary" : "summary", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "user_name" : "gwj-test-01" } ], "count" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。