获取外部数据源配置信息

批量查询飞书人事后台：设置->算薪数据设置->外部数据源设置 中的数据源设置列表

Warning: 停用的数据源、字段不能保存数据

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/payroll/v1/datasources
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	payroll:external_datasource_configuration:read Payroll外部数据源设置读权限

请求头

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

查询参数

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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项
└ datasources	datasource\[\]	数据源列表
└ code	string	数据源编码
└ i18n_names	i18n_content\[\]	数据源名称
└ locale	string	语种
└ value	string	语种对应的值
└ id	string	名称对应的实体id
└ active_status	int	启停用状态 可选值有： - 1: 已启用 - 2: 已停用
└ fields	datasource_field\[\]	数据源字段列表
└ code	string	数据源字段编码
└ i18n_names	i18n_content\[\]	数据源字段名称
└ locale	string	语种
└ value	string	语种对应的值
└ id	string	名称对应的实体id
└ field_type	int	字段类型 可选值有： - 1: 金额 - 2: 数值 - 3: 文本 - 4: 日期 - 5: 百分比
└ active_status	int	字段启停用状态 可选值有： - 1: 已启用 - 2: 已停用
└ i18n_description	i18n_content\[\]	数据源字段描述
└ locale	string	语种
└ value	string	语种对应的值
└ id	string	名称对应的实体id
└ decimal_places	int	保留小数位数。目前只有number、money类型字段需要设置保留小数
└ i18n_description	i18n_content\[\]	数据源描述
└ locale	string	语种
└ value	string	语种对应的值
└ id	string	名称对应的实体id
└ data_period_type	int	数据写入维度 可选值有： - 1: 算薪期间 - 2: 数据发生日期。功能灰度中，如需创建该维度数据源配置，请申请灰度。 - 3: 自定义数据周期。功能灰度中，如需创建该维度数据源配置，请申请灰度。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true,
        "datasources": [
            {
                "code": "test_datasource__c",
                "i18n_names": [
                    {
                        "locale": "zh_cn",
                        "value": "名称",
                        "id": "723123123123123213"
                    }
                ],
                "active_status": 1,
                "fields": [
                    {
                        "code": "test__c",
                        "i18n_names": [
                            {
                                "locale": "zh_cn",
                                "value": "名称",
                                "id": "723123123123123213"
                            }
                        ],
                        "field_type": 1,
                        "active_status": 1,
                        "i18n_description": [
                            {
                                "locale": "zh_cn",
                                "value": "名称",
                                "id": "723123123123123213"
                            }
                        ],
                        "decimal_places": 1
                    }
                ],
                "i18n_description": [
                    {
                        "locale": "zh_cn",
                        "value": "名称",
                        "id": "723123123123123213"
                    }
                ],
                "data_period_type": 1
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	2500001	unknown error	未知错误，联系技术支持
400	2500002	param invalid	参数异常，检查入参