1. 获取模型所有构件的特定属性
获取模型所有构件的key和编码、分类等属性。
请求方式:GET
请求地址:/api/{databaseKey}/components/attributes?modelKey={modelKey}&attributes={attribute1,attribute2...}&
pageNumber={pageNumber}&pageSize={pageSize}&share={share}
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
modelKey | string | NULL | 是 | 模型key |
attributes | string | NULL | 是 | 属性字段列表,如type,attribute.标高 |
pageNumber | int | NULL | 是 | 分页返回的页码,从0开始 |
pageSize | int | NULL | 是 | 分页返回每页最大条目,取值100~10000 |
share | string | NULL | 否 | 分享key |
Body
application/json:
NULL
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"content": [
{
"type": "常规模型",
"标高": null,
"key": "XXX"
},
...
{
"type": "常规模型",
"标高": null,
"key": "XXX"
}
],
"totalElements": 521, //总数量
"totalPages": 6, //总页数
"last": false, //是否最后一页
"number": 0, //当前页码
"size": 100, //每页最大数量
"first": true, //是否第一页
"numberOfElements": 100 //本页数量
}
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.5. 备注
暂无备注
1.6. 注意事项
1、attributes:返回的属性列表,属性之间用英文符号逗号(,)连接。
2、attributes中的属性可以是构件基础属性(如type),也可以是构件attribute属性中的某个子属性(如attribute.标高),属性与子属性用英文符号点(.)连接,返回值中属性名称为attribute中最后一个子属性名称。
3、pageNumber:分页返回结合的当前页,从0开始。
4、pageSize:每页最大数据量,取值范围在100~10000之间。