# 获取职位模板

获取社招、校招职位模板中的职位字段，返回结果包括系统默认字段和自定义字段。招聘管理员可在「飞书招聘」-「设置」-「职位管理」-「职位字段管理」中修改职位模板。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/job_schemas
HTTP Method | GET
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取职位信息(hire:job:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE3MjQ2NTQ0OTc2OTd9
page_size | int | 否 | 分页大小<br>**默认值**：10<br>**数据校验规则**：<br>* 最大值：100<br>**示例值**：10
scenario | int | 否 | 职位模板类型<br>**示例值**：1<br>**可选值有**：<br>- 1：社招<br>- 2：校招

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | job_schema\[\] | 职位模板列表
id | string | 职位模板 ID
name | i18n | 职位模板名称
zh_cn | string | 中文名称
en_us | string | 英文名称
scenario_type | int | 职位模板类型<br>**可选值有**：<br>- 1：社招<br>- 2：校招
object_list | common_schema\[\] | 模块列表
id | string | 模块 ID
name | i18n | 模块名称
zh_cn | string | 中文名称
en_us | string | 英文名称
description | i18n | 模块描述
zh_cn | string | 中文描述
en_us | string | 英文描述
setting | common_schema_setting | 模块信息
object_type | int | 类型，目前仅支持`11`<br>**可选值有**：<br>- 1：单行文本<br>- 2：多行文本<br>- 3：单选<br>- 4：多选<br>- 5：日期<br>- 6：月份选择<br>- 7：年份选择<br>- 8：时间段<br>- 9：数字<br>- 10：默认字段<br>- 11：模块<br>- 13：附件
config | common_schema_config | 模块配置信息
options | common_schema_option\[\] | 选项信息
key | string | 选项 ID
name | i18n | 选项名称
zh_cn | string | 中文名称
en_us | string | 英文名称
description | i18n | 选项描述
zh_cn | string | 中文描述
en_us | string | 英文描述
active_status | int | 是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
is_customized | boolean | 是否是自定义模块<br>**可选值有**：<br>* `true`：自定义模块<br>* `false`：系统默认模块
is_required | boolean | 是否必填<br>**可选值有**：<br>* `true`：必填<br>* `false`：非必填
active_status | int | 是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
children_list | common_schema_child\[\] | 字段列表
id | string | 字段 ID
name | i18n | 字段名称
zh_cn | string | 中文名称
en_us | string | 英文名称
description | i18n | 字段描述
zh_cn | string | 中文描述
en_us | string | 英文描述
setting | common_schema_setting | 字段信息
object_type | int | 字段类型，目前仅支持`1`/`2`/`3`/`4`/`5`/`9`/`10`<br>**可选值有**：<br>- 1：单行文本<br>- 2：多行文本<br>- 3：单选<br>- 4：多选<br>- 5：日期<br>- 6：月份选择<br>- 7：年份选择<br>- 8：时间段<br>- 9：数字<br>- 10：默认字段<br>- 11：模块<br>- 13：附件
config | common_schema_config | 字段配置信息
options | common_schema_option\[\] | 选项信息，当`object_type `为`3`（单选）或`4`（多选）时有值
key | string | 选项 ID
name | i18n | 选项名称
zh_cn | string | 中文名称
en_us | string | 英文名称
description | i18n | 选项描述
zh_cn | string | 中文描述
en_us | string | 英文描述
active_status | int | 是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
parent_id | string | 所属模块 ID，对应外层`object_list.id`字段
is_customized | boolean | 是否是自定义字段<br>**可选值有**：<br>* `true`：自定义字段<br>* `false`：系统默认字段
is_required | boolean | 是否必填<br>**可选值有**：<br>* `true`：必填<br>* `false`：非必填
active_status | int | 是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

### 响应体示例
```json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "items": [
            {
                "id": "6949805467799537964",
                "name": {
                    "zh_cn": "社招模板",
                    "en_us": "Social Job Template"
                },
                "scenario_type": 1,
                "object_list": [
                    {
                        "id": "6949805467799537964",
                        "name": {
                            "zh_cn": "基础信息",
                            "en_us": "Basic info"
                        },
                        "description": {
                            "zh_cn": "职位基础信息",
                            "en_us": "Job basic info"
                        },
                        "setting": {
                            "object_type": 1,
                            "config": {
                                "options": [
                                    {
                                        "key": "1",
                                        "name": {
                                            "zh_cn": "选项A",
                                            "en_us": "Option A"
                                        },
                                        "description": {
                                            "zh_cn": "选项A描述",
                                            "en_us": "Description of option A"
                                        },
                                        "active_status": 1
                                    }
                                ]
                            }
                        },
                        "is_customized": true,
                        "is_required": false,
                        "active_status": 1,
                        "children_list": [
                            {
                                "id": "6949805467799537964",
                                "name": {
                                    "zh_cn": "职位类型",
                                    "en_us": "Job type"
                                },
                                "description": {
                                    "zh_cn": "职位类型描述",
                                    "en_us": "Job type description"
                                },
                                "setting": {
                                    "object_type": 1,
                                    "config": {
                                        "options": [
                                            {
                                                "key": "111",
                                                "name": {
                                                    "zh_cn": "类型A",
                                                    "en_us": "Type A"
                                                },
                                                "description": {
                                                    "zh_cn": "类型A的描述",
                                                    "en_us": "Description of type A"
                                                },
                                                "active_status": 1
                                            }
                                        ]
                                    }
                                },
                                "parent_id": "6949805467799537964",
                                "is_customized": true,
                                "is_required": false,
                                "active_status": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "1234452132"
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位问题或联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小