获取员工基本集元数据定义
最后更新于:2019-11-12 22:45:25
可通过本接口来获取员工基本集元数据定义。
接口调用请求说明
https请求方式:GET https://openapi.ihr360.com/openapi/irenshi-staff-api/staff/metedata
请求参数说明
参数 |
类型 |
是否必须 |
说明 |
accessToken |
String |
是 |
来自获取AccessToken的接口返回值 |
返回说明 正常情况下,"i人事"会返回如下JSON数据给第三方:
返回数据说明
属性 |
类型 |
说明 |
code |
Int |
错误代码,成功是为0 |
message |
String |
错误消息 |
url |
String |
请求url |
data |
JSONObject |
数据,返回 |
errorResult |
boolean |
错误为true |
信息集元数据定义说明
属性 |
类型 |
说明 |
metaId |
String |
信息集元编码,根据编码可以对应后台一张数据库表 |
displayName |
String |
信息集名称 |
fieldList |
JSONArray |
信息集字段清单,数据格式见"字段定义"说明 |
字段定义说明
属性 |
类型 |
说明 |
columnName |
String |
字段列名称 |
fieldType |
String |
字段类型,"fieldType字段类型值列表清单"见下表 |
displayName |
String |
字段显示名称 |
fieldType字段类型值列表清单说明
类型值 |
含义 |
说明 |
数据格式 |
BOOLEAN |
布尔 |
Boolean类型,取值范围,true,false |
true,false |
INTEGER |
整数类型 |
整数类型 |
231 |
DOUBLE |
数字类型 |
数字类型,带小数位 |
652.2 |
DATE |
日期类型 |
字符串表示日期,格式必须为"YYYY-MM-DD" |
样例:"2017-12-26" |
TIME |
时间 |
字符串表示时间,格式必须为"HH24:Mi:SS" |
样例:"21:34:21" |
DATETIME |
时间戳 |
字符串表示时间戳,格式必须为"YYYY-MM-DD HH24:Mi:SS" |
样例:"2017-12-26 21:34:21" |
CODE_TYPE |
选项类型 |
仅提供该类型,暂时不提供具体可选项;可选项可从i人事系统中查询 |
|
STRING |
字符串 |
字符数量在64个之内 |
|
LONG_STRING |
长文本 |
字符数量不超过255个 |
返回数据样例
{ "code": 0, "message": null, "data": { "metaList": [{ "metaId": "tab_staff_info", "displayName": "员工信息", "fieldList": [{ "columnName": "reminderDate", "displayName": "提醒日期", "fieldType": "DATE", "required": false }, { "columnName": "contractType", "displayName": "结束合同类型", "fieldType": "CODE_TYPE", "required": true }, { "columnName": "staffType", "displayName": "员工类型", "fieldType": "CODE_TYPE", "required": true }] }] }, "errorResult": false
}