# 发起流程 发起一个流程实例，目前只支持发起自定义业务类型的流程。 ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/process_start HTTP Method | POST 接口频率限制 | [20 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 通过或拒绝审批任务(corehr:process.instance:write) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
- people_corehr_id：以飞书人事的 ID 来识别用户
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) department_id_type | string | 否 | 此次调用中使用的部门 ID 类型
**示例值**：open_department_id
**可选值有**：
- open_department_id：以 open_department_id 来标识部门
- department_id：以 department_id 来标识部门
- people_corehr_department_id：以 people_corehr_department_id 来标识部门
**默认值**：`open_department_id` ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- flow_definition_id | string | 是 | 流程定义id
**示例值**："people_7023711013443944467_7437160904904494892" initiator_id | string | 否 | 发起人用户ID，按user_id_type类型传递。如果system_initiator为false，则必填；为true时非必填。
**示例值**："ou_91791271921729102012" system_initiator | boolean | 否 | 是否为系统身份发起流程，如果为false，则initiator_id必填
**示例值**：true flow_data | process_form_variable_v2\[\] | 否 | 业务数据
**数据校验规则**：
- 长度范围：`0` ～ `100000` variable_api_name | string | 否 | 变量唯一标识
**示例值**："custom123" variable_value | field_variable_value_to_for_review | 否 | 变量值 text_value | string | 否 | 文本值
**示例值**："测试测试" bool_value | boolean | 否 | 布尔值
**示例值**：true number_value | string | 否 | 数字值
**示例值**："100" enum_value | string | 否 | 枚举值，这里是枚举的id
**示例值**："home_address" date_value | string | 否 | 从 1970 开始的天数
**示例值**："19838" date_time_value | string | 否 | 时间戳，毫秒
**示例值**："1714013877512" i18n_value | field_variable_value_i18n | 否 | 多语字段值
**示例值**：ou_c57053dad6eea0aea4696c48433d8562 zh_cn | string | 否 | 中文值
**示例值**："北京" en_us | string | 否 | 英文值
**示例值**："Beijing" object_value | field_variable_value_to_object | 否 | 对象值，包括对象id和对象类型
**示例值**：od-a761814f6bc3f14bd3b00905ec1d7c6f wk_id | string | 否 | wukong的对象唯一标识
**示例值**："6863326263210149383" wk_api_name | string | 否 | wukong的元数据唯一标识
**示例值**："country_region_subdivision" department_value | string | 否 | 部门id，根据入参选择对应的部门id
**示例值**："od-a761814f6bc3f14bd3b00905ec1d7c6f" employment_value | string | 否 | 员工类型字段值，为用户id，根据入参选择返回的用户id
**示例值**："ou_c57053dad6eea0aea4696c48433d8562" list_values | string\[\] | 否 | 数组类型值，里面包含多个值，每个元素都对应subValues中的key
**示例值**：["key1"]
**数据校验规则**：
- 长度范围：`0` ～ `10000` file_value | field_variable_value_to_file_for_write | 否 | 文件类型字段值 open_file_id | string | 否 | 通过[上传文件接口](https://open.larkoffice.com/document/server-docs/corehr-v1/employee/person/upload)获得的id
**示例值**："66867ed00740ddd4a0bad4a5_c99b5322dc744fe4b99b76426ffe5d53" file_name | string | 否 | 文件名称（需带有文件后缀），如果填写，则会覆盖上传文件的名称，否则通过open_file_id获取原始名称
**示例值**："file_name.jpg" length | int | 否 | 文件大小，单位：Byte，如果填写，则会覆盖上传文件的大小，否则通过open_file_id获取文件原始大小
**示例值**：65535
**数据校验规则**：
- 取值范围：`0` ～ `52428800` record_values | field_variable_value_to_record\[\] | 否 | record类型字段值 variable_api_name | string | 否 | 变量唯一标识
**示例值**："city_v2" sub_value_key | string | 否 | 变量值，对应subValues中的key
**示例值**："key1" record_id | string | 否 | 记录唯一ID
**示例值**："6863326263210149383" sub_values | field_variable_sub_vlaue_for_review\[\] | 否 | 在list_values和record_values中引用的变量
**数据校验规则**：
- 长度范围：`0` ～ `100000` key | string | 否 | 用于关联list和record类型变量值中的key
**示例值**："key1" value | field_variable_value_to_for_review | 否 | 变量值 text_value | string | 否 | 文本值
**示例值**："测试测试" bool_value | boolean | 否 | 布尔值
**示例值**：true number_value | string | 否 | 数字值
**示例值**："100" enum_value | string | 否 | 枚举值，这里是枚举的id
**示例值**："home_address" date_value | string | 否 | 从 1970 开始的天数
**示例值**："19838" date_time_value | string | 否 | 时间戳，毫秒
**示例值**："1714013877512" i18n_value | field_variable_value_i18n | 否 | 多语字段值
**示例值**：ou_c57053dad6eea0aea4696c48433d8562 zh_cn | string | 否 | 中文值
**示例值**："北京" en_us | string | 否 | 英文值
**示例值**："Beijing" object_value | field_variable_value_to_object | 否 | 对象值，包括对象id和对象类型
**示例值**：od-a761814f6bc3f14bd3b00905ec1d7c6f wk_id | string | 否 | wukong的对象唯一标识
**示例值**："6863326263210149383" wk_api_name | string | 否 | wukong的元数据唯一标识
**示例值**："country_region_subdivision" department_value | string | 否 | 部门id，根据入参选择对应的部门id
**示例值**："od-a761814f6bc3f14bd3b00905ec1d7c6f" employment_value | string | 否 | 员工类型字段值，为用户id，根据入参选择返回的用户id
**示例值**："ou_c57053dad6eea0aea4696c48433d8562" list_values | string\[\] | 否 | 数组类型值，里面包含多个值，每个元素都对应subValues中的key
**示例值**：["key1"]
**数据校验规则**：
- 长度范围：`0` ～ `10000` file_value | field_variable_value_to_file_for_write | 否 | 文件类型字段值 open_file_id | string | 否 | 通过[上传文件接口](https://open.larkoffice.com/document/server-docs/corehr-v1/employee/person/upload)获得的id
**示例值**："66867ed00740ddd4a0bad4a5_c99b5322dc744fe4b99b76426ffe5d53" file_name | string | 否 | 文件名称（需带有文件后缀），如果填写，则会覆盖上传文件的名称，否则通过open_file_id获取原始名称
**示例值**："file_name.jpg" length | int | 否 | 文件大小，单位：Byte，如果填写，则会覆盖上传文件的大小，否则通过open_file_id获取文件原始大小
**示例值**：65535
**数据校验规则**：
- 取值范围：`0` ～ `52428800` record_values | field_variable_value_to_record\[\] | 否 | record类型字段值 variable_api_name | string | 否 | 变量唯一标识
**示例值**："city_v2" sub_value_key | string | 否 | 变量值，对应subValues中的key
**示例值**："key1" record_id | string | 否 | 记录唯一ID
**示例值**："6863326263210149383" ### 请求体示例 ```json { "flow_definition_id": "people_7023711013443944467_7437160904904494892", "initiator_id": "ou_91791271921729102012", "system_initiator": true, "flow_data": [ { "variable_api_name": "custom123", "variable_value": { "text_value": "测试测试", "bool_value": true, "number_value": "100", "enum_value": "home_address", "date_value": "19838", "date_time_value": "1714013877512", "i18n_value": { "zh_cn": "北京", "en_us": "Beijing" }, "object_value": { "wk_id": "6863326263210149383", "wk_api_name": "country_region_subdivision" }, "department_value": "od-a761814f6bc3f14bd3b00905ec1d7c6f", "employment_value": "ou_c57053dad6eea0aea4696c48433d8562", "list_values": [ "key1" ], "file_value": { "open_file_id": "66867ed00740ddd4a0bad4a5_c99b5322dc744fe4b99b76426ffe5d53", "file_name": "file_name.jpg", "length": 65535 }, "record_values": [ { "variable_api_name": "city_v2", "sub_value_key": "key1", "record_id": "6863326263210149383" } ] }, "sub_values": [ { "key": "key1", "value": { "text_value": "测试测试", "bool_value": true, "number_value": "100", "enum_value": "home_address", "date_value": "19838", "date_time_value": "1714013877512", "i18n_value": { "zh_cn": "北京", "en_us": "Beijing" }, "object_value": { "wk_id": "6863326263210149383", "wk_api_name": "country_region_subdivision" }, "department_value": "od-a761814f6bc3f14bd3b00905ec1d7c6f", "employment_value": "ou_c57053dad6eea0aea4696c48433d8562", "list_values": [ "key1" ], "file_value": { "open_file_id": "66867ed00740ddd4a0bad4a5_c99b5322dc744fe4b99b76426ffe5d53", "file_name": "file_name.jpg", "length": 65535 }, "record_values": [ { "variable_api_name": "city_v2", "sub_value_key": "key1", "record_id": "6863326263210149383" } ] } } ] } ] } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- process_id | string | 流程运行实例 id，详细信息可通过[获取单个流程详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get)获取 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "process_id": "7437118147624175148" } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 1161001 | 参数错误 | 参数错误，请操作接口字段说明自查 403 | 1161002 | 无权限 | 请确认是否已申请权限 400 | 1161059 | flow未启用 | 请确认流程是否已启用 400 | 1161060 | 未能获取到租户id和用户id | 请检查租户id和用户id是否正确