DB34-T 4085-2021 政府网站信息资源库数据交换规范-高清现行

ICS35.240.9934CCSL7034安 徽 省 地 方 标 准DB34/T4085—2021政府网站信息资源库数据交换规范Dataexchangespecificationsforthegovernmentwebsiteinformationresourcesrepository2021-12-282021-12-282022-01-28安徽省市场监督管理局发布DB34/T4085DB34/T4085—2021前 言GB/T1.1—2020《标准化工作导则第1起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由安徽省人民政府网管理中心提出。本文件由安徽省信息技术标准化技术委员会（AH/TC25）归口。量和标准化研究院、北京开普云信息科技有限公司。凯、季静、王静、徐多响。IIDB34/T4085DB34/T4085—2021DB34/T4085DB34/T4085—2021政府网站信息资源库数据交换规范范围要求。等系统的数据交换。规范性引用文件（包括所有的修改单适用于本文件。GB/T21062.3政务信息资源交换体系第3部分：数据接口规范3术语和定义下列术语和定义适用于本文件。GB/T21062.3政务信息资源交换体系第3部分：数据接口规范3术语和定义下列术语和定义适用于本文件。3.1接口使用方userofdataexchangeinterface使用数据交换接口的组织。3.2接口提供方supplierofdataexchangeinterfaces提供数据交换接口服务的组织。3.3平台运营方operatorofdataexchangeplatform为数据交换平台提供技术服务支撑的组织。4基本要求包括资源服务、资源管理、资源同步等接口。GB/T21062.3GB/T7408Http/HttpsXMLSchemaGB/T1527815数据交换流程开始结束授权凭证反馈开始结束授权凭证反馈申请审核申请提交平台运营方接口提供方接口使用方验证开通授权功能评估安全评估数据交换流程6交换接口资源服务接口资源服务接口内容资源服务接口包括但不限于以下类型。查询资源分类：通过接口可查询当前资源库的分类设定情况。分页查询元数据集：通过接口可分页查询当前资源库的元数据集设定情况。分页查询元数据：通过接口可分页查询当前资源库的元数据设定情况。IDID分页查询字典信息：通过接口可查询当前资源库字典信息设定情况。获取资源标签：通过接口可获取当前资源库标签设定情况。查询资源分类查询资源分类接口见表1。2表1查询资源分类接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/getClassifysById请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdataidString是id=“0”，获取资源全部基础分类；id=“-1”，获取资源一级拓展分类；id=拓展分类ID，获取下一级拓展分类；成功：{返回数据"code":0,格式（id="msg":"操作成功",“0”，获取"data":{ 略资源全部基},础分类；）}失败：请参照接口返回错误状态码表（见附录A）。成功：{返回数据"code":0,格式（id="msg":"操作成功",“-1”，获取"data":{ 略资源一级拓},展分类；）}失败：请参照接口返回错误状态码表（见附录A）。返回数据（id=展分类ID取下一级拓展分类；）成功：{"code":0,"msg":"操作成功","data":{ 略},}失败：请参照接口返回错误状态码表（见附录A）。6.1.3分页查询元数据集6.1.3分页查询元数据集分页查询元数据集接口见表2。3表2分页查询元数据集接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/getAllMetadataList请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatapageIndexString是当前页pageSizeString是每页显示记录数成功：{"code":0,返回数据格式"msg":"操作成功"data":{ }}失败：请参照接口返回错误状态码表（见附录A）。分页查询元数据接口见表3。表3分页查询元数据接口6.1.5根据元数据集ID获取所有的元数据分页查询元数据接口见表3。表3分页查询元数据接口6.1.5根据元数据集ID获取所有的元数据根据元数据集ID获取所有元数据接口见表4。4请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/getAllMetadatas请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatapageIndexString是当前页pageSizeString是每页显示记录数成功：{"code":0,返回数据格式"msg":"操作成功"data":{ 略}}失败：请参照接口返回错误状态码表（见附录A）。表4根据元数据集ID获取所有元数据接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/getMetadatasByDmId请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatadmIdString是元数据集ID成功：{"code":0,返回数据格式"msg":"操作成功"data":{ }}失败：请参照接口返回错误状态码表（见附录A）。6.1.6分页查询字典信息表5分页查询字典信息接口6.1.7获取资源标签5表5分页查询字典信息接口6.1.7获取资源标签5请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/getDictionaryDataByParentId请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatadicTypeString是字典类型:0为查询系统字典；1为查询用户字典；parentIdString否字典父节点IDdicDataNameString否字典名称（可模糊匹配）pageIndexString是当前页pageSizeString是每页显示记录数成功：{"code":0,"msg":"操作成功",返回数据格式"data":{ 略}}失败：请参照接口返回错误状态码表（见附录A）。获取资源标签接口见表6。表6获取资源标签接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/other/selectLabelManagement请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatasearchWordString否名称模糊匹配返回数据格式成功：{"code":0,"msg":""data":{略}}失败：请参照接口返回错误状态码表（见附录A）。资源管理接口内容资源管理接口包括但不限于以下类型。新增资源：通过接口可在指定资源库新增一条信息资源，并设定其相关属性。资源管理接口内容资源管理接口包括但不限于以下类型。新增资源：通过接口可在指定资源库新增一条信息资源，并设定其相关属性。IDIDIDID上传文件：通过接口可上传本地已有的信息资源。下载文件：通过接口可下载指定地址的信息资源。新增资源新增资源接口见表7。表7新增资源接口6请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/createRes请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatalibFlagString否libFlag=1时，为原始资源库资源libFlag为空或其他时，为主题库资源origLibIdString否当libFlag=1时，origLibId为必填为原始库库ID请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/createRes请求参数参数名称类型是否必须描述isOrigString是isOrig=0时，dirId为资源库的目录IDisOrig=1时，dirId为原始对象目录IDdirIdString是origIdString否原始资源IDnameString是名称resClassifyString否扩展分类IDbasicClassificationString是基础分类IDdomainLabelString否标签IDdeptIdString否部门ID如果为空获取当前绑定目录部门；目录部门为空则获取库所属机构都查询不到，则为空sharedStatusString否共享资源标识0:不共享 1:共享statusString否资源状态:状态1:草稿；2:待审核(保留字段)；3:正式；4:已删除；5:彻底删除；6:已撤销；7:已驳回(保留字段)；8:已否决(保留字段)；9:已归档(保留字段)默认为草稿子表元数据1String否Value：场景1、List<Map<String,String>>场景2、字符串UUID，对应子表的一个List注意：有子表时，该字段为必传子表元数据2String否Value：场景1、List<Map<String,String>>场景2、字符串UUID，对应子表的一个List注意：有子表时，该字段为必传附件/图片/音视频等多种类型String否//附件/图片/视频/音频类数组方式url可以传绝对路的文件类型pic:为定义的元数据短名或第三方数据转换后的属性名称，根据情况填写path：路径必传为固定传参，附件/图片/视频/音频等路径,相对路径/绝对路径均可，绝对路径接口内部下载name：名称必传，默认为资源名称加后缀为固定传参，附件/图片/视频/音频等自定义名称mimeType：上传文件类型，非必传，默认为接口内部自动解析的文件类型，可参考网址：/commons为固定传参，附件/图片/视频/音频等文件类型标注，如jpg类型可以定义mimeType为application/x-jpg776.2.3批量删除资源批量删除资源接口见表8。6.2.3批量删除资源批量删除资源接口见表8。表8批量删除资源接口8请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/createRes请求参数参数名称类型是否必须描述"pic":[{"path":"group1/M00/0D/49/wKgBxF2AT26AFG7XAABR3qJw6x8118.jpg","name":"图片名称1.jpg","mimeType":"application/x-jpg"}]属性1…NString否自定义属性,按需扩展；可传自定义元数据属性以及第三方需要保存到资源库字段例如：已知在资源库定义元数据短名为title：json.put("tilte","元数据短名");第三方所属字段：json.put("ext_title","第三方自定义数据");字典类型String否例如：单选按钮/多返回数据格式成功：{"code":0,"msg":"操作成功","data":"5bfbab21d2e8822813dd5e79"}失败：请参照接口返回错误状态码表（见附录A）。请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/delRes请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdataisOrigString是isOrig=0时，resIds为资源库的资源IDisOrig=1时，resIds为原始对象IDresIdsString是libFlagString否libFlag=1时，为原始资源库资源libFlag为空或其他时，为主题库资源6.2.5根据资源id查询6.2.5根据资源id查询根据资源id查询接口见表10。10根据资源id9libIdString是库ID成功：{返回数据格式"code":0,"msg":"操作成功"}失败：请参照接口返回错误状态码表（见附录A）。6.2.4批量移动资源批量移动资源接口见表9。表9批量移动资源接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/moveRes请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdataisOrigString是isOrig=0时，toDirId为目录ID，resIds为资源IDisOrig=1时，toDirId和resIds必须全部为原始对象IDtoDirIdString是resIdsString是libIdString否库ID返回数据格式成功：{"code":0,"msg":"操作成功"}失败：请参照接口返回错误状态码表（见附录A）。请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/getResById请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdataisOrigString是isOrig=0时，resId为资源库的资源IDisOrig=1时，resId为原始对象IDresIdString是libFlagString否libFlag=1时，为原始资源库资源libFlag为空或其他时，为主题库资源6.2.7下载文件6.2.7下载文件下载文件接口见表12。表12下载文件接口10libIdString否库ID返回数据格式成功：{"code":0,"msg":""data":{"isConvert":true}失败：请参照接口返回错误状态码表（见附录A）。6.2.6上传文件上传文件接口见表11。表11上传文件接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/uploadFile请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatafileInputStreamFileInputStream是文件流成功：{"code":0,"msg":"上传文件成功",返回数据"data":{格式"fileURL":"略",}}失败：请参照接口返回错误状态码表（见附录A）。请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/resource/downloadFile请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatafileURLString是文件地址返回数据格式成功：文件流失败：文件流失败：请参照接口返回错误状态码表（见附录A）。资源同步接口资源同步接口内容资源同步接口包括但不限于以下类型。创建资源同步策略：通过接口可创建一条用于不同资源库间进行资源同步的同步策略，可对同步时间、频次、对应站点/栏目等参数进行设定。修改资源同步策略：通过接口可修改已创建的资源同步策略。启动/停止资源同步策略：通过接口可启动/IDID创建资源同步策略创建资源同步策略接口见表13。表13创建资源同步策略接口请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/pushConfig/createPushStrategy验证级别user请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultdatastrategyNameString是策略名称syncStartTimeString是格式（HH:mm:ss）同步开始时间pushToChannelsString是需要同步到的栏目信息集合参数名类型是否必须描述applyCodeString是适配器编码websiteIdString是应用站点idchannelIdString是栏目idchannelPathIdsString是栏目全路径idchannelPathStrString是栏目全路径字符串isOpenSynchroString是是否开启同步0:否1:是；默认1synStatusString是1按天按小时按分钟synDateString是具体时间(具体数字，比如：synStatus选择天，取值范围1-31synStatus选择小时，取值范围0-24synStatus选择分，取值范围0-5911116.3.3修改资源同步策略修改资源同步策略接口见表14。6.3.3修改资源同步策略修改资源同步策略接口见表14。表14修改资源同步策略接口12请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/pushConfig/createPushStrategy验证级别user请求参数参数名称类型是否必须描述)libIdString是（两个参数必须有一个必填）库ID，多个英文逗号分割dirId目录ID，多个英文逗号分割searchModelJSONObject否精确查询：accurate模糊查询：like返回数据格式成功：{"code":0,"data":"12dfe7bbf64b4829b9f1f2a6497ad8c0",//返回保存成功后的策略"msg":"操作成功"}失败：请参照接口返回错误状态码表（见附录A）。请求方式POSTURLhttp(s)://[ip]:[port]/zuul/repo-api/api/res/pushConfig/updatePushStrategy验证级别user请求参数参数名称类型是否必须描述appIdappIdString是服务ID，明文传输，如:appId=defaultstrategyIdString是策略ID（新增策略时返回的ID）datastrategyNameString是策略名称syncStartTimeString是格式（HH:mm:ss）同步开始时间pushToChannelsString是需要同步到的栏目信息集合参数名类型是否必须描述applyCodeString是适配器编码websiteIdString是应用站点idchannelIdString是栏目idchannelPathIdsString是栏目全路径idchannelPathStrString是栏目全路径字符串isOpenSynchroString是是否开启同步0:否1:是；默认16.3.4启动/停止资源同步策略启动/停止资源同步策略接口见表15。6.3.4启动/停止资源同步策略启动/停止资源同步策略接口见表15。表15启动/停止资源同步策略接口6.3.5删除资源同步策略13synStatusString是按天按小时按分钟synDateString是具体时间(具体数字，比如：synStatus选择天，取值范围1-31synStatus选择小时，取值范围synStatus选择分钟，取值范围0-59libIdString是（两个参数必须有一个必填）库ID，多个英文逗号分割dirId/r