# 主数据提供接口
# 概述
在组织内部制定、发布了标准规范，主数据管理服务按标准规范生成主数据信息后，向外提供共享接口。业务系统根据接口获取主数据信息，满足业务系统的使用需求
# 本内容你将获得
- 主数据管理对外提供的接口清单
- 主数据管理对外提供的接口服务
# 接口清单
| 序号 | 接口服务名 | 功能说明 |
|---|---|---|
| 1 | getStandardList | 提供标准规范清单 |
| 2 | getStandardByID | 通过ID获取标准规范明细信息 |
| 3 | getCatagoryList | 提供数据目录清单 |
| 4 | getCatagoryByID | 通过ID获取数据目录明细信息 |
| 5 | getDataDetailByStandardID | 通过标准规范id查询主数据信息 |
| 6 | getDataDetailByCataID | 通过数据目录id查询主数据信息 |
| 7 | getDataDetailByName | 通过主数据名称查询主数据信息 |
# 接口服务
# getStandardList
| 接口 | 描述 |
|---|---|
| getStandardList | 提供标准规范清单 |
| 请求地址 | http://xxx/api/IF/DataPublish/getStandardList |
| 请求方式 | get |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 标准id |
| 2 | standardNo | string | 标准号 |
| 3 | standardName | string | 标准名称 |
| 4 | releaseVersion | string | 标准版本号 |
| 5 | issueDate | string | 发布日期 |
| 6 | implementDate | string | 实施日期 |
| 7 | competentDept | string | 主管部门 |
| 8 | centralizedDept | string | 归口部门 |
| 9 | publishDept | string | 发布单位 |
| 10 | remark | string | 备注 |
例子：http://xxx/api/IF/DataPublish/getStandardList
# getStandardByID
| 接口 | 描述 |
|---|---|
| getStandardByID | 通过ID获取标准规范明细信息 |
| 请求地址 | http://xxx/api/IF/DataPublish/getStandardByID |
| 请求方式 | get |
请求参数说明
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| standardId | 是 | bd824fcdd540bad13c2aa7ea2bb0bc76 | 标准id |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 标准id |
| 2 | standardNo | string | 标准号 |
| 3 | standardName | string | 标准名称 |
| 4 | releaseVersion | string | 标准版本号 |
| 5 | issueDate | string | 发布日期 |
| 6 | implementDate | string | 实施日期 |
| 7 | competentDept | string | 主管部门 |
| 8 | centralizedDept | string | 归口部门 |
| 9 | publishDept | string | 发布单位 |
| 10 | remark | string | 备注 |
例子：http://xxx/api/IF/DataPublish/getStandardByID?standardId=bd824fcdd540bad13c2aa7ea2bb0bc76
# getCatagoryList
| 接口 | 描述 |
|---|---|
| getCatagoryList | 提供数据目录清单 |
| 请求地址 | http://xxx/api/IF/DataCatagory/getCatagoryList |
| 请求方式 | get |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 数据目录ID |
| 2 | standardNo | string | 标准号 |
| 3 | standardName | string | 标准名称 |
| 4 | parentCataName | string | 父目录 |
| 5 | scSysName | string | 来源系统 |
| 6 | cataName | string | 数据目录名称 |
| 7 | cataEnname | string | 数据目录简称 |
| 8 | namingConvention | string | 数据目录命名规范 |
| 9 | cataStatus | string | 状态 |
| 10 | remark | string | 备注 |
例子：http://xxx/api/IF/DataCatagory/getCatagoryList
# getCatagoryByID
| 接口 | 描述 |
|---|---|
| getCatagoryByID | 通过ID获取数据目录明细信息 |
| 请求地址 | http://xxx/api/IF/DataCatagory/getCatagoryByID |
| 请求方式 | get |
请求参数说明
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| cataId | 是 | 0d81f3178faca8ac517751866b9fcb28 | 数据目录编码 |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 数据目录ID |
| 2 | standardNo | string | 标准号 |
| 3 | standardName | string | 标准名称 |
| 4 | parentCataName | string | 父目录 |
| 5 | scSysName | string | 来源系统 |
| 6 | cataName | string | 数据目录名称 |
| 7 | cataEnname | string | 数据目录简称 |
| 8 | namingConvention | string | 数据目录命名规范 |
| 9 | cataStatus | string | 状态 |
| 10 | remark | string | 备注 |
例子：http://xxx/api/IF/DataCatagory/getCatagoryByID?cataId=0d81f3178faca8ac517751866b9fcb28
# getDataDetailByStandardID
| 接口 | 描述 |
|---|---|
| getDataDetailByStandardID | 通过标准规范id查询主数据信息 |
| 请求地址 | http://xxx/api/IF/DataDetail/getDataDetailByStandardID |
| 请求方式 | get |
请求参数说明
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| standardId | 是 | e1505c9e8463e2c9bd64bbea7c32c11a | 标准规范编码 |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 主数据ID |
| 2 | name | string | 主数据名称 |
| 3 | enname | string | 主数据简称 |
| 4 | namingCode | string | 代码 |
| 5 | releaseVersion | string | 版本号 |
| 6 | standardNo | string | 标准号 |
| 7 | standardName | string | 标准名称 |
| 8 | cataName | string | 主数据目录 |
| 9 | remark | string | 备注 |
| 10 | dataStatus | string | 状态 |
例子：http://xxx/api/IF/DataDetail/getDataDetailByStandardID?standardId=e1505c9e8463e2c9bd64bbea7c32c11a
# getDataDetailByCataID
| 接口 | 描述 |
|---|---|
| getDataDetailByCataID | 通过数据目录id查询主数据信息 |
| 请求地址 | http://xxx/api/IF/DataDetail/getDataDetailByCataID |
| 请求方式 | get |
请求参数说明
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| cataId | 是 | 326b29b889846db840c25b21526259a1 | 数据目录编码 |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 主数据ID |
| 2 | name | string | 主数据名称 |
| 3 | enname | string | 主数据简称 |
| 4 | namingCode | string | 代码 |
| 5 | releaseVersion | string | 版本号 |
| 6 | standardNo | string | 标准号 |
| 7 | standardName | string | 标准名称 |
| 8 | cataName | string | 主数据目录 |
| 9 | remark | string | 备注 |
| 10 | dataStatus | string | 状态 |
例子：http://xxx/api/IF/DataDetail/getDataDetailByCataID?cataId=326b29b889846db840c25b21526259a1
# getDataDetailByName
| 接口 | 描述 |
|---|---|
| getDataDetailByName | 通过主数据名称查询主数据信息 |
| 请求地址 | http://xxx/api/IF/DataDetail/getDataDetailByName |
| 请求方式 | get |
请求参数说明
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| name | 是 | 良庆区 | 主数据名称 |
返回数据说明
| 序号 | 名称 | 类型 | 备注 |
|---|---|---|---|
| 1 | id | string | 主数据ID |
| 2 | name | string | 主数据名称 |
| 3 | enname | string | 主数据简称 |
| 4 | namingCode | string | 代码 |
| 5 | releaseVersion | string | 版本号 |
| 6 | standardNo | string | 标准号 |
| 7 | standardName | string | 标准名称 |
| 8 | cataName | string | 主数据目录 |
| 9 | remark | string | 备注 |
| 10 | dataStatus | string | 状态 |
例子：http://xxx/api/IF/DataDetail/getDataDetailByName?name=良庆区
# 其它
- 无