目錄管理系統(tǒng)-接口設(shè)計說明

目錄管理系統(tǒng)-接口設(shè)計說明修訂記錄版本號作者日期修訂說明V1.0 目錄1. 引言 -1-1.1 系統(tǒng)概述 -1-1.2 文檔概述 -1-2. 引用文件 -2-3. 接口設(shè)計 -3-3.1 接口標(biāo)識和接口圖 -3-3.2 接口的項目唯一標(biāo)識符 -5-3.2.1 東方通數(shù)據(jù)交換平臺 -5- 目錄列表查詢接口 -5- 交換資源推送接口 -6- 目錄資源數(shù)據(jù)推送接口 -7-3.2.2 統(tǒng)一管理平臺 -8- 接口授權(quán) -8- 用戶增加接口 -9- 用戶修改接口 -10- 用戶刪除接口 -10- 部門增加接口 -11- 部門修改接口 -12- 部門刪除接口 -12- 菜單列表查詢接口 -13- 菜單角色添加接口 -13-0 菜單角色修改接口 -14-1 菜單角色刪除接口 -15-2 目錄分類角色查詢接口 -15-3 目錄權(quán)限添加接口 -15-引言系統(tǒng)概述通過政務(wù)信息資源目錄管理系統(tǒng)用于規(guī)范政務(wù)部門政務(wù)信息資源目錄的編制和國家政務(wù)信息資源目錄的匯總編制，方便政務(wù)信息資源管理、共享和發(fā)布等工作。根據(jù)相關(guān)技術(shù)規(guī)范的要求，政務(wù)信息資源目錄管理系統(tǒng)功能的主要功能包括信息資源編目、目錄導(dǎo)出、目錄匯集、目錄發(fā)布等。文檔概述本文檔適用于市市平臺開發(fā)人員閱讀，文檔概述了政務(wù)信息資源目錄管理系統(tǒng)與交換平臺、政務(wù)信息資源目錄管理系統(tǒng)與統(tǒng)一管理所使用的各種接口設(shè)計。引用文件《計算機(jī)軟件開發(fā)規(guī)范》（GB/T8566-2007）《計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南》（GB/T8567—2006）《軟件工程術(shù)語》（GB/T11457—89）《計算機(jī)軟件配置管理計劃規(guī)范》（GB/T12260-90）《計算機(jī)軟件質(zhì)量保證計劃規(guī)范》（GB/T12504-90）《計算機(jī)軟件可靠性和可維護(hù)性管理》（GB/T14394-93）《政務(wù)信息資源目錄管理系統(tǒng)-接口需求規(guī)格說明》《政務(wù)信息資源目錄管理系統(tǒng)-軟件設(shè)計說明書》接口設(shè)計接口標(biāo)識和接口圖接口訪問地址為DXPDockingController/+接口標(biāo)識。接口協(xié)議為HTTP+JSON。方法為POST。接口示例：resourceInfoPush請求消息字段描述jsonStr={"id":"rds_table_s_5e19071306fe4663850eac8795235c0c","cata_id":"5e19071306fe4663850eac8795235c0c","orgName":"管理中心","orgId":"111","resourceName":"用戶信息表","resourceDesc":"user_copy","resourceType":"table","optype":"add","subTime":"2017-10-3014:48:24"}resourceInfoPush返回消息字段描述{code:200,msg:""}部署環(huán)境同步編目系統(tǒng)表3.1接口對應(yīng)標(biāo)識接口名標(biāo)識(方法名)目錄列表查詢getCatalogListByPage交換資源推送resourceInfoPush目錄資源數(shù)據(jù)推送tableColumnInfoPush接口授權(quán)BeginLogin用戶增加addUser用戶修改updateUser用戶刪除deleteUser部門增加AddDepartment部門修改updateDept部門刪除DeleteDepartment菜單列表查詢QueryMenuList菜單角色添加AddMenuCharacter菜單角色修改ModifyMenuCharacter菜單角色刪除DeleteMenuCharacter目錄分類角色查詢QueryUserAuthorization目錄權(quán)限添加AddUserRightsAssignment接口的項目唯一標(biāo)識符東方通數(shù)據(jù)交換平臺目錄列表查詢接口方法名稱getCatalogListByPage接口方法參數(shù)需求表3.1授權(quán)接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述methodStringYGetCataLogByPagepageIntegerY查詢頁碼（分頁參數(shù)）regionIdStringY域IDpageSizeIntegerY查詢每頁數(shù)量（分頁參數(shù)）cata_titleStringN目錄標(biāo)題（搜索參數(shù)）statusIntegerY目錄狀態(tài)：0待配置2待發(fā)布3已發(fā)布4已上線5已下線如果不傳表示查詢所有狀態(tài)也可用”,”號隔開查詢多個狀態(tài)user_idStringY統(tǒng)一認(rèn)證用戶id交換資源推送接口方法名稱resourceInfoPush接口方法參數(shù)需求表3.1目錄分類接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述idStringY交換資源idcata_idStringY目錄資源idresourceNameStringY資源名稱resourceDescStringY資源備注resourceTypeStringY交換資源類型:1.table:表資源2.file:文件3.api:接口orgNameStringY發(fā)布的機(jī)構(gòu)realResourceStringY真實資源1.表名2.文件路徑orgIdStringY發(fā)布的機(jī)構(gòu)idsubTimeStringY發(fā)布的時間userIdStringY用戶標(biāo)識optypeStringY操作類型:1.add:新增2:update:修改3:delete：刪除statusStringY狀態(tài)1.變更申請審核通過2.平臺審核通過3.已發(fā)布4.撤銷倒計時5.刪除regionIdStringY域idsystemIdStringY來源系統(tǒng)idsharedTypeStringY共享類型:1:無條件共享2:有條件共享3:不予共享sharedConditionStringY共享條件publicTypeStringY開放類型:1:向社會開放2:不向社會開放publicConditionStringY開放條件ownerOrgNameStringN資源所屬機(jī)構(gòu)名稱ownerOrgIdStringN資源所屬機(jī)構(gòu)idversionStringY版本號delDescStringY撤銷理由updateDescStringY變更理由updateCycleStringY資源更新周期目錄資源數(shù)據(jù)推送接口方法名稱TableColumnInfoPush接口方法參數(shù)需求表3.1目錄資源數(shù)據(jù)推送接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述cata_idStringY目錄idresource_idStringY資源idtable_nameStringY表名columnsStringY庫表資源字段信息name_cnStringY信息項中文名name_tableStringY信息項字段名field_typeStringY字段類型lengthStringY字段長度is_null_fieldStringY是否為空，1：為空，0：不為空is_pk_fieldStringY是否主鍵，1：是，0：否order_numStringN排序統(tǒng)一管理平臺接口授權(quán)方法名稱BeginLogin接口方法參數(shù)需求表3.1接口授權(quán)接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述LOGIN_NAMEStringY登錄名PASSWORDStringY密碼用戶增加接口方法名稱addUser接口方法參數(shù)需求表3.1用戶增加接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述USER_IDStringY用戶ID(long)TOKENStringY憑據(jù)LOGINNAMEStringY登錄名USERNAMEStringY用戶名PASSWORDStringY密碼SEXStringN性別1-男0-女TELEPHONEStringN座機(jī)號MOBILEStringN手機(jī)號MAILStringN郵箱用戶修改接口方法名稱updateUser接口方法參數(shù)需求表3.1用戶修改接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述USER_NAMEStringN用戶名PASSWORDStringN密碼SEXStringN性別1-男0-女TELEPHONEStringN座機(jī)號MOBILEStringN手機(jī)號MAILStringN郵箱USER_IDStringY新增用戶返回的用戶唯一標(biāo)識TOKENStringY憑據(jù)用戶刪除接口方法名稱deleteUser接口方法參數(shù)需求表3.1用戶刪除接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述USER_IDStringY新增用戶返回的用戶唯一標(biāo)識TOKENStringY憑據(jù)部門增加接口方法名稱AddDepartment接口方法參數(shù)需求表3.1部門增加接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述DEPT_IDStringY部門ID(Long)DEPTNAMEStringY部門名稱DESCRIPTIONStringN部門簡述PIDintY上級部門id如沒有上級部門:(所屬部門為固定值2所屬區(qū)縣為固定值3)QQNUMStringY部門聯(lián)系人QQ號EMAILStringY部門聯(lián)系人郵箱PHONENUMStringY部門聯(lián)系人手機(jī)號CONTACTStringY部門聯(lián)系人名子ORDERNUMStringN用戶排序1為第一位以此類推TOKENStringY憑據(jù)部門修改接口方法名稱updateDept接口方法參數(shù)需求表3.1部門修改接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述TOKENStringY憑據(jù)DEPT_IDStringY部門唯一標(biāo)識DEPTNAMEStringY部門名稱DESCRIPTIONStringN部門簡述QQNUMStringN部門聯(lián)系人QQ號EMAILStringN部門聯(lián)系人郵箱CONTACTStringN部門聯(lián)系人名子ORDERNUMStringN用戶排序1為第一位以此類推部門刪除接口方法名稱DeleteDepartment接口方法參數(shù)需求參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述TOKENStringYTOKENDEPT_IDStringYDEPT_ID表3.1部門刪除接口菜單列表查詢接口方法名稱QueryMenuList接口方法參數(shù)需求表3.1菜單查詢接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述TOKENStringY憑據(jù)USER_IDStringY用戶IDSYSTEM_IDStringY系統(tǒng)ID：1.政務(wù)信息資源目錄管理系統(tǒng)ID為12.政務(wù)信息采集系統(tǒng)ID為53.政務(wù)信息資源管理系統(tǒng)ID為4菜單角色添加接口方法名稱AddMenuCharacter接口方法參數(shù)需求表3.1菜單角色添加接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述TOKENStringY憑據(jù)USER_IDStringY用戶IDMENU_IDStringY菜單ID,菜單ID,多個菜單ID用英文”,”分割NAMEStringY角色名稱DESCRIPTIONStringY角色簡述菜單角色修改接口方法名稱ModifyMenuCharacter接口方法參數(shù)需求表3.1菜單修改接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述RULE_IDStringY菜單角色I(xiàn)DTOKENStringY用戶授權(quán)的唯一票據(jù)NAMEStringN角色名稱DESCRIPTIONStringN角色簡述MENU_IDStringN菜單角色唯一標(biāo)識,菜單ID,多個菜單ID用英文”,”分割菜單角色刪除接口方法名稱DeleteMenuCharacter接口方法參數(shù)需求表3.1菜單刪除接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述RULE_IDStringY菜單角色唯一標(biāo)識TOKENStringY用戶授權(quán)的唯一票據(jù)目錄分類角色查詢接口方法名稱QueryUserAuthorization接口方法參數(shù)需求表3.1目錄分類角色查詢接口參數(shù)名參數(shù)類型是否必填（Y/N）參數(shù)描述TOK