復(fù)雜施工環(huán)境大型地下工程裝備設(shè)計(jì)制造運(yùn)維信息接口要求-征求意見稿

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