飞书开放平台 Server API 文档

主题

获取单个流程详情 ​

根据流程实例 id（process_id）获取单个流程详情（此功能不受数据权限范围控制）。比如流程状态、流程发起人、流程发起时间、流程摘要、流程里的所有待办、已办、抄送任务等。

Tip: 休假类型流程的“撤销”的实例状态，以及是否属于“更正流程”需要去休假的批量查询员工请假记录 接口查询

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/processes/:process_id
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:process:read 获取流程数据
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数 ​

名称类型描述
process_idstring流程实例ID。可通过查询流程实例列表接口获取
示例值："7278949005675988535"

查询参数 ​

名称类型必填描述
user_id_typestring否用户 ID 类型
示例值：open_id
可选值有：
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - people_corehr_id: 以飞书人事的 ID 来识别用户
默认值：open_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ process_idstring流程实例ID
  └ statusint流程状态
可选值有：
- 1: 进行中 - 2: 拒绝 - 4: 撤回 - 8: 撤销 - 9: 已完成 - 15: 撤销中
  └ flow_template_idstring业务类型ID
  └ flow_template_namedataengine_i18n业务类型名称
    └ zh_cnstring中文值
    └ en_usstring英文值
  └ flow_definition_idstring流程定义ID
  └ flow_definition_namedataengine_i18n流程定义名称
    └ zh_cnstring中文值
    └ en_usstring英文值
  └ initiator_idstring流程发起人ID，当发起人为系统时，该字段返回为空
  └ initiator_namedataengine_i18n流程发起人姓名
    └ zh_cnstring中文值
    └ en_usstring英文值
  └ create_timestring流程发起时间，Unix毫秒时间戳
  └ complete_timestring流程结束时间，Unix毫秒时间戳
  └ start_linksprocess_link发起单据地址
    └ web_linkstringweb端单据详情页地址
    └ pc_linkstring飞书pc端单据详情页地址
    └ mobile_linkstring飞书移动端单据详情页地址
  └ abstractsprocess_abstract_item\[\]流程摘要，会随着流程流转发生变化
    └ namedataengine_i18n摘要标题
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ valuedataengine_i18n摘要值
      └ zh_cnstring中文值
      └ en_usstring英文值
  └ todosprocess_todo_item\[\]待办列表
    └ approver_idstring单据ID,注意单据id和operator_id并不是一对一的
    └ typeint单据类型
可选值有：
- 1: 审批单 - 5: 表单
    └ linksprocess_link单据地址
      └ web_linkstringweb端单据详情页地址
      └ pc_linkstring飞书pc端单据详情页地址
      └ mobile_linkstring飞书移动端单据详情页地址
    └ operator_idstring待办人ID，每个节点下待办人标识唯一
    └ operator_namedataengine_i18n操作人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ node_namedataengine_i18n节点名称
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ create_timestring创建时间，Unix毫秒时间戳
    └ node_definition_idstring节点定义ID（注：在回退场景，同一个节点会对应多个节点实例）
  └ cc_listprocess_cc_item\[\]抄送列表
    └ approver_idstring单据ID
    └ linksprocess_link单据地址
      └ web_linkstringweb端单据详情页地址
      └ pc_linkstring飞书pc端单据详情页地址
      └ mobile_linkstring飞书移动端单据详情页地址
    └ operator_idstring抄送人ID
    └ operator_namedataengine_i18n抄送人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ node_namedataengine_i18n节点名称
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ create_timestring抄送时间，Unix毫秒时间戳
    └ node_definition_idstring节点定义ID（注：在回退场景，同一个节点会对应多个节点实例）
  └ done_listprocess_done_item\[\]已办列表
    └ approver_idstring单据ID
    └ typeint单据类型
可选值有：
- 1: 审批单 - 5: 表单
    └ statusint单据状态
可选值有：
- 3: 已完成 - 2: 拒绝 - 4: 取消
    └ linksprocess_link单据地址
      └ web_linkstringweb端单据详情页地址
      └ pc_linkstring飞书pc端单据详情页地址
      └ mobile_linkstring飞书移动端单据详情页地址
    └ operator_idstring操作人ID
    └ operator_namedataengine_i18n操作人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ node_namedataengine_i18n节点名称
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ create_timestring创建时间，Unix毫秒时间戳
    └ complete_timestring完成时间，Unix毫秒时间戳
    └ node_definition_idstring节点定义ID（注：在回退场景，同一个节点会对应多个节点实例）
    └ approval_opinionstring审批意见
  └ propertiesint普通流程或撤销流程等
可选值有：
- 1: 普通流程 - 2: 撤销流程，返回这个属性的前提是在审批中心我发起的页面进行撤销操作 - 3: 更正流程，返回这个属性的前提是在审批中心我发起的页面进行更正操作
  └ system_todosprocess_system_todo_item\[\]系统待办列表
    └ approver_idstring单据ID
    └ typeint单据类型
可选值有：
- 1: 审批单 - 5: 表单
    └ linksprocess_link单据地址
      └ web_linkstringweb端单据详情页地址
      └ pc_linkstring飞书pc端单据详情页地址
      └ mobile_linkstring飞书移动端单据详情页地址
    └ operator_namedataengine_i18n操作人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ node_namedataengine_i18n节点名称
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ create_timestring创建时间，Unix毫秒时间戳
    └ node_definition_idstring节点定义ID（注：在回退场景，同一个节点会对应多个节点实例）
  └ system_done_listprocess_system_done_item\[\]系统已办列表
    └ approver_idstring单据ID
    └ typeint单据类型
可选值有：
- 1: 审批单 - 5: 表单
    └ statusint单据状态
可选值有：
- 3: 已完成 - 2: 拒绝 - 4: 取消
    └ linksprocess_link单据地址
      └ web_linkstringweb端单据详情页地址
      └ pc_linkstring飞书pc端单据详情页地址
      └ mobile_linkstring飞书移动端单据详情页地址
    └ operator_namedataengine_i18n操作人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ node_namedataengine_i18n节点名称
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ create_timestring创建时间，Unix毫秒时间戳
    └ complete_timestring完成时间，Unix毫秒时间戳
    └ node_definition_idstring节点定义ID（注：在回退场景，同一个节点会对应多个节点实例）
    └ approval_opinionstring审批意见
  └ comment_infosprocess_comment_info\[\]评论列表
    └ commentor_idstring评论人ID
    └ commentor_namedataengine_i18n评论人姓名
      └ zh_cnstring中文值
      └ en_usstring英文值
    └ comment_timestring评论时间,Unix毫秒时间戳
    └ comment_msgstring评论内容
    └ at_user_idsstring\[\]在评论中被提及（@）到的人的id列表
    └ file_countint评论中附件数量
    └ image_countint评论中图片数量
    └ comment_idstring一条评论的唯一id
  └ original_process_idstring更正或撤销流程的原流程ID
  └ is_last_completed_correct_processboolean是否最新的「已完成」的更正流程
  └ process_namedataengine_i18n流程实例名称，取流程发起时的流程定义名称
    └ zh_cnstring中文值
    └ en_usstring英文值

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "process_id": "7278949005675988535",
        "status": 9,
        "flow_template_id": "leave",
        "flow_template_name": {
            "zh_cn": "中文",
            "en_us": "English"
        },
        "flow_definition_id": "people_6961286846093788680_7081951411982077732",
        "flow_definition_name": {
            "zh_cn": "中文",
            "en_us": "English"
        },
        "initiator_id": "7124991993901827628",
        "initiator_name": {
            "zh_cn": "中文",
            "en_us": "English"
        },
        "create_time": "1694769814036",
        "complete_time": "1694769814036",
        "start_links": {
            "web_link": "http://xxxx.com/xxx/xxx?a=b",
            "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
            "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
        },
        "abstracts": [
            {
                "name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "value": {
                    "zh_cn": "中文",
                    "en_us": "English"
                }
            }
        ],
        "todos": [
            {
                "approver_id": "7278949005675988535",
                "type": 1,
                "links": {
                    "web_link": "http://xxxx.com/xxx/xxx?a=b",
                    "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
                    "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
                },
                "operator_id": "7124991993901827628",
                "operator_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "node_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "create_time": "1694769814036",
                "node_definition_id": "approval_d25b5eddfef"
            }
        ],
        "cc_list": [
            {
                "approver_id": "7278949005675988535",
                "links": {
                    "web_link": "http://xxxx.com/xxx/xxx?a=b",
                    "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
                    "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
                },
                "operator_id": "7124991993901827628",
                "operator_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "node_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "create_time": "1694769814036",
                "node_definition_id": "approval_d25b5eddfef"
            }
        ],
        "done_list": [
            {
                "approver_id": "7278949005675988535",
                "type": 1,
                "status": 3,
                "links": {
                    "web_link": "http://xxxx.com/xxx/xxx?a=b",
                    "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
                    "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
                },
                "operator_id": "7124991993901827628",
                "operator_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "node_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "create_time": "1694769814036",
                "complete_time": "1694769814036",
                "node_definition_id": "approval_d25b5eddfef",
                "approval_opinion": "审批意见"
            }
        ],
        "properties": 2,
        "system_todos": [
            {
                "approver_id": "7278949005675988535",
                "type": 1,
                "links": {
                    "web_link": "http://xxxx.com/xxx/xxx?a=b",
                    "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
                    "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
                },
                "operator_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "node_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "create_time": "1694769814036",
                "node_definition_id": "approval_d25b5eddfef"
            }
        ],
        "system_done_list": [
            {
                "approver_id": "7278949005675988535",
                "type": 1,
                "status": 3,
                "links": {
                    "web_link": "http://xxxx.com/xxx/xxx?a=b",
                    "pc_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx",
                    "mobile_link": "https://applink.feishu.cn/client/mini_program/open?appId=xxx"
                },
                "operator_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "node_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "create_time": "1694769814036",
                "complete_time": "1694769814036",
                "node_definition_id": "approval_d25b5eddfef",
                "approval_opinion": "审批意见"
            }
        ],
        "comment_infos": [
            {
                "commentor_id": "7355397217231831060",
                "commentor_name": {
                    "zh_cn": "中文",
                    "en_us": "English"
                },
                "comment_time": "1694769814036",
                "comment_msg": "评论内容",
                "at_user_ids": [
                    "7355397217231831060"
                ],
                "file_count": 10,
                "image_count": 10,
                "comment_id": "7355397217231831060"
            }
        ],
        "original_process_id": "7278949005675988535",
        "is_last_completed_correct_process": false,
        "process_name": {
            "zh_cn": "中文",
            "en_us": "English"
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
5001160500system error系统异常，请联系技术支持协助排查
4001160101invalid param参数错误，请按照接口字段说明自查

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有