重慶市BIM項目管理平臺對接流程及接口標(biāo)準(zhǔn)

-1-重慶市BIM項目管理平臺對接流程及接口標(biāo)準(zhǔn)參數(shù)名定義說明HOSTURL接口地址BIM接口地址1.獲取Token認(rèn)證接口規(guī)范接口地址/token接口說明通過用戶名、密碼獲取BIM施工應(yīng)用接口的統(tǒng)一身份授權(quán)認(rèn)證參數(shù)格式application/x-www-form-urlencoded請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明usernamevarchar是下發(fā)帳號passwordvarchar是下發(fā)密碼返回結(jié)果示例{"access_token":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjQzQkVDNUZDOEJFNEVEMTI1M0EwQUFFOTU4MjY5Rjc5QjQ3MzdBMjMiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJRNzdGX0l2azdSSlRvS3JwV0NhZmViUnplaU0ifQ.eyJuYmYiOjE1OTc5OTIxMzAsImV4cCI6MTU5Nzk5NTczMCwiaXNzIjoiaHR0cHM6Ly9pZC5zcGRzcGQuY29tIiwiYXVkIjpbImh0dHBzOi8vaWQuc3Bkc3BkLmNvbS9yZXNvdXJjZXMiLCJGaWxlU2VydmVyIiwiaWRlbnRpdHkiLCJKd0ZpbGVMaWJyYXJ5IiwiTVBQIl0sImNsaWVudF9pZCI6IlRlc3RKd0ZpbGUiLCJzdWIiOiI3ZTg3YjJhMC0wZTY1LTRiNmMtYTk0My0xYTc5MTUwOTNhOGQiLCJhdXRoX3RpbWUiOjE1OTc5OTIxMzAsImlkcCI6ImxvY2FsIiwibmFtZSI6IlNQRENJIiwicGhvbmVfbnVtYmVyIjoiMTg4ODg4ODg4ODgiLCJyb2xlIjoiQ3VzdG9tZXIiLCJzY29wZSI6WyJvcGVuaWQiLCJwcm9maWxlIiwiRmlsZVNlcnZlciIsImlkZW50aXR5IiwiSndGaWxlTGlicmFyeSIsIk1QUCJdLCJhbXIiOlsicHdkIl19.1F-tKl-gJLnsFEpdEcGJngNeO3D9E0t5AEKwvVA-D4jIETFBxDa3A3mQMGfX34bd2LKdh_xy9PgAgAVW5SLfzmzBWUZ9xJGGrMZ6DcPjKJBhhccLFGSd1OSQtVKk31uZgeTlMejsXR7P1ukQ9q3wihjFi0VPSqcUyrO_Jox890zm0ai4cmUWPATKxhPDuBBnkNkMpqUhYC0GPfMgmbSxz68FWThv94KjXOrr7Lamug0CLwf9bHiiJJzPOUoDg3Sm3UjXZHHBxF-TaroiSX3aoqdxV0hiYswmhHu_ONbmu3BOISEtJQ0UcwQgxCLxGtqFTOpugROxjkO3QMv52Q5C1g","expires_in":3600,"token_type":"Bearer","scope":"FileServeridentityJwFileLibraryMPPopenidprofile"}2.查詢模型文件上傳狀態(tài)接口規(guī)范接口地址{HOSTURL}/api/v1/FlowJs/UploadFileStatus接口說明查詢文件的上傳狀態(tài)參數(shù)格式…/UploadFileStatus?hash=43263f40d02aaa2c4b82d8d5c786df88&totalChunks=-1請求方法getHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明hashvarchar是文件hashtotalChunksvarchar是-1返回結(jié)果示例{"item":{"hash":"43263f40d02aaa2c4b82d8d5c786df88","status":2,"file":{"id":"45965c2e-3cd3-4c6d-9183-ea779066b33b","name":"sendorder_202008192259324212.pdf","path":"db876c2a-fb71-45df-a1e3-022eb52d8257/00000000-0000-0000-0000-000000000000/43263f40d02aaa2c4b82d8d5c786df88.pdf","createdUserId":"db876c2a-fb71-45df-a1e3-022eb52d8257","hash":"43263f40d02aaa2c4b82d8d5c786df88","createdUserName":"小蛛","type":".pdf","size":29531,"createdAt":"2020-08-19T14:59:57.168Z","url":"/db876c2a-fb71-45df-a1e3-022eb52d8257/00000000-0000-0000-0000-000000000000/43263f40d02aaa2c4b82d8d5c786df88.pdf","tags":["System.String[]"]},"unUploadChunks":null},"success":true,"code":200}3.模型文件上傳接口規(guī)范接口地址{HOSTURL}/api/v1/FlowJs/Upload接口說明文件上傳,支持?jǐn)帱c(diǎn)續(xù)傳，切片上傳參數(shù)格式content-type:multipart/form請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明fileNamestring是-1文件名fileExtentionstring是-1文件類型fileHashstring是-1文件Hash加密值fileSizeInt是32文件大小totalChunksInt是32切片總數(shù)chunkNumberInt是32當(dāng)前上傳切片序號currentChunkSizeInt是32當(dāng)前切片大小tagsString[]是0[]返回結(jié)果示例{

"item":{

"id":"a4ab927f-4f10-4921-8333-6836c7e207f9",

"name":"1.rvt",

"path":"c43e4b52-f152/.../4917c47c8614ceec7cacddc7e408604f.rvt",

"createdUserId":"c43e4b52-f152-4b16-a1e8-880fb1af165e",

"hash":"4917c47c8614ceec7cacddc7e408604f",

"createdUserName":"筑業(yè)",

"type":".rvt",

"size":5918720,

"createdAt":"2019-11-13T09:38:20.1641803+08:00",

"url":":6010/c43e4b52/.../4917c47c8614ceec7cacddc7e408604f.rvt",

"tags":[

"110101",

"ARCHIVAL_PHASE",

"BUILDING"

]

},

"success":true,

"code":200}補(bǔ)充說明如果在查詢上傳狀態(tài)時出現(xiàn)返回status=1，unUploadChunks數(shù)組為空的狀況，說明文件切塊已經(jīng)全部上傳完畢，但是文件卻沒有完成合并,這時無需切塊，直接將ChunkNumber=-1，CurrentChunkSize=0，后調(diào)用此接口，后臺會判斷這個參數(shù)，并將其合并模型文件同步接口規(guī)范接口地址{HOSTURL}/api/v1/FlowJs/Synchronous接口說明當(dāng)文件上傳轉(zhuǎn)臺status!=2時，調(diào)用此接口完成文件同步參數(shù)格式content-type:application/x-www-form-urlencoded請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明hashstring是-1文件Hash加密值返回結(jié)果示例{

"item":{

"hash":"baf118c5a2b52c045917ba26a362bdfa",

"status":2,

"file":{

"id":"d4e486a1-305d-4268-bc3e-0171f1f911ea",

"name":"9.rvt",

"path":"afae5063-daee-4bb0-b67e-325f65767f1c/3.../baf118c5a2b52c045917ba26a362bdfa.rvt",

"createdUserId":"afae5063-daee-4bb0-b67e-325f65767f1c",

"hash":"baf118c5a2b52c045917ba26a362bdfa",

"createdUserName":"訪客",

"type":".rvt",

"size":5943296,

"createdAt":"2019-06-18T18:15:45",

"url":":6010/afae5063-da/.../baf118c5a2b52c045917ba26a362bdfa.rvt",

"tags":null

},

"unUploadChunks":null

},

"success":true,

"code":200}模型轉(zhuǎn)換接口規(guī)范接口地址{HOSTURL}/api/v1/FileConvert/convert-model接口說明當(dāng)模型文件上傳完成，請求轉(zhuǎn)換接口完成輕量化參數(shù)格式content-type:application/json請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明modelGroupIdguid是鏈接模型組標(biāo)識IDfileList[]是轉(zhuǎn)換的文件集合返回結(jié)果示例{

"item":{

"id":"7ded18cb-155b-47ec-b077-2a34dca59dd6",

"projectId":"bd414a32-cb14-407c-8833-47915d5",//模型組ID(ModelGroupId)

"taskId":"78842c39-d40f-4592-9fbe-4502f72caa19",//任務(wù)Id

"modelList":[

{

"id":"00000000-0000-0000-0000-000000000000",

"modelGroupId":null,

"taskId":null,

"modelId":0,

"modelName":"revit模型（場地建筑）.rvt",

"modelPath":null,

"hash":"9ed4dae5136b19f5b73a6b895fce3cc5",

"percent":0,

//文件轉(zhuǎn)換進(jìn)度

"errorMessage":""

//錯誤信息

}

],

"taskState":{

"found":true,//文件是否存在

"done":false,//轉(zhuǎn)換是否完成

"successed":true,//任務(wù)是否成功執(zhí)行

"message":"開始轉(zhuǎn)換模型!"

},

"createdAt":"2019-11-13T08:58:18.2403385+08:00"

},

"success":true,

"code":200}補(bǔ)充說明參數(shù)說明：fileList：

[

{"id":"e7288b23-8e54...",

"Name":"revit模型.rvt",

"Type":".rvt",

"Size":10080256,

"Hash":"9ed4dae5136b19f5b73...",

"Path":"c43e4b52-...e3cc5.rvt",

"Tags":[

"500103",

"ARCHIVAL_PHASE",

"BUILDING"

]}

]模型轉(zhuǎn)換狀態(tài)查詢接口規(guī)范接口地址{HOSTURL}/api/v1/FileConvert/convert-process接口說明當(dāng)模型文件發(fā)起轉(zhuǎn)換成功后，請求該接口查詢轉(zhuǎn)換狀態(tài)參數(shù)格式convert-process?modelGroupId=b557f392-7631-4946-ba59-2c1d969bce5c&taskId=cc4044bc-be1d-40bc-82db-f47681828785請求方法getHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明modelGroupIdguid是鏈接模型組標(biāo)識IDtaskIdguid是轉(zhuǎn)換標(biāo)識返回結(jié)果示例{"item":{"id":"839f145d-7de5-4d8d-9236-706e84c3d07c","projectId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelList":[{"id":"2fc38fc9-2a58-451f-b662-afbfd1f55859","modelGroupId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelId":0,"modelName":"重慶建工職學(xué)院-建筑建模.RVT","modelPath":null,"hash":"c013c7379021cd809c2fa1c277b68e99","percent":0,"errorMessage":"ParseModelError"},{"id":"c574b626-cef7-49bc-886e-447b75ec220f","modelGroupId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelId":0,"modelName":"木洞風(fēng)貌改造施工圖設(shè)計_3#_土建.RVT","modelPath":null,"hash":"3e2c9d40b449321c7f76663a452cdbcd","percent":0,"errorMessage":"ParseModelError"}],"taskState":{"found":true,"done":true,"successed":true,"message":""},"createdAt":"2020-08-27T12:11:52.0687634+08:00"},"success":true,"code":200}補(bǔ)充說明創(chuàng)建項目信息記錄接口規(guī)范接口地址{HOSTURL}/bim/api/v2/project/create接口說明創(chuàng)建項目參數(shù)格式j(luò)son請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…bimapikeystring是bim對接密鑰參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明idguid是項目標(biāo)識guidcodestring是項目編號namestring是項目名稱addressstring否地址gAreaCodestring是區(qū)域編碼(選項)typeInt是項目類型(選項)stageInt是項目階段(選項)rateInt是項目進(jìn)度(選項)statusint是項目狀態(tài)(選項)finishDatedate否工程結(jié)束時間startDatedate否工程開始時間參數(shù)示例{ "Name":"testproject003", "Code":"testproject003", "AreaCode":"500004", "Type":10, "Stage":1}返回結(jié)果示例{"result":"5477a67d-3f95-40a9-8238-20ce55dbebce",//創(chuàng)建成功項目標(biāo)識guid"targetUrl":null,"success":true,"error":null,"unAuthorizedRequest":false,"__abp":true}補(bǔ)充說明(選項)字段數(shù)據(jù)字典可調(diào)用14.12接口進(jìn)行查詢創(chuàng)建項目模型組記錄接口規(guī)范接口地址{HOSTURL}/bim/api/v2/projectGroup/create接口說明創(chuàng)建項目模型組參數(shù)格式j(luò)son請求方法postHeader區(qū)參數(shù)參數(shù)名參數(shù)類型是否必須說明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…bimapikeystring是bim對接密鑰參數(shù)詳情參數(shù)名數(shù)據(jù)格式是否必須 長度說明idguid是ModelGroupIdnamestring是組名稱projectIdstring否所屬項目標(biāo)識IdtaskIdstring是請求轉(zhuǎn)換成功的taskid參數(shù)示例{ "Id":"04c69dbf-e710-4fe3-af8b-a0e4cdadee83", "Name":"測試創(chuàng)建項目場景A", "ProjectId":"9e554c6b-8cb2-4f53-97d0-ddc3acc56ec7", "TaskId":"42862c4e-0f25-4512-9ec8-a45a46248b1a","ParentModelGroupId":"0000-00000-00000-00000-000"http://上級場景標(biāo)識}返回結(jié)果示例{"result":"04c69dbf-e710-4fe3-af8b-a0e4cdadee83",//創(chuàng)建成功后的modelgroupid"targetUrl":null,"success":true,"error":null,"unAuthorizedRequest":false,"__abp":true}補(bǔ)充說明創(chuàng)建項目模型記錄接口規(guī)范接口地址{HOSTURL}/bim/