版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
ICS35.240.01CCSL67
DB23黑 龙 江 省 地 方 标 准DB23/T3612—2023黑龙江省政务信息共享交换平台级联对接规范2023年-08月-28日发布 2023年-09月-27日实施黑龙江省市场监督管理局 发布DB23/T3612DB23/T3612—2023II前 言本文件依据GB/T1.1-20201请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本文件由黑龙江省营商环境建设监督局提出并归口。院。本文件主要起草人:张建峰、王磊、江中阳、梁丽、杨大志、李文学、吕猛、李黎轩、遇金宝、李硕DB23/T3612DB23/T3612—2023PAGEPAGE20黑龙江省政务信息共享交换平台级联对接规范范围内容。本文件适用于黑龙江省市级共享平台与省级共享平台的数据目录、数据资源和供需数据的级联建设。规范性引用文件(包括所有的修改单适用于本文件。DB23/T3613—2023黑龙江省政务信息共享交换平台政务数据资源术语术语和定义DB23/T3613—2023界定的以及下列术语和定义适用于本文件。政务外网局域网接入政务外网的逻辑隔离区域,与部门其他网络之间有明确边界。缩略语下列缩略语适用于本文件。API:应用程序接口,(ApplicationProgrammingInterface)ULUL(uiomeocelctr级联架构级联架构内容统由省共享交换平台开发部署,地市级联系统由各地市建设。省市两级数据共享交换平台对接架构省市两级数据共享交换平台对接架构包括以下内容,见图1。级联程序:级联程序将省级平台级联数据推送到下行数据表中;交换程序:完成省平台和地市平台之间数据交换;上行接口:将地市共享平台上行数据同步到省共享平台;上行数据表:存储地市共享平台上行数据,供使用方获取;下行数据表:存储省共享平台下行数据,供地市共享平台获取;文件系统:存储上报、下发的资源。图1 省市两级数据共享交换平台对接架构图省市两级对接设计(和数据交换到上行数据表的方式提交到省共享交换平台,相关数据字典详见附录A。上行接口对接接口对接规范通讯协议http承载使用httpPOST/GET方法由请求方发送请求,由消息接收方回复响应。注1:所有JSON消息中的字段均为小写(模版中有些使用大写字母,但是下发的报文中都使用小写)。注2:所有消息中的JSON数据均采用utf-8编码。消息头要求消息头字段消息头要求见表1。表1 消息头要求表http消息头包含如下字段属性名称约束类型取值说明gjgxjhpt_rid必选String请求者身份标识gjgxjhpt_sid必选String服务接口标识(本文档中每个接口都有一个方法名作为服务接口标识)gjgxjhpt_rtime必选String服务调用时间gjgxjhpt_sign必选String签名信息参数签名信接口标识、服务调用时间进行hmacsha256计算并进行base64转码获得。示例代码见附录B。注:请求者身份标识、服务标识、签名秘钥由省共享交换平台分别向各地市下发,下发方式为邮件。消息头对消息头的参数定义,各个字段解释见表2。表2 消息头的参数定义表序号父元素元素名称约束类型长度取值说明1一code必选String60返回消息的状态码2一message必选String128返回消息结果描述3一data必选一一返回消息体消息正文消息正文为交易请求以及应答的内容,以JSON格式存储,在交易报文传输时和消息头一起传输。报文样例样例场景注册。http接口请求报文,包括消息头和消息正文两部分,如下所示:示例:http消息头gjgxjhpt_sid:/Supply/CreateOrggjgxjhpt_rid:CreateCataLogGroupgjgxjhpt_rtime:2018-10-2311:09:12gjgxjhpt_sign:q98d7vc98q98era97fbn0sa67fnbaq5fhttp请求报文{"id":"201001","name":"公共卫生","parent_id":"201","remark":"政务信息资源分类-公共卫生","order_id":"1"}http接口请求的响应报文,仅包含消息头部分,如下所示:示例:{"code":"0","message":"添加成功"}组织机构信息查询机构查询接口机构查询接口见表3、表4和表5。 表3 机构查询接口表名称机构单位查询接口功能说明地市共享平台用以查询省平台机构单位的share_org_idURL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Supply/CreateOrg内容类型application/json提交资源数据按照本文件表4执行提交httpheader数据按照本文件执行提交数据举例{"region_code":"230100",//国家统计局网站发布统计用区划代码(/tjsj/tjbz/tjyqhdmhcxhfdm/2017/index.html)"region_name":"黑龙江省哈尔滨市市辖区",//国家统计局网站发布的统计用区划代码"dept_name":"哈尔滨市交通运输局","dept_code":"11230100002277193D"//单位组织机构编码}返回http状态200返回数据参数按照本文件表5执行返回数据举例{"code":"1","message":"处理成功","data":"{"share_org_id":"12454"}"}表4 机构查询接口-提交资源数据格式表名称是否必须类型长度描述region_code是String36统计用区划代码(国家统计局网站2017年10月31发布,省市县(区)采用6位)region_name是String250统计用区划名字(国家统计局网站2017年10月31发布)dept_name是String255机构单位名称dept_code是String36(GB/T31286-2014标准填写)credit_code否String50统一信用代码表5 机构查询接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)data一一返回数据share_org_idString36机构id目录分类上行目录分类注册接口目录分类注册接口见表6、表7和表8。表6 目录分类注册接口表名称目录分类注册接口功能说明地市共享平台注册目录分类到省平台URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/CatalogGroup/CreateCataLogGroup提交资源数据按照本文件表7执行提交httpheader数据按照本文件执行提交数据举例{"parent_id":"307013114","group_name":"工商局","remark":"工商局","order_id":"22"}返回http状态200返回数据参数按照本文件表8执行返回数据举例(处理正常){"code":"1","message":"处理成功","data":"{"group_id":"3070260158"}"}表7 目录分类注册接口-提交资源数据格式表名称是否必须类型长度描述group_name是String32分类名称parent_id是String32上级分类id(同一级分类最大支持99个子分类)remark否String100分类描述order_id否Int8排序编号表8 目录分类注册接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码data一一返回数据group_idString32省平台的目录分类idmessageString一执行结果信息(和结果代码对应,是执行结果的说明信息)目录分类变更接口目录分类变更接口见表9、表10和表11。表9 目录分类变更接口表名称目录分类变更接口功能说明地市共享平台变更本地市在省平台的目录分类URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/CatalogGroup/UpdateCataLogGroup提交资源数据按照本文件表10执行提交httpheader数据按照本文件执行提交数据举例{"group_id":"3070131112",//必填"parent_id":"30701311","group_name":"工商局部门","remark":"工商局部门","order_id":"23"}http200返回数据参数按照本文件表11执行返回数据举例(处理正常){"code":"1","message":"处理成功"}表10 目录分类变更接口-提交资源数据格式表名称是否必须类型长度描述group_id是String32目录分类id(需要变更的目录分类id)group_name是String32分类名称(可变更)parent_id是String32上级分类id(需要变更的目录分类的上级分类id)remark否String100分类描述(可变更)order_id否Int8排序编号(可变更)表11 目录分类变更接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)目录分类撤销接口目录分类撤销接口见表12、表13和表14。表12 目录分类撤销接口表名称目录分类撤销接口功能说明地市共享平台撤销本地市在省平台的目录分类URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/CatalogGroup/DeleteCataLogGroup提交资源数据按照本文件表13执行提交httpheader数据按照本文件执行提交数据举例{"group_id":"目录分类id"//必填}返回http状态200返回数据参数按照本文件表14执行返回数据举例(处理正常){"code":"1","message":"处理成功"}表13 目录分类撤销接口-提交资源数据格式表名称是否必须类型长度描述group_id是String32目录分类id表14 目录分类撤销接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)目录信息上报目录注册接口目录注册接口表目录注册接口见表15、表16和表17。表15 目录注册接口表名称目录注册接口功能说明地市共享平台将本地市的目录注册到省平台URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Catalog/CreateCataLog提交资源数据按照本文件表16执行提交httpheader数据按照本文件执行表15 目录注册接口表(续)名称目录注册接口提交数据举例{"cata_title":"水土流失监测管理信息","catacode":"307013097898","cataid":,"columnlist":[{"dataformat":"1","columnid":"123134","length":"100","namecn":"机关代码","updatetime":"2017-12-2516:38:11"}],"credit_code":"X08100000000000000","description":"水土流失监测管理信息","group_id":"307013200304","internalorgan":"string","open_condition":"无","open_type":1,"publishedtime":"2017-10-2622:30:00","resourceformat":"03","resourceformatother":"string","resourceformattype":"0307","shared_condition":"无","shared_type":"1","sharedway":"0102","status":4,"update_cycle":"1","updatetime":"2017-10-2622:30:00"}返回http状态200返回数据参数按照本文件表17执行返回数据举例(处理正常){"code":"1","data":"{"cata_id":"1510727521903027532"}","message":"处理成功"}表16 注册接口-提交资源数据格式表名称是否必须类型长度描述group_id是String32所属目录分类编码cataid是String32id(32持唯一)cata_title是String512省平台目录名称catacode是String100信息资源目录编码credit_code是String32统一信用代码internalorgan否String100提供方内部部门description是String1024信息资源摘要resourceformat是String20信息资源格式分类编码resourceformattype是String20信息资源格式类型编码resourceformatother否String100其他类型资源格式描述columnlist否catalogcolumn_schema一当信息资源格式为电子表格和数据库类型时,数据项项列表信息必须填写,其他资源格式可以不上报,但若上报必须符合格式校验publishedtime是date一发布日期shared_type是String20共享类型编码shared_condition是String200共享条件sharedway是String20共享方式类型编码(open_type是Int20(13:部分对社会开放)open_condition是String1024开放条件(对向社会开放资源的条件描述。如无条件,请填写无)updatetime是datatime一更新时间update_cycle是String10更新周期status是Int一目录状态(省平台已发布的目录注册到国家平台为“4”)表17 注册接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码data一一返回数据cata_idString32省平台的目录idmessageString一执行结果信息(和结果代码对应,是执行结果的说明信息)catalogcolumn_schemacatalogcolumn_schema描述见表18。表18 catalogcolumn_schema描述表字段名是否必须类型长度说明columnid否String32信息项编码namecn是String100信息项名称dataformat是String20数据类型编码length是Int20数据长度order_id是Int11排序编号updatetime是datatime一更新时间目录变更接口目录变更接口表目录变更接口表见表19、表20和表21。表19 目录变更接口表名称目录变更接口功能说明地市共享平台变更本地市在省平台的目录URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Catalog/UpdateCataLog提交资源数据按照本文件表20执行提交httpheader数据按照本文件执行表19 目录变更接口表(续)名称目录变更接口提交数据举例{"cata_id":"71ec43d27af74c7e9a63bc7c08e9ea9c","cata_title":"水土流失监测管理信息","columnlist":[{"dataformat":"1","update_cycle":"8","columnid":"123134","length":"100","namecn":"机关代码","updatetime":"2017-12-2516:38:11"}],"description":"水土流失监测管理信息","internalorgan":"string","open_condition":"无","open_type":1,"publishedtime":"2017-10-2622:30:00","resourceformat":"03","resourceformatother":"string","resourceformattype":"0307","shared_condition":"无","shared_type":"1","sharedway":"0102","update_cycle":"1","updatetime":"2017-10-2622:30:00"}返回http状态200返回数据参数按照本文件表21执行返回数据举例(处理正常){"code":"1","message":"处理成功"}表20 目录变更接口-提交资源数据格式表名称是否必须类型长度描述cata_id是String32省平台的目录idcata_title是String512信息资源名称internalorgan可选String100提供方内部部门表20 目录变更接口-提交资源数据格式表(续)名称是否必须类型长度描述description是String1024信息资源摘要resourceformat是String20信息资源格式分类编码resourceformattype是String20信息资源格式类型编码resourceformatother否String100其他类型资源格式描述columnlist否catalogcolumn_schema一当信息资源格式为电子表格和数据库类型时,数据项项列表信息必须填写,其他资源格式可以不上报,但若上报必须符合格式校验(详见Scheema定义)publishedtime是date一发布日期shared_type是String20共享类型编码shared_condition是String200共享条件sharedway是Int20共享方式类型编码open_type是Int20(13:部分对社会开放)open_condition是String1024开放条件(对向社会开放资源的条件描述。如无条件,请填写无)updatetime是datatime一更新时间update_cycle是String10更新周期表21 目录变更接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)catalogcolumn_schemacatalogcolumn_schema描述见表22。表22 catalogcolumn_schema描述字段名是否必须类型长度说明columnid否String32信息项编码namecn是String100信息项名称dataformat是String20数据类型编码length是Int20数据长度update_cycle是String20更新周期编码update_cycle_user否String200updatetime是datatime一更新时间目录撤销接口目录撤销接口见表23、表24和表25。表23 目录撤销接口表名称目录撤销接口功能说明地市共享平台撤销本身在省平台的目录URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Catalog/DeleteCataLog提交资源数据按照本文件表24执行提交httpheader数据按照本文件执行提交数据举例{"cata_id":"1521534283920593740","cataid":"1031123456222223"}返回http状态200返回数据参数按照本文件表25执行返回数据举例(处理正常){"code":"1","message":"处理成功"}表24 撤销接口-提交资源数据格式表名称是否必须类型长度描述cata_id是String32省平台的目录idcataid是String32地市平台数据目录标识id表25 撤销接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)应用系统信息上报应用系统注册接口应用系统注册接口见表26、表27和表28。表26 应用系统注册接口表名称应用系统注册接口功能说明资源申请时需要选择相对应的应用系统,此接口将地市平台的应用系统注册到省平台。URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Supply/CreateSystem内容类型application/json提交资源数据按照本文件表27执行提交httpheader数据按照本文件执行提交数据举例{"name":"农业信息管理系统","share_org_id":"农业信息管理系统","provide_ip":"","provide_url":"/iqa/query","remark":"","phone":,"contact":"张三","area_name":"01","range_name":"01" }返回http状态200返回数据参数按照本文件表28执行返回数据举例(处理正常){"code":"1","data":"{"id":"234234"}","message":"处理成功"}表27 应用系统注册接口-提交资源数据格式表名称是否必须类型长度描述name是String255应用系统名称share_org_id是String15机构id(机构注册接口返回的机构id)provide_ip是String15对外提供的ipprovide_url是String255对外提供的url地址remark否String255备注phone是String15联系人电话contact是String36联系人姓名area_name是String50应用领域名称(A.数据字典.应用领域名称range_name是String50应用范围名称(01:全省;02:全市;03:本单位)表28 应用系统注册接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码(详见附录A.2返回码定义)messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)data一一返回数据idString36应用系统id应用系统修改接口应用系统修改接口见表29、表30和表31。表29 应用系统修改接口名称应用系统修改接口功能说明对于已经注册成功的应用系统进行修改。URL样式https://xx.xx.xx.xx/interface提交方式POST方法名/Supply/UpdateSystem接口协议https+JSON内容类型application/json提交资源数据按照本文件表30执行提交httpheader数据按照本文件章执行提交数据举例{"id":"df-1","name":"农业信息管理系统","provide_ip":"","provide_url":"/iqa/query","remark":"","phone":,"contact":"张三", }返回http状态200返回数据参数按照本文件表31执行返回数据举例(处理正常){"code":"1","message":"处理成功"}表30 系统修改接口-提交资源数据格式表名称是否必须类型长度描述id是String36应用系统idname是String255应用系统名称provide_ip是String15对外提供的ipprovide_url是String255对外提供的url地址remark否String255备注phone是String15联系人电话contact是String36联系人姓名表31 系统修改接口-返回数据参数格式表名称类型长度描述codeInt6执行结果代码(详见附录A.2返回码定义)messageString一执行结果信息(和结果代码对应,是执行结果的说明信息)资源信息上报数据源接口数据源注册接口数据源注册接口见表32、表33和表34。表32 数据源注册接口名称Datasource增加接口功能说明新建数据源时,将数据源的相关信息推送给资源系统url样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/CreateDatasource传入参数Map<String,Object>提交资源数据按照本文件表33执行提交httpheader数据按照本文件执行表32 数据源注册接口(续)名称Datasource增加接口提交数据举例{ "id":"02d0783ac13041eebb7252f3f4464f6e", "name":"测试数据源", "description":"测试数据源描述", "host":"", "port":"3306", "dbName":"test", "dbType":"mysql", "username":"root", "password":"CNy2pjoPzhBSTVQsMOUhZw==", "contactName":"test2", "contactPhone":, "jdbcType":"sid", "schema":"public", "organCode":"370100", "organName":"哈尔滨市公安局", "regionCode":"230100000000"}返回http状态200返回数据参数按照本文件表34执行返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":"02d0783ac13041eebb7252f3f4464f6e"}表33 数据源注册接口-提交资源数据格式表名称类型必填说明备注nameString是数据源名称一descriptionString否数据源描述一hostString是主机地址一portInt是端口号一dbNameString是数据库名称一dbTypeString是数据库类型Mysql,oracle,Postgresql,sqlserverusernameString是用户名一表33 数据源注册接口-提交资源数据格式表(续)名称类型必填说明备注passwordString是数据源密码,加密存储与老系统加密方式一致,可以直接存储contactNameString否联系人一contactPhoneString否联系电话一jdbcTypeString是Sid或serviceName一schemaString否一一organCodeString是数据源所属部门信息从meta_host中取出org_codeorganNameString是数据源所属部门名称从meta_host中取出org_nameregionCodeString是数据源所属区划信息一表34 数据源注册接口-返回数据参数格式表名称类型说明备注codeInt返回参数200推送成功、300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空dataString资源id若新增数据源成功则返回新数据源的资源id,若更新数据源或推送失败则返回空数据源删除接口数据源删除接口见表35、表36和表37。表35 数据源删除接口名称资源删除服务功能说明数据源删除时,将资源及相关信息推送给资源系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/DeleteDatasource传入参数String提交资源数据按照本文件表36执行提交httpheader数据按照本文件执行提交数据举例{"id":"5e19071306fe4663850eac8795235c0c",}返回http状态200返回数据参数按照本文件表37执行返回数据举例(处理正常)正常返回:{"code":"200","error":"",}表36 源删除接口-提交资源数据格式表名称类型必填说明备注idString是资源id需要删除资源的资源id表37 源删除接口-返回数据参数格式表名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空,数据源更新接口数据源更新接口见表38、表39和表40。表38 数据源更新接口名称Datasource增加接口功能说明新建数据源时,将数据源的相关信息推送给资源系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/UpdateDatasource传入参数Map<String,Object>提交资源数据按照本文件表39执行httpheader按照本文件执行提交数据举例{ "id":"02d0783ac13041eebb7252f3f4464f6e", "name":"测试数据源", "description":"测试数据源描述", "host":"", "port":"3306", "dbName":"test", "dbType":"mysql", "username":"root", "password":"CNy2pjoPzhBSTVQsMOUhZw==", "contactName":"test2", "contactPhone":, "jdbcType":"sid", "schema":"public", "organCode":"370100", "organName":"哈尔滨市公安局", "regionCode":"230100000000"}表38 数据源更新接口(续)名称Datasource增加接口返回http状态200返回数据参数按照本文件表40执行返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":"02d0783ac13041eebb7252f3f4464f6e"}表39 数据源更新接口-提交资源数据格式表名称类型必填说明备注idString是数据源ididid若ididdatanameString是数据源名称一descriptionString否数据源描述一hostString是主机地址一portInt是端口号一dbNameString是数据库名称一dbTypeString是数据库类型Mysql,oracle,Postgresql,sqlserverusernameString是用户名一passwordString是数据源密码,加密存储与老系统加密方式一致,可以直接存储contactNameString否联系人一contactPhoneString否联系电话一jdbcTypeString是Sid或serviceName一schemaString否一一organCodeString是数据源所属部门信息从meta_host中取出org_codeorganNameString是数据源所属部门名称从meta_host中取出org_nameregionCodeString是数据源所属区划信息一表40 数据源更新接口-返回数据参数格式表名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空dataString资源id若新增数据源成功则返回新数据源的资源id,若更新数据源或推送失败则返回空资源信息接口文件资源注册接口文件资源注册接口见表41、表42和表43。表41 文件资源注册接口交换系统管理中心提供省平台资源注册接口名称接口资源推送服务功能说明文件资源上报时,将资源及文件的相关信息推送给目录系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON方法名/Resource/CreateFile提交资源数据按照本文件表42执行提交httpheader数据按照本文件执行表41 文件资源注册接口名称接口资源推送服务提交数据举例{"id":"0022b5fa457e4dad8e96706470b42f11","resName":"5e19071306fe4663850eac8795235c0c","resDesc":"管理中心资源","cataId":"1d3a5d12471941a28067b141c15f137b","regionCode":"230400","orgId":"ba96d8f611e847eaa2b61ad207ad9b1e","orgName":"管理中心","shareType":"1","shareCondition":"","openType":"1","openCondition":"2","fromSystemId":"manaul","fromSystemName":"人工填报","updateCycle":"2","customUpdateCycle":"","creatorId":"1234","creatorName":"测试人员","filePath":"Y2VzaGk=","fileName":"文件资源测试","fileFormat":"txt","fileSize":"5"}返回http状态200返回数据参数按照本文件表43执行返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":"5e19071306fe4663850eac8795235c0c"}表42 文件资源注册接口-提交资源数据格式名称类型必填说明备注resNameString是资源名称一resDescString是资源详情一cataIdString是关联数据目录ID一regionCodeString是所属行政区划编码权限划分orgIdString是所属部门id一表42 文件资源注册接口-提交资源数据格式(续)名称类型必填说明备注orgNameString是所属部门名称一shareTypeString是共享类型1:无条件共享2:有条件共享3:不予共享shareConditionString否共享条件一openTypeString是开放类型1:可对社会开放2:不可对社会开放openConditionString否开放条件一fromSystemIdString是来源系统id若无来源应用系统传:manaulfromSystemNameString是来源系统名称若无来源应用系统传:人工填报updateCycleInt是数据更新周期2:每日3:每周4:每月5:每季度6:每半年7:每年8:实时1:其他customUpdateCycleString否用户自定义更新周期updateCycle1填项creatorIdString是创建者ID一creatorNameString是创建者姓名一filePathString是文件资源二进制流暂支持推送单一文件fileNameString是资源中上传的文件名称一fileFormatString是资源中上传的文件类型一fileSizeString是资源中上传的文件大小一表43 文件资源注册接口-返回书参数格式名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息dataString资源id若新增资源成功则返回新资源的资源id,若更新数据源或推送失败则返回空文件资源更新接口文件资源更新接口见表44、表45和表46。表44 文件资源更新接口名称接口资源推送服务功能说明文件资源上报时,将资源及文件的相关信息推送给目录系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/UpdateFile提交资源数据按照本文件表45执行httpheader按照本文件执行提交数据举例{"id":"0022b5fa457e4dad8e96706470b42f11","resName":"5e19071306fe4663850eac8795235c0c","resDesc":"测试管理中心资源","cataId":"1d3a5d12471941a28067b141c15f137b","regionCode":"230400","orgId":"ba96d8f611e847eaa2b61ad207ad9b1e","orgName":"管理中心","shareType":"1","shareCondition":"","openType":"1","openCondition":"2","fromSystemId":"manaul","fromSystemName":"人工填报","updateCycle":"2","customUpdateCycle":"","creatorId":"1234","creatorName":"测试人员","filePath":"Y2VzaGk=","fileName":"文件资源测试","fileFormat":"txt","fileSize":"5"}返回http状态200返回数据参数按照本文件表46执行返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":"5e19071306fe4663850eac8795235c0c"}表45 文件资源更新接口-提交资源数据格式名称类型必填说明备注idString是资源id省端返回的资源主键resNameString是资源名称一resDescString是资源详情一cataIdString是关联数据目录ID一regionCodeString是所属行政区划编码权限划分orgIdString是所属部门id一orgNameString是所属部门名称一shareTypeString是共享类型1:无条件共享2:有条件共享3:不予共享'shareConditionString否共享条件一openTypeString是开放类型1:可对社会开放2:不可对社会开放'openConditionString否开放条件一fromSystemIdString是来源系统id若无来源应用系统传:manaulfromSystemNameString是来源系统名称若无来源应用系统传:人工填报updateCycleInt是数据更新周期2:每日3:每周4:每月5:每季度6:每半年7:每年8:实时1:其他customUpdateCycleString否用户自定义更新周期updateCycle1必填项creatorIdString是创建者ID一creatorNameString是创建者姓名一filePathString是文件资源二进制流暂支持推送单一文件fileNameString是资源中上传的文件名称一fileFormatString是资源中上传的文件类型一fileSizeString是资源中上传的文件大小一表46 文件资源更新接口-返回数据参数格式名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空dataString资源id若新增资源成功则返回新资源的资源id,若更新数据源或推送失败则返回空接口资源注册接口接口资源注册接口见表47、表48和表49。表47 接口资源注册接口名称接口资源推送接口功能说明接口资源上报时,将资源及文件的相关信息推送给目录系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/CreateApi传入参数Map<String,Object>提交资源数据按照本文件表48执行提交httpheader数据按照本文件执行表47 接口资源注册接口(续)名称 接口资源推送接口提交数据举例{"id":"0022b5fa457e4dad8e96706470b42f11","resName":"5e19071306fe4663850eac8795235c0c","resDesc":"测试管理中心资源","cataId":"1d3a5d12471941a28067b141c15f137b","regionCode":"230400","orgId":"ba96d8f611e847eaa2b61ad207ad9b1e","orgName":"管理中心","shareType":"1","shareCondition":"","openType":"1","openCondition":"2","fromSystemId":"manaul","fromSystemName":"人工填报","updateCycle":"2","customUpdateCycle":"","creatorId":"1234","creatorName":"测试人员","apiPath":"/test","apiType":"https","url":"","timeout":"300","httpMethod":"get","contactName":"张三","contactPhone":,"contactEmail":"123@","authzType":1,"canProxy":1,"inputParams":"[{\"name\":\"username\",\"position\":\"query\",\"type\":\"string\",\"value\":\"张三\",\"desc\":\"用户姓名\",\"status\":\"required\"},{\"name\":\"userage\",\"position\":\"header\",\"type\":\"number\",\"value\":\"20\",\"desc\":\"用户年龄\",\"status\":\"optional\"}]","statusCode":"[{\"code\":\"200\",\"desc\":\"成功\"},{\"code\":\"300\",\"desc\":\"失败\"}]"}返回http状态200返回数据参数按照本文件表49执行表47 接口资源注册接口(续)名称 接口资源推送接口返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":"5e19071306fe4663850eac8795235c0c"}表48 接口资源注册接口-提交资源数据格式表名称类型必填说明备注resNameString是资源名称一resDescString是资源详情─cataIdString是关联数据目录ID─regionCodeString是所属行政区划编码权限划分orgIdString是所属部门id─orgNameString是所属部门名称─shareTypeString是共享类型1:无条件共享2:有条件共享3:不予共享shareConditionString否共享条件─openTypeString是开放类型1:可对社会开放2:不可对社会开放openConditionString否开放条件─fromSystemIdString是来源系统id若无来源应用系统传:manaulfromSystemNameString是来源系统名称若无来源应用系统传:人工填报updateCycleInt是数据更新周期2:每日3:每周4:每月5:每季度6:每半年7:每年8:实时1:其他customUpdateCycleString否用户自定义更新周期updateCycle1creatorIdString是创建者ID─creatorNameString是创建者姓名─apiPathString是服务路径─apiTypeString是接口接入类型http或webserviceurlString是目标服务地址─timeoutInt是超时时间─表48 接口资源注册接口-提交资源数据格式表(续)名称类型必填说明备注httpMethodString否http服务请求方法postgetputdeletehttpPathString否http服务REST路径与目标地址共同构成服务实际地址wsNamespaceString否命名空间─wsSoapbodyString否WS服务的soapbody─wsSoapheaderString否WS服务的soapheader─resultSampleString否接口调用返回结果示例─statusCodeString否状态码JSONArray,包含以下两个参数code:状态代码desc:代码详情inputParamsString否输入参数JSONArray,包含下列六个字段name:参数名称desc:参数描述value:参数默认值type:参数类型(string/number/boolean)status:参数状态(required/optional/constant/template)position:参数位置(query/header/body)contactNameString是联系人姓名─contactPhoneString是联系人电话─contactEmailString是联系人电子邮箱─authzTypeInt是授权方式1:提供方授权2:平台授权canProxyInt是是否允许代理授权1:允许0:不允许表49 接口资源注册接口-返回数据参数格式表名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空,dataString资源id若新增资源成功则返回新资源的资源id,若更新数据源或推送失败则返回空接口资源更新接口接口资源更新接口见表50、表51和表52。表50 接口资源更新接口交换系统管理中心提供省平台资源查询接口名称接口资源推送接口功能说明接口资源上报时,将资源及文件的相关信息推送给目录系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/UpdateApi传入参数Map<String,Object>提交资源数据按照本文件表51执行提交httpheader数据按照本文件执行表50 接口资源更新接口(续)名称接口资源推送接口提交数据举例{"id":"a878a448ac834708ac2ba269ec748365","resName":"测试管理中心资源","resDesc":"测试管理中心资源","cataId":"1d3a5d12471941a28067b141c15f137b","regionCode":"230400","orgId":"ba96d8f611e847eaa2b61ad207ad9b1e","orgName":"管理中心","shareType":"1","shareCondition":"","openType":"1","openCondition":"2","fromSystemId":"manaul","fromSystemName":"人工填报","updateCycle":"2","customUpdateCycle":"","creatorId":"1234","creatorName":"测试人员","apiPath":"/test","apiType":"https","url":"","timeout":"300","httpMethod":"get","contactName":"张三","contactPhone":,"contactEmail":"123@","authzType":1,"canProxy":1,"inputParams":"[{\"name\":\"username\",\"position\":\"query\",\"type\":\"string\",\"value\":\"张三\",\"desc\":\"用户姓名\",\"status\":\"required\"},{\"name\":\"userage\",\"position\":\"header\",\"type\":\"number\",\"value\":\"20\",\"desc\":\"用户年龄\",\"status\":\"optional\"}]","statusCode":"[{\"code\":\"200\",\"desc\":\"成功\"},{\"code\":\"300\",\"desc\":\"失败\"}]"}返回http状态200返回数据参数按照本文件表52执行表50 接口资源更新接口(续)名称接口资源推送接口返回数据举例(处理正常)正常返回:{"code":"200","error":"","data":”5e19071306fe4663850eac8795235c0c"}表51 接口资源更新接口-提交资源数据格式表名称类型必填说明备注idString是资源ididididid主键,并存储在data字段中返回resNameString是资源名称一resDescString是资源详情一cataIdString是关联数据目录ID一regionCodeString是所属行政区划编码权限划分orgIdString是所属部门id一orgNameString是所属部门名称一shareTypeString是共享类型1:无条件共享2:有条件共享3:不予共享shareConditionString否共享条件一openTypeString是开放类型1:可对社会开放2:不可对社会开放openConditionString否开放条件一fromSystemIdString是来源系统id若无来源应用系统传:manaulfromSystemNameString是来源系统名称若无来源应用系统传:人工填报updateCycleInt是数据更新周期2:每日3:每周4:每月5:每季度6:每半年7:每年8:实时1:其他customUpdateCycleString否用户自定义更新周期updateCycle1creatorIdString是创建者ID一表51 接口资源更新接口-提交资源数据格式表(续)名称类型必填说明备注creatorNameString是创建者姓名一apiPathString是服务路径一apiTypeString是接口接入类型http或webserviceurlString是目标服务地址一timeoutInt是请求超时时间一httpMethodString否http服务请求方法postgetputdeletehttpPathString否httpREST与目标地址共同构成服务实际地址wsNamespaceString否命名空间一wsSoapbodyString否WSsoapbody一wsSoapheaderString否WS服务的soapheader一resultSampleString否接口调用返回结果示例一statusCodeString否状态码JSONArray,包含以下两个参数code:状态代码desc:代码详情inputParamsString否输入参数JSONArray,包含下列六个字段name:参数名称desc:参数描述value:参数默认值type:参数类型(string/number/boolean)status:参数状态(required/optional/constant/template)position:参数位置(query/header/body)contactNameString是联系人姓名一contactPhoneString是联系人电话一contactEmailString是联系人电子邮箱一authzTypeInt是授权方式1:提供方授权;2:平台授权canProxyInt是是否允许代理授权1:允许,0:不允许表52 接口资源更新接口-返回数据参数格式表名称类型说明备注codeInt返回参数200推送成功300推送失败errorString返回信息提示信息:失败返回失败信息,成功返回空dataString资源id若新增资源成功则返回新资源的资源id库表资源注册接口库表资源注册接口见表53、表54和表55。表53 库表资源注册接口名称交换资源推送接口功能说明库表资源上报时,将资源及文件的相关信息推送给目录系统URL样式https://xx.xx.xx.xx/interface提交方式POST接口协议https+JSON调用方法/Resource/CreateTable传入参数Map<String,Object>提交资源数据按照本文件表54执行提交httpheader数据按照本文件执行表53 库表资源注册接口(续)名称交换资源推送接口提交数据举例{"id":"5e19071306fe4663850eac8795235c0c","resName":"5e19071306fe4663850eac8795235c0c","resDesc":"管理中心资源","cataId":"5e19071306fe4663850eac8795235c0c","orgId":"ba96d8f611e847eaa2b61ad207ad9b1e","orgName":"管理中心","shareType":"1","openType":"1","openCondition":"开放条件","shareType":"1","shareCondition":"共享条件","updateCycle":"1","customUpdateCycle":"半月","creatorId":"1111111","creatorName":"superadmin","isSavedToPlatform":"0","isSavedToPlatform":"0","datasourceId":"22222","tableName":"table","tableDesc":"描述
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 投资意向合同范本
- 园林绿化泥付工施工承包合同
- 出租车租赁服务通知协议
- 企业信用管理政策制定流程
- 科研创新基地租赁住房管理
- 政府部门会议费审批流程
- 挖掘土方协议范本
- 旅游度假设施监理协议
- 民用爆炸物品事故赔偿
- 客户服务热线编号指南
- 2023年12月人民日报社工作人员(74名)笔试近年2018-2023考点突破与答案详解研判
- 2023-2024学年浙江“七彩阳光”新高考研究联盟高一上学期期中联考生物试题(解析版)
- 机械设备维修保养合同范本2024年
- 2024年江苏省南京市国土资源信息中心招聘2人(高频重点提升专题训练)共500题附带答案详解
- 六年级上册道德与法治教案表格版
- 【专家共识】胎儿生长受限专家共识(2019版)-完整版
- 公文写作智慧树知到期末考试答案章节答案2024年广州大学
- 人教版五年级数学上册第一单元《小数乘法》(大单元教学设计)
- 家庭约法三章合同
- 2024新老物业移交协议
- 在线网课知道智慧《电路(1)(山大)》单元测试考核答案
评论
0/150
提交评论