查询审批定义列表
查询审批定义列表
标签:审批定义
请求说明
| 字段 | 值 |
|---|---|
请求地址 | https://openapi.wps.cn/v7/workflow/approval_defines/batch_get |
HTTP 方法 | GET |
接口描述 | 分页查询审批定义列表 |
签名方式 | KSO-1 |
限频策略 | 无 |
权限要求 | 查询审批定义(应用授权) kso.workflow_approval_define.read创建审批定义(应用授权) kso.workflow_approval_define.readwrite |
请求头 (Headers)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
X-Kso-Id-Type | string | 否 | 类型 * internal - 内部 * external - 外部 | internal, external |
查询参数 (Query)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
page_size | integer | 否 | 分页大小,取值范围10-50,默认为10 | - |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 | - |
group_id | string | 否 | 审批分组id,不传查所有审批分组 | - |
user_id | string | 否 | 指定用户的可见数据,不传查本租户下所有审批定义 | - |
get_range_type | string | 否 | 查询范围,不传查所有审批定义, user_id传入时才可传该值。get_range_type=user_manage:查指定用户管理的审批定义,get_range_type=user_visible:查指定用户的可见审批定义 | - |
name | string | 否 | 审批定义名 | - |
响应体(Response)
HTTP状态码: 200
响应体格式: application/json
没有可用的数据
响应体示例
json
{
"data": {
"has_more": true,
"items": [
{
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"ctime": "string",
"form_designs": [
{
"condition_groups": [
{
"conditions": [
{
"custom_data_rule": "string",
"elem_biz_key": "string",
"form_id": "string",
"rule": "belongs",
"type": "text_type_input",
"value": "string"
}
]
}
],
"date_range": {
"date_range_place": "string",
"duration_title": "string",
"end_time_title": "string",
"start_time_title": "string",
"style": "year_month",
"time_range": "all_dates"
},
"extra": "string",
"form_options": [
{
"key": "string",
"value": "string"
}
],
"id": "string",
"placeholder": "string",
"required": true,
"title": "string",
"type": "text_type_input"
}
],
"group_id": "string",
"icon": "tmp1",
"id": "string",
"name": "string",
"process_define": {
"nodes": [
{
"child_nodes": [
"string"
],
"condition_groups": [
{}
],
"extra": {
"config": {
"add_node_forbidden": true,
"edit_forbidden": true,
"remove_forbidden": true
}
},
"id": "string",
"name": "string",
"next_node_id": "string",
"task": {
"task_approve": {
"approval_rule": "step",
"select_type": "single_choice",
"target": {
"level": 0,
"select_ranges": [
{
"select_type": "user",
"select_value": "string"
}
],
"user_group_ids": [
"string"
],
"user_ids": [
"string"
],
"user_type": "optional"
},
"user_empty_policy": "transfer_to_admin"
},
"task_cc": {
"is_allow_add_cc": true,
"target": {}
},
"type": "approval"
},
"type": "sequence"
}
],
"root": "string"
},
"setting": {
"allow_revoke_approved_days": 0,
"approval_deduplicate_mode": "none",
"approval_share_to_company": true,
"is_allow_resubmit": true,
"is_allow_revoke": true,
"is_allow_revoke_approved": true,
"is_allow_rollback": true,
"is_show_in_backend_page": true,
"is_show_in_home_page": true,
"must_with_approve_signature": true,
"must_with_refuse_reason": true,
"must_with_return_reason": true,
"one_click_approval": true
},
"visible_scopes": [
{
"company_id": "string",
"is_admin": true,
"scope_id": "string",
"scope_type": "company"
}
]
}
],
"page_token": "string"
},
"code": 0,
"msg": "string"
}