復雜施工環(huán)境大型地下工程裝備設計制造運維信息接口要求

復雜施工環(huán)境大型地下工程裝備設計制造運維信息接口要求1范圍本文件規(guī)定了復雜施工環(huán)境下大型地下工程裝備設計制造運維環(huán)節(jié)一體化建設運用過程中，各環(huán)節(jié)過程接口協(xié)議、內(nèi)容以及安全的規(guī)范。本文件適用于復雜施工環(huán)境下大型地下工程裝備一體化集成方案設計與實施。2規(guī)范性引用文件下列文件中的條款通過本文件的引用而成為本文件的條款。下列文件對于本文件的應用是必不可少的。凡是注日期的引用文件，其隨后所有的修改單（不包括勘誤的內(nèi)容）或修訂版均不適用于本文件，然而，鼓勵根據(jù)本文件達成協(xié)議的各方研究是否可使用這些文件的最新版本。凡是不注日期的引用文件，其最新版本適用于本文件。3術(shù)語與定義T/BIAIMXXXX-2024界定的以及下列術(shù)語與定義適用于本文件。4縮略語JSON：JS對象簡譜（JavaScriptObjectNotation）REST：表達性狀態(tài)轉(zhuǎn)移（RepresentationalStateTransfer）5接口要求5.1接口基本要求復雜施工環(huán)境大型地下工程裝備設計制造運維一體化平臺信息接口應滿足以下基本要求：a)網(wǎng)絡要求：確保集成系統(tǒng)間網(wǎng)絡通暢、穩(wěn)定、安全；b)數(shù)據(jù)安全要求：確保系統(tǒng)集成過程中具備完善的權(quán)限驗證機制；c)通信協(xié)議要求：滿足Rest協(xié)議；d)通信頻率要求：≤1Hz；e)更新頻率：≥5M的數(shù)據(jù)采用增量方式對接，或系統(tǒng)資源利用不高時間段進行更新。5.2接口定義方式5.2.1接口分類復雜環(huán)境大型工程裝備設計制造運維一體化平臺提供的信息接口類型包括但不限于：a)文件接口：基于超文本傳輸協(xié)議(HTTP)或超文本傳輸安全協(xié)議(HTTPS)網(wǎng)絡協(xié)議的網(wǎng)絡服務，以電子文件形式傳輸數(shù)據(jù)；b)API接口：基于HTTP或HTTPS網(wǎng)絡協(xié)議的網(wǎng)絡服務，用于平臺與數(shù)據(jù)提供主體間通過調(diào)用API接口獲取數(shù)據(jù)。5.2.2接口格式描述接口說明包括但不限于：接口功能說明主要包括：——從眾多的系統(tǒng)中提取數(shù)據(jù)到通用數(shù)據(jù)倉庫，供報告、分析或商業(yè)情報之用——將現(xiàn)有系統(tǒng)的數(shù)據(jù)轉(zhuǎn)化或合并為新系統(tǒng)和應用的格式和結(jié)構(gòu)——用軟件即服務(SaaS)應用集成留在公司內(nèi)的數(shù)據(jù)接口地址格式格式：協(xié)議://+域名或者地址+路徑+參數(shù)——目前數(shù)據(jù)集成協(xié)議以Rset協(xié)議接口為主，所以地址中“協(xié)議”用“https”；——地址中“域名或者地址”一般常見的是IP地址或者IP地址+端口號的方式，如涉及到外網(wǎng)數(shù)據(jù)集成訪問會采用外網(wǎng)域名的方式，目前兆豐機電采用IP地址+端口號的方式；——這里地址的路徑指接口對接時數(shù)據(jù)發(fā)布的地址路徑；——這里接口地址中的“參數(shù)”是用于請求數(shù)據(jù)時的“暗號”，需要集成方與被集成方進行約定，或被訪問方進行標準化規(guī)定。示例：HYPERLINKhttps://<域名或地址>/api/hufu-web/restData/lxtest?apiToken=ee116fhttps://<域名或地址>/iuapmdm/cxf/mdmrs/newcenter/queryListMdByMdmCodes請求參數(shù)數(shù)據(jù)接口請求參數(shù)報文應包含，如下內(nèi)容：表1接口請求參數(shù)報文格式參數(shù)名必填描述備注mdmtokenY遠程系統(tǒng)的令牌useridY用戶IDj051hqr3數(shù)據(jù)接口請求參數(shù)正文應包含，如下內(nèi)容：表2接口請求參數(shù)正文格式參數(shù)名類型是否數(shù)組必填備注systemCodestringNY遠程系統(tǒng)編碼gdCodestringNY項目定義編碼codesjsonYY主數(shù)據(jù)編碼(數(shù)組格式)響應數(shù)據(jù)返回類型參數(shù)應包含，如下內(nèi)容：表3接口響應參數(shù)格式參數(shù)名是否數(shù)組必填描述successNY接口訪問狀態(tài)messageNY接口訪問狀態(tài)描述dataYY返回的主數(shù)據(jù)(JSON)示例：請求示例{"systemCode":"default","gdCode":"person","codes":["mdmCode1","mdmCode2","mdmCode3",""]}注：請求參數(shù)正文返回示例{"data":[{"id":"xxx（數(shù)據(jù)在此集成系統(tǒng)的主鍵值）","code":"xxx","name":"xxx","pk_mdm":"xxx（數(shù)據(jù)的主數(shù)據(jù)唯一主鍵）","mdm_code":"xxx（數(shù)據(jù)在模型中的唯一編碼）","mdm_version":"1（數(shù)據(jù)版本。整型）","mdm_duplicate":"0（數(shù)據(jù)重復性，0為無重復。整型）","creator":"admin（數(shù)據(jù)創(chuàng)建人）","createtime":"2022-01-2313:17:26","modifier":"lihua（數(shù)據(jù)修改人）","modifytime":"2022-01-2313:17:26","mdm_datastatus":"3（數(shù)據(jù)狀態(tài)，0:未提交，1:審批中，2:駁回，3:已發(fā)布（已解封），4:封存，5:已提交。整型）","mdm_cleanstatus":"WAITING（數(shù)據(jù)清洗狀態(tài)，WAITING:等待中；RUNNING:清洗中；ERROR:清洗出錯；COMPLETE:清洗結(jié)束；TRANSFER:已轉(zhuǎn)化。）"}]"success":true,"message":"XXX查詢異?！ㄖ挥胁樵兪r響應報文中才會出現(xiàn)此標簽）"}5.3接口數(shù)據(jù)類型復雜環(huán)境大型工程裝備設計制造運維信息接口應覆蓋以下數(shù)據(jù)類型，包括：——字符串型；——整字型；——對象型。6接口定義6.1需求協(xié)同接口6.1.1爬蟲數(shù)據(jù)提交接口爬蟲數(shù)據(jù)提交接口定義見表4：表4爬蟲數(shù)據(jù)提交接口定義接口名稱爬蟲數(shù)據(jù)提交接口接口說明提交工程相關爬蟲數(shù)據(jù)接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、需求ID、爬取到的項目信息(工程名稱、工程行業(yè)、地理位置等)返回值返回應用是否正常運行的狀態(tài)信息6.1.2需求列表查詢接口需求列表查詢接口定義見表5：表5需求列表查詢接口定義接口名稱需求列表查詢接口接口說明根據(jù)賬號ID獲取項目需求信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、需求ID返回值返回應用是否正常運行的狀態(tài)信息和項目需求相關信息，如需求號、項目工號、工程名稱、工程行業(yè)、地理位置、地下工程形式、設備類型、提交時間、優(yōu)化建議等。6.2設計協(xié)同接口6.2.1設計列表查詢接口設計列表查詢接口定義見表6：表6項目詳細需求查詢接口定義接口名稱項目詳細需求查詢接口接口說明根據(jù)賬號ID獲取設計需求信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和設計列表信息，如項目工號、產(chǎn)品名稱、產(chǎn)品型號、最新需求提報時間、最新方案更新時間等。6.2.2項目詳細需求查詢接口項目詳細需求查詢接口定義見表7：表7項目詳細需求查詢接口定義接口名稱項目詳細需求查詢接口接口說明根據(jù)需求ID獲取項目詳細需求信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目需求相關信息，如需求號、項目工號、工程名稱、工程行業(yè)、地理位置、隧道形式、設備類型、提交時間、優(yōu)化建議等。6.2.3項目詳細需求確認提交接口項目詳細需求確認提交接口定義見表8：表8項目詳細需求確認提交接口定義接口名稱項目詳細需求確認提交接口接口說明確認提交項目詳細需求信息接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、設計需求返回值返回應用是否正常運行的狀態(tài)信息6.2.4項目設計結(jié)果查詢接口項目設計結(jié)果查詢接口定義見表9：表9項目設計結(jié)果查詢接口定義接口名稱項目設計結(jié)果查詢接口接口說明根據(jù)項目ID提交設計方案信息進行設計結(jié)果確認接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、需求設計方案返回值應用是否正常運行的狀態(tài)信息6.2.5項目設計結(jié)果確認提交接口項目設計結(jié)果確認提交接口定義見表10：表10項目設計結(jié)果確認提交接口定義接口名稱項目設計結(jié)果確認提交接口接口說明根據(jù)項目ID獲取項目設計結(jié)果信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目設計結(jié)果相關信息，如模塊化配置結(jié)果、定制化設計結(jié)果、三維預覽頁面鏈接等。6.2.6項目設計變更查詢接口項目設計變更查詢接口定義見表11：表11項目設計變更查詢接口定義接口名稱項目設計變更查詢接口接口說明根據(jù)項目ID獲取項目設計變更信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目設計變更相關信息，如裝備設計變更記錄等。6.2.7設計制造協(xié)同接口設計制造協(xié)同接口定義見表12：表12設計制造協(xié)同接口定義接口名稱設計制造協(xié)同接口接口說明根據(jù)一級BOM清單獲取項目工藝信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、一級BOM清單返回值返回應用是否正常運行的狀態(tài)信息和項目制造工藝相關信息，如詳細BOM、設計圖紙和工藝文件等。6.3制造協(xié)同接口6.3.1生產(chǎn)計劃列表查詢接口生產(chǎn)計劃列表查詢接口定義見表13：表13生產(chǎn)計劃列表查詢接口定義接口名稱生產(chǎn)計劃列表查詢接口接口說明根據(jù)賬號ID獲取項目生產(chǎn)計劃信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目生產(chǎn)計劃相關信息，如項目圖紙、物料生產(chǎn)計劃列表（含自制件生產(chǎn)進度信息）等。6.3.2待排批次查詢接口待排批次查詢接口定義見表14：表14待排批次查詢接口定義接口名稱待排批次查詢接口接口說明根據(jù)選中的模型ID獲取待排批次信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、待排模型ID返回值返回應用是否正常運行的狀態(tài)信息和模型待排批次相關信息。6.3.3待排批次確認提交接口待排批次確認提交接口定義見表15：表15待排批次確認提交接口定義接口名稱待排批次確認提交接口接口說明確認提交待排批次信息接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、待排模型ID、帶排批次信息返回值返回應用是否正常運行的狀態(tài)信息6.3.4排程結(jié)果查詢接口排程結(jié)果查詢接口定義見表16：表16排程結(jié)果查詢接口定義接口名稱排程結(jié)果查詢接口接口說明根據(jù)模型ID獲取排產(chǎn)結(jié)果信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、模型ID返回值返回應用是否正常運行的狀態(tài)信息和模型生成的排產(chǎn)結(jié)果相關信息。6.3.5排程結(jié)果確認提交接口排程結(jié)果確認提交接口定義見表17：表17排程結(jié)果確認提交接口定義接口名稱排程結(jié)果確認提交接口接口說明確認提交排程結(jié)果信息接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、排程結(jié)果返回值返回應用是否正常運行的狀態(tài)信息6.3.6物流列表查詢接口物流列表查詢接口定義見表18：表18物流列表查詢接口定義接口名稱物流列表查詢接口接口說明根據(jù)登錄賬號ID獲取物流列表信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和外協(xié)外購件物流列表6.3.7項目外協(xié)外購件數(shù)量查詢接口項目外協(xié)外購件數(shù)量查詢接口定義見表19：表19項目外協(xié)外購件數(shù)量查詢接口定義接口名稱項目外協(xié)外購件數(shù)量查詢接口接口說明根據(jù)項目ID獲取外協(xié)外購件數(shù)量信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目外協(xié)件和外購件數(shù)量信息6.3.8項目外協(xié)外購件清單內(nèi)容查詢接口項目外協(xié)外購件清單內(nèi)容查詢接口定義見表20：表20項目外協(xié)外購件清單內(nèi)容查詢接口定義接口名稱項目外協(xié)外購件清單內(nèi)容查詢接口接口說明根據(jù)項目ID獲取外協(xié)外購件清單信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目外協(xié)外購件清單6.3.9項目外協(xié)外購信息查詢接口項目外協(xié)外購信息查詢接口定義見表21：表21項目外協(xié)外購信息查詢接口定義接口名稱項目外協(xié)外購信息查詢接口接口說明根據(jù)項目ID獲取外協(xié)外購相關技術(shù)信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目所有外協(xié)外購件的技術(shù)信息、供應鏈資源協(xié)同、進度協(xié)同信息等6.4運維協(xié)同接口6.4.1運維需求提報接口運維需求提報接口定義見表22：表22運維需求提報接口定義接口名稱運維需求提報接口接口說明確認運維需求相關信息接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、服務請求編號、現(xiàn)場聯(lián)系人、聯(lián)系電話、服務地點、區(qū)域、信息來源返回值返回應用是否正常運行的狀態(tài)信息6.4.2項目需求內(nèi)容查詢接口項目需求內(nèi)容查詢接口定義見表23：表23項目需求內(nèi)容查詢接口定義接口名稱項目需求內(nèi)容查詢接口接口說明根據(jù)項目ID獲取運維需求內(nèi)容信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目下的所有人員或備件需求內(nèi)容，含響應情況6.4.3項目及設備信息查詢接口項目及設備信息查詢接口定義見表24：表24項目及設備信息查詢接口定義接口名稱項目及設備信息查詢接口接口說明根據(jù)項目ID獲取項目及設備相關信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目及設備相關信息，包括項目背景、工程進度、裝備實時參數(shù)等信息。6.4.4實時數(shù)據(jù)加載接口實時數(shù)據(jù)加載接口定義見表25：表25實時數(shù)據(jù)加載接口定義接口名稱實時數(shù)據(jù)加載接口接口說明根據(jù)項目ID獲取實時運行信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）返回值返回應用是否正常運行的狀態(tài)信息和項目獲取的實時運行參數(shù)和監(jiān)測結(jié)果等6.4.5異常工況事件查詢接口異常工況事件查詢接口定義見表26：表26異常工況事件查詢接口定義接口名稱異常工況事件查詢接口接口說明根據(jù)異常工況ID獲取該工況詳細信息接口方法GET參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、異常工況ID返回值返回應用是否正常運行的狀態(tài)信息和項目異常工況的詳細信息，包括異常工況名稱、關聯(lián)數(shù)據(jù)、判斷時間等6.4.6異常工況確認接口異常工況確認接口定義見表27：表27異常工況確認接口定義接口名稱異常工況確認接口接口說明確認異常工況事件相關信息接口方法POST參數(shù)說明至少包括：系統(tǒng)ID(systemCode)、項目ID（gdCode）、異常工況事件ID、判斷時間、核查結(jié)果、原因分析、優(yōu)化建議等返回值返回應用是否正常運行的狀態(tài)信息7接口安全7.1結(jié)構(gòu)安全結(jié)構(gòu)安全要求包括：應根據(jù)各用戶的工作重要性、權(quán)限、職能等因素，開放不同的功能權(quán)限。7.2訪問控制訪問控制要求包括：a)應具備針對未授權(quán)訪問的識別和阻斷能力，實現(xiàn)基于如訪問時間、次數(shù)、用戶IP等要素的API訪問控制；b)宜通過ACL、RBAC等技術(shù)，