C#開發BIMFACE系列23 服務端API之獲取模型數據8：獲取模型鏈接信息
- 2019 年 10 月 5 日
- 筆記
系列目錄 【已更新最新開發文章，點擊查看詳細】
在Revit等BIM設計工具中可以給模型的某個部位添加鏈接信息。即類似於在Office Word、Excel 中給一段文字添加本地文件鏈接或者網址鏈接等類似功能。例如下面的一個RVT模型種包含了2個鏈接。
下面詳細介紹如何獲取單個模型包含的所有鏈接信息。
請求地址：GET https://api.bimface.com/data/v2/files/{fileId}/links
說明：獲取一個模型種包含的所有鏈接信息
參數：
請求 path(示例)：https://api.bimface.com/data/v2/files/1211223382064960/links
請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP響應示例(200)：
{ "code" : "success", "data" : [ { "guid" : "ffb665b7-067f-4cd6-b080-214e96db0f73-00058185", "id" : 0, "name" : "file_link.rvt : 12 : loc <not shared>", "transform" : "" } ], "message" : "" }
返回的結果封裝成 SingleModelLink 類
/// <summary> /// 獲取單個模型的鏈接信息返回的結果類 /// </summary> [Serializable] public class SingleModelLink : GeneralResponse<List<Link>> { }
[Serializable] public class Link { [JsonProperty("guid")] public string Guid { get; set; } [JsonProperty("id")] public long? Id { get; set; } /// <summary> /// 樣例 : "file_link.rvt : 12 /// </summary> [JsonProperty("name")] public string Name { get; set; } [JsonProperty("transform")] public string Transform { get; set; } /// <summary>返回表示當前對象的字符串。</summary> /// <returns>表示當前對象的字符串。</returns> public override string ToString() { return String.Format("[Link guid={0}, id={1}, name={2},transform={3}]", Guid, Id, Name, Transform); } }
C#實現方法：
1 /// <summary> 2 /// 獲取單個模型的樓層信息 3 /// </summary> 4 /// <param name="accessToken">【必填】令牌</param> 5 /// <param name="fileId">【必填】代表該單模型的文件ID</param> 6 /// <returns></returns> 7 public virtual SingleModelLink GetSingleModelLink(string accessToken, long fileId) 8 { 9 // GET https://api.bimface.com/data/v2/files/{fileId}/links 10 string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/links", fileId); 11 12 BimFaceHttpHeaders headers = new BimFaceHttpHeaders(); 13 headers.AddOAuth2Header(accessToken); 14 15 try 16 { 17 SingleModelLink response; 18 19 HttpManager httpManager = new HttpManager(headers); 20 HttpResult httpResult = httpManager.Get(url); 21 if (httpResult.Status == HttpResult.STATUS_SUCCESS) 22 { 23 response = httpResult.Text.DeserializeJsonToObject<SingleModelLink>(); 24 } 25 else 26 { 27 response = new SingleModelLink 28 { 29 Message = httpResult.RefText 30 }; 31 } 32 33 return response; 34 } 35 catch (Exception ex) 36 { 37 throw new Exception("[獲取模型鏈接信息]發生異常！", ex); 38 } 39 }
其中調用到的 httpManager.Get() 方法，請參考《C# HTTP系列》
測試
在BIMFACE的控制台中可以看到我們上傳的文件列表，模型狀態均為轉換成功。
以模型 「A4.rvt」 為例測試上述的方法
查詢到了2條鏈接信息，與文章開始處的源文件中的鏈接信息對應。
並不是所有的模型中都包含鏈接信息，如果不包含，則返回 null
測試代碼如下：
1 // 獲取單模型鏈接信息 2 protected void btnGetSingleModelLink_Click(object sender, EventArgs e) 3 { 4 long fileId = txtFileID.Text.Trim().ToLong(); 5 FileConvertApi api = new FileConvertApi(); 6 SingleModelLink response = api.GetSingleModelLink(txtAccessToken.Text, fileId); 7 8 StringBuilder sb = new StringBuilder(); 9 if (response.Data != null) 10 { 11 List<Link> lstLink = response.Data; 12 foreach (var link in lstLink) 13 { 14 sb.AppendLine(link.ToString()); 15 } 16 } 17 18 txtResult.Text = response.Code.ToString2() 19 + Environment.NewLine 20 + response.Message.ToString2() 21 + Environment.NewLine 22 + sb; 23 }
系列目錄 【已更新最新開發文章，點擊查看詳細】
