# 查询工作流信息
用于查询工作流相关信息进行后续任务创建
注意事项:
- 查询时需要查询用户的userid为被查询工作流管理员/所有者，否则将不会返回结果信息
# 请求
| 基本 | |
|---|---|
| HTTP URL | https://hi-qa.weizhipin.com/open-apis/workflow/v1/detail/:user_id |
| HTTP Method | POST |
| 支持的应用类型 | 自建应用 |
| 权限要求开启任一权限即可 | [工作流]-[查询工作流信息] |
# 请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式："Bearer access_token"示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
# 路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）
| 名称 | 类型 | 描述 |
|---|---|---|
| user_id | string | 任务创建人id 示例值："CFBEWHDYGYGSL" |
# 查询参数（url后?&拼接的参数）
| 名称 | 类型 | 描述 |
|---|---|---|
| user_id_type | string | 请求参数内用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id时，存在字段权限要求，未开通则会调用失败： 请参见[应用权限管理]-[通讯录]- [获取用户ID] |
# 请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| workflow_name | string | 否 | 工作流名称 模糊匹配，与工作流id任一必填 |
| workflow_id | string | 否 | 工作流id 精确匹配，填写工作流id时会忽略其他query内容 |
| page_token | string | 否 | 分页参数 下一页游标，由上一查询结果获取 |
| page_size | int | 否 | 分页参数 当前页展示数量，默认每页查询20条，每次不超过100条 |
# 响应
# 响应体
{
"code": "0",
"traceId": "",
"data": {
"data": [{
"workflow_id": "qwerasdfzxcv",
//示例值
"workflow_name": "工作流名称",
//示例值
"workflow_description": "工作流描述",
//示例值
"workflow_groups": [
//示例值
{
"workflow_group_id": "id1",
"workflow_group_name": "name1"
},
{
"workflow_group_id": "id2",
"workflow_group_name": "name2"
}
],
"custom_fields_json": "{\"field1\":\"f1\",\"field2\":\"f2\"}" //示例值
}],
"page_size" : 1, //示例值
"page_token": "wertsdfgxvb" //示例值
},
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
data对象结构
| 名称 | 类型 | 描述 |
|---|---|---|
| workflow_id | string | 工作流id 用于开放平台接口请求的唯一工作流id |
| workflow_name | string | 工作流名称 |
| workflow_description | string | 工作流描述 |
| workflow_groups | string | 工作流分组信息 |
| ∟workflow_group_id | string | 工作流分组id |
| ∟workflow_group_name | string | 工作流分组名称 |
| custom_fields_json | string | 工作流自定义字段信息 |
| page_token | string | 分页参数 下一页游标，由上一查询结果获取 如果没有下一页值为空 |
| page_size | string | 分页参数 当前页展示数量，默认每页查询20条，每次不超过100条 |
如果响应非成功状态，请对照 错误码文档