DB34_T 4085-2021 政府网站信息资源库数据交换规范-(高清现行）.pdf

ICS 35.240.99 CCS L 70 34 安徽省地方标准 DB34/T 40852021 政府网站信息资源库数据交换规范 Data exchange specifications for the government website information resources repository 2021-12-28 发布 2022-01-28 实施安徽省市场监督管理局 发 布DB34/T 40852021 I 前言 本文件按照 GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由安徽省人民政府网管理中心提出。本文件由安徽省信息技术标准化技术委员会（AH/TC25）归口。本文件起草单位：合肥工业大学、安徽省人民政府网管理中心、宿州市数据资源管理局、安徽省质量和标准化研究院、北京开普云信息科技有限公司。本文件主要起草人：郭亚光、寿志勤、许君、汪敏、陶松、陆文星、张怀光、殷文正、彭祖剑、李凯、季静、王静、徐多响。DB34/T 40852021 1 政府网站信息资源库数据交换规范 1 范围 本文件确立了政府网站信息资源库数据交换的基本要求，并规定了数据交换流程和数据交换接口的要求。本文件适用于政府网站信息资源库与政府网站集约化平台、政务服务平台、统一政府热线服务平台等系统的数据交换。2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 7408 数据元和交换格式信息交换 日期和时间表示法 GB/T 15278 信息处理 数据加密 物理层互操作性要求 GB/T 21062.3 政务信息资源交换体系 第3部分：数据接口规范 3 术语和定义 下列术语和定义适用于本文件。3.1 接口使用方 user of data exchange interface 使用数据交换接口的组织。3.2 接口提供方 supplier of data exchange interfaces 提供数据交换接口服务的组织。3.3 平台运营方 operator of data exchange platform 为数据交换平台提供技术服务支撑的组织。4 基本要求 4.1 包括资源服务、资源管理、资源同步等接口。4.2 接口规范描述和开发应按照 GB/T 21062.3 的要求执行。4.3 接口的时间、日期格式应按照 GB/T 7408 的要求执行；4.4 接口应采用 Http/Https 接口访问方式，并用 XML Schema 对接口返回数据格式进行定义。4.5 接口应支持跨防火墙的数据传输，并按照 GB/T 15278 的要求进行加密。DB34/T 40852021 2 5 数据交换流程 数据交换流程见图1。接口使用方接口提供方平台运营方申请提交功能评估安全评估申请审核开始结束开通授权授权凭证反馈验证 数据交换流程 6 交换接口 6.1 资源服务接口 6.1.1 资源服务接口内容 资源服务接口包括但不限于以下类型。a)查询资源分类：通过接口可查询当前资源库的分类设定情况。b)分页查询元数据集：通过接口可分页查询当前资源库的元数据集设定情况。c)分页查询元数据：通过接口可分页查询当前资源库的元数据设定情况。d)根据元数据集 ID 获取所有的元数据：通过接口可根据元数据集 ID 获取对应元数据集下所有元数据设定情况。e)分页查询字典信息：通过接口可查询当前资源库字典信息设定情况。f)获取资源标签：通过接口可获取当前资源库标签设定情况。6.1.2 查询资源分类 查询资源分类接口见表1。DB34/T 40852021 3 表 1 查询资源分类接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/getClassifysById 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data id String 是 id=“0”，获取资源全部基础分类；id=“-1”，获取资源一级拓展分类；id=拓展分类ID，获取下一级拓展分类；返回数据 格式（id=“0”，获取资源全部基础分类；）成功：code:0,msg:操作成功,data:略,失败：请参照接口返回错误状态码表（见附录A）。返回数据 格式（id=“-1”，获取资源一级拓展分类；）成功：code:0,msg:操作成功,data:略,失败：请参照接口返回错误状态码表（见附录A）。返回数据 格式（id=拓展分类ID，获取下一级拓展分类；）成功：code:0,msg:操作成功,data:略,失败：请参照接口返回错误状态码表（见附录A）。6.1.3 分页查询元数据集 分页查询元数据集接口见表2。DB34/T 40852021 4 表 2 分页查询元数据集接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/getAllMetadataList 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data pageIndex String 是 当前页 pageSize String 是 每页显示记录数 返回数据 格式 成功：code:0,msg:操作成功,data:略 失败：请参照接口返回错误状态码表（见附录A）。6.1.4 分页查询元数据 分页查询元数据接口见表3。表 3 分页查询元数据接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/getAllMetadatas 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data pageIndex String 是 当前页 pageSize String 是 每页显示记录数 返回数据 格式 成功：code:0,msg:操作成功,data:略 失败：请参照接口返回错误状态码表（见附录A）。6.1.5 根据元数据集 ID 获取所有的元数据 根据元数据集ID获取所有元数据接口见表4。DB34/T 40852021 5 表 4 根据元数据集 ID 获取所有元数据接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/getMetadatasByDmId 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data dmId String 是 元数据集ID 返回数据 格式 成功：code:0,msg:操作成功,data:略 失败：请参照接口返回错误状态码表（见附录A）。6.1.6 分页查询字典信息 分页查询字典信息接口见表5。表 5 分页查询字典信息接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/getDictionaryDataByParentId 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data dicType String 是 字典类型:0为查询系统字典；1为查询用户字典；parentId String 否 字典父节点ID dicDataName String 否 字典名称（可模糊匹配）pageIndex String 是 当前页 pageSize String 是 每页显示记录数 返回数据格式 成功：code:0,msg:操作成功,data:略 失败：请参照接口返回错误状态码表（见附录A）。6.1.7 获取资源标签 DB34/T 40852021 6 获取资源标签接口见表6。表 6 获取资源标签接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/other/selectLabelManagement 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data searchWord String 否 名称模糊匹配 返回数据格式 成功：code:0,msg:操作成功,data:略 失败：请参照接口返回错误状态码表（见附录A）。6.2 资源管理接口 6.2.1 资源管理接口内容 资源管理接口包括但不限于以下类型。a)新增资源：通过接口可在指定资源库新增一条信息资源，并设定其相关属性。b)批量删除资源：通过接口可批量删除指定资源库目录或指定信息资源 ID 的资源。c)批量移动资源：通过接口可批量移动指定资源库目录或指定信息资源 ID 的资源。d)根据资源 ID 查询：通过接口可根据资源 ID 查询指定资源的相关情况。e)上传文件：通过接口可上传本地已有的信息资源。f)下载文件：通过接口可下载指定地址的信息资源。6.2.2 新增资源 新增资源接口见表7。表 7 新增资源接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/createRes 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default data libFlag String 否 libFlag=1时，为原始资源库资源 libFlag为空或其他时，为主题库资源 origLibId String 否 当libFlag=1时，origLibId为必填 为原始库库ID DB34/T 40852021 7 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/createRes 请求参数 参数名称 类型 是否必须描述 isOrig String是 isOrig=0时，dirId为资源库的目录ID isOrig=1时，dirId为原始对象目录ID dirId String是 origId String否 原始资源ID name String是 名称 resClassify String否 扩展分类ID basicClassification String是 基础分类ID domainLabel String否 标签ID deptId String否 部门ID 如果为空获取当前绑定目录部门；目录部门为空则获取库所属机构 都查询不到，则为空 sharedStatus String否 共享资源标识 0:不共享 1:共享 status String否 资源状态:状态 1:草稿；2:待审核(保留字段)；3:正式；4:已删除；5:彻底删除；6:已撤销；7:已驳回(保留字段)；8:已否决(保留字段)；9:已归档(保留字段)默认为草稿 子表元数据1 String否 Value：场景1、ListMap 场景2、字符串UUID，对应子表的一个List 注意：有子表时，该字段为必传 子表元数据2 String否 Value：场景1、ListMap 场景2、字符串UUID，对应子表的一个List 注意：有子表时，该字段为必传 附件/图片/音视频等多种类型 String否/附件/图片/视频/音频类 数组方式 url可以传绝对路径，接口内部自动下载,可以传相对路径,针对已经上传的文件类型 pic:为定义的元数据短名或第三方数据转换后的属性名称，根据情况填写 path：路径 必传 为固定传参，附件/图片/视频/音频等路径,相对路径/绝对路径均可，绝对路径接口内部下载 name：名称 必传，默认为资源名称加后缀 为固定传参，附件/图片/视频/音频等自定义名称 mimeType：上传文件类型，非必传，默认为接口内部自动解析的文件类型，可参考网址：http:/ 为固定传参，附件/图片/视频/音频等文件类型标注，如jpg类型可以定义mimeType为application/x-jpg DB34/T 40852021 8 请求方式 POST URL http(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 属性1N String 否 自定义属性,按需扩展；可传自定义元数据属性以及第三方需要保存到资源库字段 例如：已知在资源库定义元数据短名为title：json.put(tilte,元数据短名);第三方所属字段：json.put(ext_title,第三方自定义数据);字典类型 String 否 例如：单选按钮/多 返回数据格式 成功：code:0,msg:操作成功,data:5bfbab21d2e8822813dd5e79 失败：请参照接口返回错误状态码表（见附录A）。6.2.3 批量删除资源 批量删除资源接口见表8。表 8 批量删除资源接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/delRes 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data isOrig String 是 isOrig=0时，resIds为资源库的资源ID isOrig=1时，resIds为原始对象ID resIds String 是 libFlag String 否 libFlag=1时，为原始资源库资源 libFlag为空或其他时，为主题库资源 DB34/T 40852021 9 libId String 是 库ID 返回数据 格式 成功：code:0,msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。6.2.4 批量移动资源 批量移动资源接口见表9。表 9 批量移动资源接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/moveRes 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data isOrig String 是 isOrig=0时，toDirId为目录ID，resIds为资源ID isOrig=1时，toDirId和resIds必须全部为原始对象ID toDirId String 是 resIds String 是 libId String 否 库ID 返回数据 格式 成功：code:0,msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。6.2.5 根据资源 id 查询 根据资源id查询接口见表10。表 10 根据资源 id 查询接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/getResById 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data isOrig String 是 isOrig=0时，resId为资源库的资源ID isOrig=1时，resId为原始对象ID resId String 是 libFlag String 否 libFlag=1时，为原始资源库资源 libFlag为空或其他时，为主题库资源 DB34/T 40852021 10 libId String 否 库ID 返回数据 格式 成功：code:0,msg:操作成功,data:isConvert:true 失败：请参照接口返回错误状态码表（见附录A）。6.2.6 上传文件 上传文件接口见表11。表 11 上传文件接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/uploadFile 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default data fileInputStreamFileInputStream是 文件流 返回数据 格式 成功：code:0,msg:上传文件成功,data:fileURL:略,失败：请参照接口返回错误状态码表（见附录A）。6.2.7 下载文件 下载文件接口见表12。表 12 下载文件接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/resource/downloadFile 请求参数 参数名称 类型 是否必须 描述 appId appId String 是 服务ID，明文传输，如:appId=default data fileURL String 是 文件地址 返回数据格式 成功：DB34/T 40852021 11 文件流 失败：请参照接口返回错误状态码表（见附录A）。6.3 资源同步接口 6.3.1 资源同步接口内容 资源同步接口包括但不限于以下类型。a)创建资源同步策略：通过接口可创建一条用于不同资源库间进行资源同步的同步策略，可对同步时间、频次、对应站点/栏目等参数进行设定。b)修改资源同步策略：通过接口可修改已创建的资源同步策略。c)启动/停止资源同步策略：通过接口可启动/停止对应策略 ID 的资源同步策略。d)删除资源同步策略：通过接口可删除指定策略 ID 的资源同步策略。6.3.2 创建资源同步策略 创建资源同步策略接口见表13。表 13 创建资源同步策略接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/pushConfig/createPushStrategy 验证级别 user 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default data strategyName String 是 策略名称 syncStartTime String 是 格式（HH:mm:ss）同步开始时间 pushToChannels String 是 需要同步到的栏目信息集合 参数名 类型 是否必须 描述 applyCode String 是 适配器编码 websiteId String 是 应用站点id channelId String 是 栏目id channelPathIdsString 是 栏目全路径id channelPathStrString 是 栏目全路径字符串 isOpenSynchro String 是 是否开启同步 0:否 1:是；默认1 synStatus String 是 1按天 2 按小时 3 按分钟 synDate String 是 具体时间(具体数字，比如：synStatus 选择天，取值范围1-31 synStatus 选择小时，取值范围 0-24 synStatus 选择分，取值范围 0-59 DB34/T 40852021 12 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/pushConfig/createPushStrategy 验证级别 user 请求参数 参数名称 类型 是否必须描述)libId String 是（两个参数必须有一个必填）库ID，多个英文逗号分割 dirId 目录ID，多个英文逗号分割 searchModel JSONObject 否 精确查询：accurate 模糊查询：like 返回数据 格式 成功：code:0,data:12dfe7bbf64b4829b9f1f2a6497ad8c0,/返回保存成功后的策略ID msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。6.3.3 修改资源同步策略 修改资源同步策略接口见表14。表 14 修改资源同步策略接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/pushConfig/updatePushStrategy 验证级别 user 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default strategyId String 是 策略ID（新增策略时返回的ID）data strategyName String 是 策略名称 syncStartTimeString 是 格式（HH:mm:ss）同步开始时间 pushToChannelsString 是 需要同步到的栏目信息集合 参数名 类型 是否必须 描述 applyCode String 是 适配器编码 websiteId String 是 应用站点id channelId String 是 栏目id channelPathIdsString 是 栏目全路径id channelPathStrString 是 栏目全路径字符串 isOpenSynchroString 是 是否开启同步 0:否 1:是；默认1 DB34/T 40852021 13 synStatus String 是 1 按天 2 按小时 3 按分钟 synDate String 是 具体时间(具体数字，比如：synStatus 选择天，取值范围1-31 synStatus 选择小时，取值范围 0-24 synStatus 选择分钟，取值范围 0-59 libId String 是（两个参数必须有一个必填）库ID，多个英文逗号分割 dirId 目录ID，多个英文逗号分割 searchModel JSONObject 否 精确查询：accurate 模糊查询：like 返回数据 格式 成功：code:0,msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。6.3.4 启动/停止资源同步策略 启动/停止资源同步策略接口见表15。表 15 启动/停止资源同步策略接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/pushConfig/startOrStopPushStrategy 验证级别 user 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default data strategyId String 是 策略ID（新增策略时返回的ID）isOpenSynchro String 是 是否开启同步 0:否 1:是；返回数据 格式 成功：code:0,msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。6.3.5 删除资源同步策略 DB34/T 40852021 14 删除资源同步策略接口见表16。表 16 删除资源同步策略接口 请求方式 POST URL http(s):/ip:port/zuul/repo-api/api/res/pushConfig/delPushStrategy 验证级别 user 请求参数 参数名称 类型 是否必须描述 appId appId String 是 服务ID，明文传输，如:appId=default data strategyId String 是 策略ID（新增策略时返回的ID）返回数据 格式 成功：code:0,msg:操作成功 失败：请参照接口返回错误状态码表（见附录A）。DB34/T 40852021 15 附 录 A（资料性）接口返回错误状态码表 政府网站信息资源库数据交换接口返回错误状态码见表A.1。表 A.1 接口返回错误状态码表 返回代码 错误类型 20005 接口参数错误 30001 接口调用异常 30002 接口非法访问 DB34/T 40852021 16 参考文献 1 国务院办公厅关于印发政府网站发展指引的通知（国办发201747号）2 国务院办公厅关于印发政府网站集约化试点工作方案的通知（国办函201871号）3 安徽省人民政府办公厅关于印发安徽省政府网站集约化试点工作实施方案的通知（皖政办秘2018309号）4 安徽省人民政府办公厅关于印发省级政府网站集约化平台管理暂行办法和安徽省政府网站信息资源库管理暂行办法的通知（皖政办秘2020120号）