搜索试用期信息

搜索试用期信息，创建试用期后立刻搜索，可能会存在 5s 左右延迟

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/probation/search
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求调用该 API 所需的权限。开启其中任意一项权限即可调用开启任一权限即可	`corehr:probation:read` 获取试用期信息 `corehr:probation:write` 读写试用期信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息 `corehr:probation.custom_field:read` 获取试用期自定义字段信息 `corehr:probation.custom_field:write` 读写试用期自定义字段信息 `corehr:probation.notes:read` 读取试用期备注信息 `corehr:probation.notes:write` 读写试用期备注信息 `corehr:probation.self_review:read` 读取员工自评信息 `corehr:probation.self_review:write` 读写员工自评信息 `corehr:probation.probation_outcome:write` 写试用期结果字段 `contact:user.employee_id:readonly` 获取用户 user ID `corehr:probation.probation_outcome:read` 获取试用期结果字段

请求头

名称	类型	必填	描述
Authorization	string	是	`tenant_access_token` 值格式："Bearer `access_token`" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
`page_size`	`int`	是	分页大小，最大 100 示例值：100 数据校验规则： - 取值范围：`1` ～ `100`
`page_token`	`string`	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值：6891251722631890445
`user_id_type`	`string`	否	用户 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
`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`

请求体

名称	类型	必填	描述
`employment_ids`	`string\[\]`	否	雇佣 ID 列表，可通过【搜索员工信息】接口获取示例值：["7140964208476371111"]
`department_ids`	`string\[\]`	否	部门 ID 列表，可通过【批量查询部门】接口获取示例值：["7140964208476371121"]
`probation_start_date_start`	`string`	否	试用期开始日期 - 搜索范围开始，需要与搜索范围结束一同使用，格式："YYYY-MM-DD" 示例值："2022-05-18"
`probation_start_date_end`	`string`	否	试用期开始日期 - 搜索范围结束，格式："YYYY-MM-DD" 示例值："2022-05-20"
`probation_expected_end_date_start`	`string`	否	试用期预计结束日期 - 搜索范围开始，需要与搜索范围结束一同使用，格式："YYYY-MM-DD" 示例值："2022-06-20"
`probation_expected_end_date_end`	`string`	否	试用期预计结束日期 - 搜索范围结束，格式："YYYY-MM-DD" 示例值："2022-07-20"
`actual_probation_end_date_start`	`string`	否	试用期实际结束日期 - 搜索范围开始，需要与搜索范围结束一同使用，格式："YYYY-MM-DD" 示例值："2022-08-20"
`actual_probation_end_date_end`	`string`	否	试用期实际结束日期 - 搜索范围结束，格式："YYYY-MM-DD" 示例值："2022-09-20"
`initiating_time_start`	`string`	否	转正发起日期 - 搜索范围开始，需要与搜索范围结束一同使用，格式："YYYY-MM-DD" 示例值："2022-10-20"
`initiating_time_end`	`string`	否	转正发起日期 - 搜索范围结束，格式："YYYY-MM-DD" 示例值："2022-11-20"
`probation_status`	`string`	否	试用期状态示例值："approved" 可选值有： - `pending`: 审批中 - `rejected`: 已拒绝 - `waiting`: 待发起转正 - `approved`: 审批通过 - `converted`: 已转正 - `offboarded`: 已离职
`final_assessment_result`	`string`	否	试用期最终考核结果示例值："approved" 可选值有： - `approved`: 通过 - `rejected`: 不通过
`final_assessment_grade`	`string`	否	试用期最终考核等级，枚举值 api_name 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：probation_management - custom_api_name：final_assessment_grade 字段权限要求：按照试用期考核等级搜索 (corehr:probation.grade.search:read) 示例值："grade_a"

请求体示例

json

{
    "employment_ids": [
        "7140964208476371111"
    ],
    "department_ids": [
        "7140964208476371121"
    ],
    "probation_start_date_start": "2022-05-18",
    "probation_start_date_end": "2022-05-20",
    "probation_expected_end_date_start": "2022-06-20",
    "probation_expected_end_date_end": "2022-07-20",
    "actual_probation_end_date_start": "2022-08-20",
    "actual_probation_end_date_end": "2022-09-20",
    "initiating_time_start": "2022-10-20",
    "initiating_time_end": "2022-11-20",
    "probation_status": "approved",
    "final_assessment_result": "approved",
    "final_assessment_grade": "grade_a"
}

响应

响应体

名称	类型	描述
`code`	`int`	错误码，非 0 表示失败
`msg`	`string`	错误描述
`data`	`\-`	-
└ `items`	`probation_info\[\]`	查询的试用期信息
└ `employment_id`	`string`	雇佣 ID，可通过【搜索员工信息】接口获取
└ `probation_id`	`string`	试用期信息 ID
└ `probation_start_date`	`string`	试用期开始日期，格式："YYYY-MM-DD"
└ `probation_expected_end_date`	`string`	试用期预计结束日期，格式："YYYY-MM-DD"
└ `actual_probation_end_date`	`string`	试用期实际结束日期，格式："YYYY-MM-DD"
└ `initiating_time`	`string`	转正发起日期，格式："YYYY-MM-DD"
└ `submission_type`	`enum`	发起方 - hr_submission：HR 发起 - self_submission：员工发起 - system ：系统发起
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `initiator_id`	`string`	转正发起人的雇佣 ID，当系统发起转正时该字段为空，可通过【搜索员工信息】接口获取
└ `probation_status`	`enum`	试用期状态： - pending：审批中 - rejected：已拒绝 - waiting：待发起转正 - approved：审批通过 - converted：已转正 - offboarded：已离职
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `self_review`	`string`	员工自评字段权限要求（满足任一）： `corehr:probation.self_review:read` 读取员工自评信息 `corehr:probation.self_review:write` 读写员工自评信息
└ `notes`	`string`	备注字段权限要求（满足任一）： `corehr:probation.notes:read` 读取试用期备注信息 `corehr:probation.notes:write` 读写试用期备注信息
└ `process_id`	`string`	流程实例 ID
└ `converted_via_bpm`	`boolean`	是否通过 BPM 转正
└ `custom_fields`	`custom_field_data\[\]`	自定义字段字段权限要求（满足任一）： `corehr:probation.custom_field:read` 获取试用期自定义字段信息 `corehr:probation.custom_field:write` 读写试用期自定义字段信息
└ `custom_api_name`	`string`	自定义字段 apiname，即自定义字段的唯一标识
└ `name`	`custom_name`	自定义字段名称
└ `zh_cn`	`string`	中文
└ `en_us`	`string`	英文
└ `type`	`int`	自定义字段类型
└ `value`	`string`	字段值，是 json 转义后的字符串，根据元数据定义不同，字段格式不同（如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05"）
└ `final_assessment_status`	`enum`	试用期考核最终状态： - not_started：未开始 - in_process：进行中 - completed：已完成 - no_need：无需考核
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `final_assessment_result`	`enum`	试用期考核最终结果： - approved：通过 - rejected：不通过
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `final_assessment_score`	`number(float)`	试用期考核最终得分字段权限要求（满足任一）： `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息
└ `final_assessment_grade`	`enum`	试用期考核最终等级，枚举值 api_name 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "probation_management" - custom_api_name = "final_assessment_grade" 字段权限要求（满足任一）： `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `final_assessment_comment`	`string`	试用期考核最终评语字段权限要求（满足任一）： `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息
└ `final_assessment_detail`	`string`	最终考核结果页面超链接字段权限要求（满足任一）： `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息
└ `assessments`	`assessment\[\]`	试用期考核结果列表字段权限要求（满足任一）： `corehr:probation.assessment:read` 获取试用期考核信息 `corehr:probation.assessment:write` 读写试用期考核信息
└ `assessment_id`	`string`	考核结果 ID
└ `assessment_status`	`enum`	考核状态 - not_started：未开始 - in_process：进行中 - completed：已完成 - no_need：无需考核
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `assessment_result`	`enum`	试用期考核结果 - approved：通过 - rejected：不通过
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `assessment_score`	`number(float)`	考核得分
└ `assessment_grade`	`enum`	试用期考核等级，枚举值 api_name 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "probation_management" - custom_api_name = "final_assessment_grade"
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `assessment_comment`	`string`	考核评语
└ `assessment_detail`	`string`	考核结果页面超链接
└ `is_final_asssessment`	`boolean`	是否为最终考核结果
└ `probation_extend_expected_end_date`	`string`	试用期延长后的预计结束日期字段权限要求（满足任一）： `corehr:probation.probation_outcome:read` 获取试用期结果字段 `corehr:probation.probation_outcome:write` 写试用期结果字段
└ `extended_probation_period_duration`	`int`	试用期延长时间字段权限要求（满足任一）： `corehr:probation.probation_outcome:read` 获取试用期结果字段 `corehr:probation.probation_outcome:write` 写试用期结果字段
└ `extended_probation_period_unit`	`enum`	试用期延长时间单位字段权限要求（满足任一）： `corehr:probation.probation_outcome:read` 获取试用期结果字段 `corehr:probation.probation_outcome:write` 写试用期结果字段
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `probation_outcome`	`enum`	试用期结果字段权限要求（满足任一）： `corehr:probation.probation_outcome:read` 获取试用期结果字段 `corehr:probation.probation_outcome:write` 写试用期结果字段
└ `enum_name`	`string`	枚举值
└ `display`	`i18n\[\]`	枚举多语展示
└ `lang`	`string`	语言编码（IETF BCP 47）
└ `value`	`string`	文本内容
└ `page_token`	`string`	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ `has_more`	`boolean`	是否还有更多项

响应体示例

json

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "employment_id": "6893014062142064135",
                "probation_id": "6893014062142064132",
                "probation_start_date": "2022-05-20",
                "probation_expected_end_date": "2022-05-28",
                "actual_probation_end_date": "2022-06-28",
                "initiating_time": "2022-07-28",
                "submission_type": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "initiator_id": "6893014062142061135",
                "probation_status": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "self_review": "符合预期",
                "notes": "高潜",
                "process_id": "6893014062142164135",
                "converted_via_bpm": false,
                "custom_fields": [
                    {
                        "custom_api_name": "name",
                        "name": {
                            "zh_cn": "自定义姓名",
                            "en_us": "Custom Name"
                        },
                        "type": 1,
                        "value": "\"231\""
                    }
                ],
                "final_assessment_status": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "final_assessment_result": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "final_assessment_score": 99.9,
                "final_assessment_grade": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "final_assessment_comment": "超出预期",
                "final_assessment_detail": "https://qwe112233.feishuapp.bytedance.net/ae/ui/apps//122265873393330/recordPages/1/records/1767139312?objectId=17661180522543&recordPageId=173330728118312",
                "assessments": [
                    {
                        "assessment_id": "6893014061142064135",
                        "assessment_status": {
                            "enum_name": "phone_type",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "assessment_result": {
                            "enum_name": "phone_type",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "assessment_score": 99.9,
                        "assessment_grade": {
                            "enum_name": "phone_type",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "assessment_comment": "超出预期",
                        "assessment_detail": "https://qwe1123433.feishuapp.bytedance.net/ae/ui/apps//122265871113330/recordPages/2/records/17611111112?objectId=17663333322543&recordPageId=171128122312",
                        "is_final_asssessment": false
                    }
                ],
                "probation_extend_expected_end_date": "2022-05-20",
                "extended_probation_period_duration": 1,
                "extended_probation_period_unit": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "probation_outcome": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                }
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1160017	请求参数中字段权限缺失	申请缺失的字段权限

事件

事件

员工兼职

员工国际派遣

职位数据事件

事件

事件

事件

事件

事件

事件

事件

成本中心 · version

事件

事件

事件

事件

地点 · address

事件

事件

搜索试用期信息 ​

请求 ​

请求头 ​

查询参数 ​

请求体 ​

请求体示例 ​

响应 ​

响应体 ​

响应体示例 ​

错误码 ​

搜索试用期信息

请求

请求头

查询参数

请求体

请求体示例

响应

响应体

响应体示例

错误码