选项详情查询接口
业务场景
该接口用于根据自定义档案编码和选项编码查选项详情。
若需要获取自定义档案编码,可以通过系统查看或者调用自定义档案列表查询接口。
若需查看选项列表,请调用选项列表查询接口。
接口限制
10次/秒/企业
接口地址
/api/openapi/reference/data/detail/{referenceDataBizCode}/{bizCode}
请求类型
GET
请求参数
请求参数说明:
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
referenceDataBizCode | string | 是 | 自定义档案编码 |
bizCode | string | 是 | 选项编码 |
参数示例
响应参数
响应参数说明
字段 | 字段类型 | 字段说明 |
---|---|---|
code | String | 返回状态 |
message | String | 返回提示 |
data | Json | 返回结果 |
success | boolean | 是否成功 |
具体参数说明
字段 | 字段类型 | 字段说明 |
---|---|---|
referenceAuthzs | List<ReferenceAuthz> | 限定以下部门、人员、或用户组使用 |
legalEntityAuthzs | List<ReferenceAuthz> | 选项受公司抬头过滤 |
formSubTypeAuthzs | List<ReferenceAuthz> | 选项受单据类型过滤 |
principals | List<ReferenceDataDetailPrincipal> | 选项负责人 |
parentBizCode | String | 上级分类外码 |
parentCode | String | 上级分类内码 |
bizCode | String | 选项编码 |
name | String | 选项名称 |
nameDisplay | json | 各语言名称 |
ReferenceAuthz 参数说明:
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
authzType | String | 必填 | 授权范围类型: STAFF人员, DEPARTMENT部门, USER_GROUP用户组, LEGAL_ENTITY公司抬头, FORM_SUB_TYPE单据类型 |
authzCode | string | 必填 | 授权编码 |
authzName | string | 必填 | 授权名称 |
includeChildDept | bool | 必填 | 是否包含子节点 |
ReferenceDataDetailPrincipal 参数说明:
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
code | String | 是 | 唯一code |
referenceDataDetailCode | string | 是 | 所关联的选项的code |
type | string | 是 | STAFF:员工; USER_GROUP:用户组 |
principalCode | string | 是 | 若type为STAFF,则为员工工号;若type为USER_GROUP,则为用户组编码 |
principalName | string | 是 | 若type为STAFF,则为员工姓名;若type为USER_GROUP,则为用户组名称 |
referenceDataRoleCode | string | 是 | 选项角色 |
正常响应参数示例
{
"code": "ACK",
"message": "",
"data": {
"bizCode": "RDD2212043G03Y8",
"name": "行政部",
"nameDisplay": "{\"zh\": \"行政部\"}",
"enabled": true,
"parentCode": "RD221203298JDBSW",
"referenceAuthzs": [
{
"authzType": "DEPARTMENT",
"authzCode": "DI2111251O2HQQ69",
"authzName": "",
"includeChildDept": true
},
{
"authzType": "DEPARTMENT",
"authzCode": "DI211220X6804QQ",
"authzName": "",
"includeChildDept": true
}
],
"legalEntityAuthzs": [
{
"authzType": "LEGAL_ENTITY",
"authzCode": "ELC2111251O2IXSE8",
"authzName": "",
"includeChildDept": false
},
{
"authzType": "LEGAL_ENTITY",
"authzCode": "ELC2211051PUKGHDS",
"authzName": "",
"includeChildDept": false
}
],
"formSubTypeAuthzs": [
{
"authzType": "FORM_SUB_TYPE",
"authzCode": "FT2111251O2O97UO",
"authzName": "",
"includeChildDept": false
},
{
"authzType": "FORM_SUB_TYPE",
"authzCode": "FT2111251O2PY9Z4",
"authzName": "",
"includeChildDept": false
}
],
"principals": [
{
"entCode": null,
"code": "RDDP2212211BP23TVK",
"referenceDataDetailCode": "RDD2212043G03Y8",
"type": "STAFF",
"principalCode": "UI2112021CZ9OQ9S",
"principalName": "崔**",
"referenceDataRoleCode": "ROLE"
},
{
"entCode": null,
"code": "RDDP2212211BP23VGG",
"referenceDataDetailCode": "RDD2212043G03Y8",
"type": "STAFF",
"principalCode": "UI2201171HBCQZUO",
"principalName": "liyuan",
"referenceDataRoleCode": "ROLE"
}
],
"extraProperty": null
},
"errorCode": null,
"success": true
}
修改记录
2022-12-21 新增接口