飞书开放平台 Server API 文档

主题

获取流程表单数据 ​

根据流程实例 id（process_id）获取流程表单字段数据，包括表单里的业务字段和自定义字段。仅支持飞书人事、假勤相关业务流程。

Tip: 建议使用新版本 API 文档。详情参见获取流程表单数据。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/processes/:process_id/form_variable_data
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:corehr:readonly 获取核心人事信息 corehr:process:read 获取流程数据 corehr:corehr 更新核心人事信息

请求头 ​

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

路径参数 ​

名称类型描述
process_idstring流程实例 ID
示例值："123456987"

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ field_variable_valuesform_field_variable\[\]流程变量
    └ variable_api_namestring变量api名称
    └ variable_namebpm_dataengine_i18n变量名称的i18n描述
      └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
      └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
    └ variable_valueform_variable_value_info变量值的对象
      └ text_valueform_field_variable_text_value文本变量对象
        └ valuestring文本类型变量的值
      └ number_valueform_field_variable_number_value数值变量对象
        └ valuestring数值类型变量的值
      └ date_valueform_field_variable_date_value日期变量对象
        └ valueint日期变量的值，从1970起的天数
      └ employment_valueform_field_variable_employment_value员工变量对象
        └ valuestringemploymentID
        └ user_idstring员工ID 如3158117
      └ date_time_valueform_field_variable_datetime_value日期时间变量对象
        └ valueint毫秒的时间戳。注：此字段数据类型为 int64
        └ zonestring时区，+08:00
      └ enum_valueform_field_variable_enum_value枚举变量对象
        └ valuestring枚举值
        └ namebpm_dataengine_i18n枚举的名称
          └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
          └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
        └ descbpm_dataengine_i18n枚举的描述
          └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
          └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
      └ null_valueform_field_variable_null_value空变量对象
      └ bool_valueform_field_variable_bool_value布尔变量对象
        └ valueboolean布尔变量的值
      └ department_valueform_field_variable_department_value部门变量对象
        └ valuestring部门ID
      └ file_valueform_field_variable_file_value文件变量对象
        └ source_typeint文件源类型（1BPM; 2主数据）
        └ file_idstring文件id
        └ file_namestring文件名称
        └ lengthint文件长度
        └ mime_typestring扩展类型
      └ i18n_valueform_field_variable_i18n_valuei18n变量对象
        └ valuebpm_dataengine_i18ni18n值
          └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
          └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
      └ object_valueform_field_variable_object_value对象变量
        └ valuestring对象ID
        └ wk_api_namestring主数据apiName
      └ list_valueform_field_variable_list_value列表对象
        └ valuesform_field_variable_list_object\[\]列表值
          └ text_valueform_field_variable_text_value文本变量对象
            └ valuestring文本类型变量的值
          └ number_valueform_field_variable_number_value数值变量对象
            └ valuestring数值类型变量的值
          └ date_valueform_field_variable_date_value日期变量对象
            └ valueint日期变量的值，从1970起的天数
          └ employment_valueform_field_variable_employment_value员工变量对象
            └ valuestringemploymentID
            └ user_idstring员工ID 如3158117
          └ date_time_valueform_field_variable_datetime_value日期时间变量对象
            └ valueint毫秒的时间戳。注：此字段数据类型为 int64
            └ zonestring时区，+08:00
          └ enum_valueform_field_variable_enum_value枚举变量对象
            └ valuestring枚举值
            └ namebpm_dataengine_i18n枚举的名称
              └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
              └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
            └ descbpm_dataengine_i18n枚举的描述
              └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
              └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
          └ null_valueform_field_variable_null_value空变量对象
          └ bool_valueform_field_variable_bool_value布尔变量对象
            └ valueboolean布尔变量的值
          └ department_valueform_field_variable_department_value部门变量对象
            └ valuestring部门ID
          └ file_valueform_field_variable_file_value文件变量对象
            └ source_typeint文件源类型（1BPM; 2主数据）
            └ file_idstring文件id
            └ file_namestring文件名称
            └ lengthint文件长度
            └ mime_typestring扩展类型
          └ i18n_valueform_field_variable_i18n_valuei18n变量对象
            └ valuebpm_dataengine_i18ni18n值
              └ zh_cnstring（基于系统兼容性，该参数名称在文档中展示为zh_cn，但在实际返回的 JSON Key 中展示为 zh-CN）i18n类型字段，中文值
              └ en_usstring（基于系统兼容性，该参数名称在文档中展示为en_us，但在实际返回的 JSON Key 中展示为 en-US）i18n类型字段，英文值
          └ object_valueform_field_variable_object_value对象变量
            └ valuestring对象ID
            └ wk_api_namestring主数据apiName
          └ record_valueform_field_variable_record_value记录对象
            └ valuesform_field_variable_record_value_example注：该参数实际为 Map 数据类型，Key 是变量唯一标识，Value 是变量值。
              └ country_regionform_variable_value_info_example这个属性名称是map的key的示例，属性值是map的value的示例，值和外层的variable_value是的一样的结构。
                └ object_valueform_field_variable_object_value文本变量对象
                  └ valuestring对象ID
                  └ wk_api_namestring主数据apiName
      └ record_valueform_field_variable_record_value记录对象
        └ valuesform_field_variable_record_value_example注：该参数实际为 Map 数据类型，Key 是变量唯一标识，Value 是变量值。
          └ country_regionform_variable_value_info_example这个属性名称是map的key的示例，属性值是map的value的示例，值和外层的variable_value是的一样的结构。
            └ object_valueform_field_variable_object_value文本变量对象
              └ valuestring对象ID
              └ wk_api_namestring主数据apiName

响应体示例 ​

json
{
    "code": 0,
    "data":
    {
        "field_variable_values":
        [
            {
                "variable_api_name": "reason",
                "variable_name":
                {
                    "en-US": "Reason",
                    "zh-CN": "离职原因"
                },
                "variable_value":
                {
                    "enum_value":
                    {
                        "desc": null,
                        "enum_source_id": 123,
                        "enum_source_type": 2,
                        "name":
                        {
                            "en-US": "",
                            "zh-CN": "测试"
                        },
                        "value": "reason_for_offboarding_option96",
                        "wk_api_name": "reason_for_offboarding"
                    }
                }
            },
            {
                "variable_api_name": "offboarding_date",
                "variable_name":
                {
                    "en-US": "Offboarding date",
                    "zh-CN": "离职日期"
                },
                "variable_value":
                {
                    "date_value":
                    {
                        "value": 19265
                    }
                }
            },
            {
                "variable_api_name": "employment",
                "variable_name":
                {
                    "en-US": "Employment",
                    "zh-CN": "员工"
                },
                "variable_value":
                {
                    "employment_value":
                    {
                        "user_id": "123321",
                        "value": "123321"
                    }
                }
            }
        ],
        "process_id": "123321"
    },
    "msg": "",
    "success": true
}

错误码 ​

HTTP状态码错误码描述排查建议
4001160100审批流程不存在确认审批流程ID是否正确
5001160500服务端内部错误内部错误，建议联系飞书开发平台技术支持

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

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