C#开发BIMFACE系列20 服务端API之获取模型数据5：批量获取构件属性
在《C#开发BIMFACE系列18 服务端API之获取模型数据3：获取构件属性》中介绍了获取单个文件/模型的单个构建的属性，本篇介绍如何一次性获取多个构建的属性。
请求地址：POST https://api.bimface.com/data/v2/files/{fileId}/elements
说明：支持查询模型属性重写后多个构件的属性，需要设置请求参数includeOverrides的值为true
参数：
其中 ElementPropertyFilterRequest 类如下：
/// <summary>
/// 批量获取构件属性的请求参数
/// </summary>
[Serializable]
public class ElementPropertyFilterRequest
{
/// <summary>
/// 【必填】构建ID数组。例如： [ "313154", "313047" ]
/// </summary>
[JsonProperty("elementIds")]
public string[] ElementIds { get; set; } /// <summary>
/// 【非必填】过来条件
/// </summary>
[JsonProperty("filter", NullValueHandling = NullValueHandling.Ignore)]
public GroupAndKeysPair[] Filters { get; set; }
}
[Serializable]
public class GroupAndKeysPair
{
/// <summary>
/// 分组名称。例如：default、shape、size
/// </summary>
[JsonProperty("group")]
public string Group { get; set; } /// <summary>
/// 关键字数组。例如： [ "length", "width", "a" ]
/// </summary>
[JsonProperty("keys", NullValueHandling = NullValueHandling.Ignore)]
public string[] Keys { get; set; }
}
请求 path(示例)：https://api.bimface.com/data/v2/files/1211223382064960/elements
若需查询重写后的构件属性，请求示例为
https://api.bimface.com/data/v2/files/1211223382064960/elements?includeOverrides=true
请求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body(示例)：
{
"elementIds" : [ "", "" ],
"filter" : [ {
"group" : "default"
}, {
"group" : "shape"
}, {
"group" : "size",
"keys" : [ "length", "width", "a" ]
} ]
}
HTTP响应示例(200)：
{
"code" : "success",
"data" : [ {
"boundingBox" : {
"max" : {
"x" : -4938.068482562385,
"y" : -3201.59397858169,
"z" : 0.0
},
"min" : {
"x" : -4938.068482562385,
"y" : -3201.59397858169,
"z" : 0.0
}
},
"elementId" : "",
"familyGuid" : "",
"guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
"name" : "norm - 150mm",
"properties" : [ {
"group" : "dimension",
"items" : [ {
"code" : "perimeter",
"extension" : "object",
"key" : "perimeter",
"orderNumber" : ,
"unit" : "mm",
"value" : ,
"valueType" :
} ]
} ]
} ],
"message" : ""
}
该返回结果中的data部分是一个数组，对应多个构建的属性。与《C#开发BIMFACE系列18 服务端API之获取模型数据3：获取构件属性》中返回的结果相同。
C#实现方法：
/// <summary>
/// 批量获取单个模型的多个构件属性
/// </summary>
/// <param name="accessToken">令牌</param>
/// <param name="fileId">【必填】代表该单模型的文件ID</param>
/// <param name="request">【必填】请求过滤参数</param>
/// <param name="includeOverrides">【非必填】是否查询修改的属性</param>
/// <returns></returns>
public virtual SingleModelMultipleElementsProperties GetSingleModelMultipleElementsProperties(string accessToken, long fileId, ElementPropertyFilterRequest request, bool? includeOverrides = null)
{
if (request == null)
{
throw new ArgumentException("参数 request 不能为null ！");
} // POST https://api.bimface.com/data/v2/files/{fileId}/elements
string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/elements", fileId);
if (includeOverrides != null)
{
url = url + "?includeOverrides=" + includeOverrides;
} string data = request.SerializeToJson(); BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
headers.AddOAuth2Header(accessToken); try
{
SingleModelMultipleElementsProperties response; HttpManager httpManager = new HttpManager(headers);
HttpResult httpResult = httpManager.Post(url, data);
if (httpResult.Status == HttpResult.STATUS_SUCCESS)
{
response = httpResult.Text.DeserializeJsonToObject<SingleModelMultipleElementsProperties>();
}
else
{
response = new SingleModelMultipleElementsProperties
{
Message = httpResult.RefText
};
} return response;
}
catch (Exception ex)
{
throw new Exception("[批量获取构件属性]发生异常！", ex);
}
}
其中调用到的 httpManager.Post() 方法，请参考《C# HTTP系列》
其中返回结果类 SingleModelMultipleElementsProperties 定义如下：
/// <summary>
/// 批量获取单个模型的多个构件属性返回的结果类
/// </summary>
[Serializable]
public class SingleModelMultipleElementsProperties : GeneralResponse<List<SingleModelSingleElementEntity>>
{ }
在BIMFACE的控制台中可以看到我们上传的文件列表，共计2个文件。模型状态均为转换成功。
以“01_BIMFACE示例文件-Revit模型.rvt”为例来测试。
其中使用了 300067,282979 这2个构建ID。查询的构建属性完整结果如下：
success
elementId:, SingleModelSingleElementEntity：
[boundingBox=[max=[x=5838.783, y=4387.716, z=],
min=[x=5788.783, y=4237.716, z=]
],
elementId=,
familyGuid=2d99307a-66cd--b173-5c88d252416e-,
Guid=89c90034-40ae-423a--8f5624db86c1-，
name= x mm,
Properties=[group=基本属性,
items= [code=, extension=, key=specialty, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=floor, orderNumber=,unit=,value=F2,valueType=]
[code=, extension=, key=categoryId, orderNumber=,unit=,value=-,valueType=]
[code=, extension=, key=categoryName, orderNumber=,unit=,value=幕墙竖梃,valueType=]
[code=, extension=, key=family, orderNumber=,unit=,value=矩形竖梃,valueType=]
[code=, extension=, key=familyId, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=familyType, orderNumber=,unit=,value= x mm,valueType=]
[code=, extension=, key=familyTypeId, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=systemType, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=building, orderNumber=,unit=,value=,valueType=]
]
[group=尺寸标注,
items=[code=, extension=, key=边 上的宽度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=边 上的宽度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=长度, orderNumber=,unit=mm,value=,valueType=]
]
[group=材质和装饰,
items=[code=, extension=, key=材质, orderNumber=,unit=,value=金属 - 铝,valueType=]
]
[group=构造,
items=[code=, extension=, key=位置, orderNumber=,unit=,value=垂直于面,valueType=]
[code=, extension=, key=厚度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=角竖梃, orderNumber=,unit=,value=False,valueType=]
[code=, extension=, key=轮廓, orderNumber=,unit=,value=默认,valueType=]
]
[group=标识数据,
items=[code=, extension=, key=OmniClass 标题, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=OmniClass 编号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=URL, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=代码名称, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=制造商, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=图像, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=型号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=成本, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=标记, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=注释, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=注释记号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型图像, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型标记, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型注释, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=说明, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=部件代码, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=部件说明, orderNumber=,unit=,value=,valueType=]
]
[group=阶段化,
items=[code=, extension=, key=创建的阶段, orderNumber=,unit=,value=新构造,valueType=]
[code=, extension=, key=拆除的阶段, orderNumber=,unit=,value=无,valueType=]
]
[group=限制条件,
items=[code=, extension=, key=偏移量, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=角度, orderNumber=,unit=°,value=0.00,valueType=]
]
] SingleModelSingleElementEntity：
[boundingBox=[max=[x=-2066.217, y=-7714.284, z=],
min=[x=-2116.217, y=-7864.284, z=]
],
elementId=,
familyGuid=2d99307a-66cd--b173-5c88d252416e-,
Guid=0438595c-b6fe-4e10-9b43-4c629826282c-，
name= x mm,
Properties=[group=基本属性,
items=[code=, extension=, key=specialty, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=floor, orderNumber=,unit=,value=地坪,valueType=]
[code=, extension=, key=categoryId, orderNumber=,unit=,value=-,valueType=]
[code=, extension=, key=categoryName, orderNumber=,unit=,value=幕墙竖梃,valueType=]
[code=, extension=, key=family, orderNumber=,unit=,value=矩形竖梃,valueType=]
[code=, extension=, key=familyId, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=familyType, orderNumber=,unit=,value= x mm,valueType=]
[code=, extension=, key=familyTypeId, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=systemType, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=building, orderNumber=,unit=,value=,valueType=]
]
[group=尺寸标注,
items=[code=, extension=, key=边 上的宽度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=边 上的宽度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=长度, orderNumber=,unit=mm,value=,valueType=]
]
[group=材质和装饰,
items=[code=, extension=, key=材质, orderNumber=,unit=,value=金属 - 铝,valueType=]
]
[group=构造,
items=[code=, extension=, key=位置, orderNumber=,unit=,value=垂直于面,valueType=]
[code=, extension=, key=厚度, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=角竖梃, orderNumber=,unit=,value=False,valueType=]
[code=, extension=, key=轮廓, orderNumber=,unit=,value=默认,valueType=]
]
[group=标识数据,
items=[code=, extension=, key=OmniClass 标题, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=OmniClass 编号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=URL, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=代码名称, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=制造商, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=图像, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=型号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=成本, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=标记, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=注释, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=注释记号, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型图像, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型标记, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=类型注释, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=说明, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=部件代码, orderNumber=,unit=,value=,valueType=]
[code=, extension=, key=部件说明, orderNumber=,unit=,value=,valueType=]
]
[group=阶段化,
items=[code=, extension=, key=创建的阶段, orderNumber=,unit=,value=新构造,valueType=]
[code=, extension=, key=拆除的阶段, orderNumber=,unit=,value=无,valueType=]
]
[group=限制条件,
items=[code=, extension=, key=偏移量, orderNumber=,unit=mm,value=,valueType=]
[code=, extension=, key=角度, orderNumber=,unit=°,value=0.00,valueType=]
]
]
测试代码如下：
// 批量获取构件属性
protected void btnGetSingleModelMultipleElementsProperties_Click(object sender, EventArgs e)
{
string[] elementIds = txtMultipleElementIds.Text.Split(","); ElementPropertyFilterRequest request = new ElementPropertyFilterRequest();
request.ElementIds = elementIds; FileConvertApi api = new FileConvertApi();
var response = api.GetSingleModelMultipleElementsProperties(txtAccessToken.Text, txtFileID.Text.ToLong(), request, chkIncludeOverrides.Checked); StringBuilder sb = new StringBuilder();
List<SingleModelSingleElementEntity> lstProperties = response.Data;
foreach (var property in lstProperties)
{
sb.AppendLine(property.ToString());
}
txtResult.Text = response.Code.ToString2()
+ Environment.NewLine
+ "elementId:" + txtMultipleElementIds.Text
+ Environment.NewLine
+ response.Message.ToString2()
+ Environment.NewLine
+ sb;
}
C#开发BIMFACE系列20 服务端API之获取模型数据5：批量获取构件属性的更多相关文章
- C#开发BIMFACE系列45 服务端API之创建离线数据包
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] BIMFACE的常规应用方式有公有云与私有化部署两种方式,并且浏览模型或者图纸需要使用ViewToken,ViewToke ...
- C#开发BIMFACE系列46 服务端API之离线数据包下载及结构详解
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在前一篇博客<C#开发BIMFACE系列45 服务端API之创建离线数据包>中通过调用接口成功的创建一个离线数 ...
- C#开发BIMFACE系列40 服务端API之模型集成
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 随着建筑信息化模型技术的发展,越来越多的人选择在云端浏览建筑模型.现阶段的云端模型浏览大多是基于文件级别,一次只可以浏览一 ...
- C#开发BIMFACE系列41 服务端API之模型对比
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在建筑施工图审查系统中,设计单位提交设计完成的模型/图纸,审查专家审查模型/图纸.审查过程中如果发现不符合规范的地方,则流 ...
- C#开发BIMFACE系列42 服务端API之图纸对比
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在我的前一篇博客<C#开发BIMFACE系列42 服务端API之图纸对比>中详细介绍了BIMFACE服务端接口 ...
- C#开发BIMFACE系列43 服务端API之图纸拆分
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在上一篇博客<C#开发BIMFACE系列42 服务端API之图纸对比>的最后留了一个问题,在常规业务场景下,一 ...
- C#开发BIMFACE系列44 服务端API之计算图纸对比差异项来源自哪个图框
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在前两篇博客<C#开发BIMFACE系列42 服务端API之图纸对比>.<C#开发BIMFACE系列43 ...
- C#开发BIMFACE系列6 服务端API之获取文件信息
在<C#开发BIMFACE系列4 服务端API之源上传文件>.<C#开发BIMFACE系列5 服务端API之文件直传>两篇文章中详细介绍了如何将本地文件上传到BIMFACE服务 ...
- C#开发BIMFACE系列4 服务端API之源上传文件
在注册成为BIMFACE的应用开发者后,要能在浏览器里浏览你的模型或者获取你模型内的BIM数据, 首先需要把你的模型文件上传到BIMFACE.根据不同场景,BIMFACE提供了丰富的文件相关的接口. ...
随机推荐
- 理解ES6的新数据类型：Symbol
ES6之前的数组类型 在ES6之前JS只有6种数据类型,分别是:Undefined.Null.布尔值(Boolean).字符串(String).数值(Number).对象(Object). ES6引入 ...
- python科学计算和数据分析常用库
NumPy NumPy最强大的是n维数组,该库还包含基本的线性代数函数.傅立叶变换.随机函数和其他底层语言(如Fortran.C和C++)集成的工具. SciPy SciPy建立在NumPy基础上,它 ...
- 【西北师大-2108Java】第十次作业成绩汇总
[西北师大-2108Java]第十次作业成绩汇总 作业题目 面向对象程序设计(JAVA) 第12周学习指导及要求 实验目的与要求 (1)掌握Vetor.Stack.Hashtable三个类的用途及常用 ...
- CSV和JSON格式相互转换
1.为什么要进行CSV与JSON格式之间的转换 CSV格式常用于一二维数据表示和存储,他是一种纯文本形式存储表格数据的表示方式.JSON也可以表示一二维数据.在网络信息传输中,可能需要统一表示方式,因 ...
- Vue父子组件数据双向绑定，子组件可修改props
第一种,子组件通过监听父组件数据,子组件改变数据之后通知给父组件 原文链接:https://blog.csdn.net/m0_37728716/article/details/81776929 父组件 ...
- 请求时发送OPTIONS请求
最近在用uni-app开发项目时,发现一个之前没注意到的点,当我发送POST请求的时候,在NetWork可以看到在发送正式的POST请求时,会先发送一个OPTIONS请求,OPTIONS请求后才会发送 ...
- 每日一题LeetCode 8. 字符串转换整数 (atoi)
问题描述 请你来实现一个 atoi 函数,使其能将字符串转换成整数. 首先,该函数会根据需要丢弃无用的开头空格字符,直到寻找到第一个非空格的字符为止. 当我们寻找到的第一个非空字符为正或者负号时,则将 ...
- Response to 16岁的篮球投手
关于篮球,我想写的很多,被偏爱的运动,被赞美的运动,带着青春的万丈光泽. 我们对易建联的苛刻是因为想当然,对大侄子的溺爱是因为急功近利.过于娱乐化和商业化,让一项竞技体育变得像是豆瓣八组的吃瓜盛宴. ...
- C# params 用法
params 主要用在方法或函数参数数组中, 1,当参数个数不确定时使用 2,不能盒ref,和out组合使用 3,与参数数组对应的实参可以时一个 同类型数组,也可以时任意多个同类型变量 4,实参是数组 ...
- GO-逻辑判断(if,else if,else,switch)
一.if逻辑判断 package main import "fmt" func main() { var a =10; if a>10 { //大括号前不能回车 fmt.Pr ...