Skip to content

获取申请表模板列表

获取招聘官网申请表模板列表,在官网申请职位时,申请表需按照官网申请表模板的格式进行填写。

Tip: 该功能尚在灰度阶段,如需使用请联系客户经理申请灰度

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/hire/v1/portal_apply_schemas
HTTP MethodGET
接口频率限制20 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可hire:site:readonly 获取官网信息 hire:site 更新官网信息

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:20
默认值10
数据校验规则
- 最大值:50
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:6930815272790114324

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsregistration_schema\[\]申请表模板列表
    └ idstring申请表模板 ID
    └ namestring申请表模板名称
    └ scenariosint\[\]申请表模板适用场景
可选值有
- 5: 面试登记表 - 6: 入职登记表 - 14: 信息更新登记表
    └ objectscommon_schema\[\]模块列表
      └ idstring模块 ID
      └ namei18n模块名称
        └ zh_cnstring中文
        └ en_usstring英文
      └ descriptioni18n模块描述
        └ zh_cnstring中文
        └ en_usstring英文
      └ settingcommon_schema_setting模块信息
        └ object_typeint字段类型
可选值有
- 1: 单行文本 - 2: 多行文本 - 3: 单选 - 4: 多选 - 5: 日期 - 6: 月份选择 - 7: 年份选择 - 8: 时间段 - 9: 数字 - 10: 默认字段 - 11: 模块 - 13: 附件
        └ configcommon_schema_config配置信息
          └ optionscommon_schema_option\[\]选项信息,当字段类型为单选/多选时会返回该信息
            └ keystring选项 ID
            └ namei18n选项名称
              └ zh_cnstring中文
              └ en_usstring英文
            └ descriptioni18n选项描述
              └ zh_cnstring中文
              └ en_usstring英文
            └ active_statusint是否启用
可选值有
- 1: 已启用 - 2: 已停用
      └ is_customizedboolean是否是自定义模块
      └ is_requiredboolean是否必填
      └ is_visibleboolean是否可见
      └ active_statusint是否启用
可选值有
- 1: 已启用 - 2: 已停用
      └ children_listcommon_schema_child\[\]字段列表
        └ idstring字段 ID
        └ namei18n字段名称
          └ zh_cnstring中文
          └ en_usstring英文
        └ descriptioni18n字段描述
          └ zh_cnstring中文
          └ en_usstring英文
        └ settingcommon_schema_setting字段信息
          └ object_typeint字段类型
可选值有
- 1: 单行文本 - 2: 多行文本 - 3: 单选 - 4: 多选 - 5: 日期 - 6: 月份选择 - 7: 年份选择 - 8: 时间段 - 9: 数字 - 10: 默认字段 - 11: 模块 - 13: 附件
          └ configcommon_schema_config配置信息
            └ optionscommon_schema_option\[\]选项信息
              └ keystring选项 ID
              └ namei18n选项名称
                └ zh_cnstring中文
                └ en_usstring英文
              └ descriptioni18n选项描述
                └ zh_cnstring中文
                └ en_usstring英文
              └ active_statusint是否启用
可选值有
- 1: 已启用 - 2: 已停用
        └ parent_idstring所属模块 ID
        └ is_customizedboolean是否是自定义字段
        └ is_requiredboolean是否必填
        └ is_visibleboolean是否可见
        └ active_statusint是否启用
可选值有
- 1: 已启用 - 2: 已停用
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "items": [
            {
                "id": "7044739584859326764",
                "name": "默认官网申请表",
                "scenarios": [
                    14
                ],
                "objects": [
                    {
                        "id": "6949805467799537964",
                        "name": {
                            "zh_cn": "基本信息",
                            "en_us": "Basic Information"
                        },
                        "description": {
                            "zh_cn": "候选人的基本信息",
                            "en_us": "The basic information of the candidate"
                        },
                        "setting": {
                            "object_type": 1,
                            "config": {
                                "options": [
                                    {
                                        "key": "Option1",
                                        "name": {
                                            "zh_cn": "选项一",
                                            "en_us": "Option1"
                                        },
                                        "description": {
                                            "zh_cn": "第一个选项",
                                            "en_us": "First Option"
                                        },
                                        "active_status": 1
                                    }
                                ]
                            }
                        },
                        "is_customized": true,
                        "is_required": false,
                        "is_visible": true,
                        "active_status": 1,
                        "children_list": [
                            {
                                "id": "6949805467799537964",
                                "name": {
                                    "zh_cn": "自定义字段",
                                    "en_us": "Custom Field"
                                },
                                "description": {
                                    "zh_cn": "第一个自定义字段",
                                    "en_us": "First Custom Field"
                                },
                                "setting": {
                                    "object_type": 1,
                                    "config": {
                                        "options": [
                                            {
                                                "key": "Option1",
                                                "name": {
                                                    "zh_cn": "选项一",
                                                    "en_us": "Option1"
                                                },
                                                "description": {
                                                    "zh_cn": "第一个选项",
                                                    "en_us": "First Option"
                                                },
                                                "active_status": 1
                                            }
                                        ]
                                    }
                                },
                                "parent_id": "6949805467799537964",
                                "is_customized": true,
                                "is_required": false,
                                "is_visible": true,
                                "active_status": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "page_token": "6930815272790114324",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
5001002001system error请根据实际报错信息定位或咨询技术支持
4001002002param illegal检查参数是否正确,例如类型,大小

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