1. 获取模型所有族的属性及包含的构件列表
获取模型所有构件的族类型及属性。
请求方式:GET
请求地址:/api/{databaseKey}/models/families/attributes/list?modelKey={modelKey}&share={share}
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
modelKey | string | NULL | 是 | 模型key |
share | string | NULL | 否 | 分享key 可不指定 |
Body
application/json:
NULL
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
无参数 | NULL | NULL | NULL | NULL |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data":
[
{
"components": [
"M1614235203147_265142"
],
"标识数据familyName": "桁架-自由", // 族名称
"familySymbol": "B80" // 族类型
"familyAttribute": { // 族类型属性
"机械": {
"分类": "无"
}
"OmniClass 编号": "null",
"类型图像": "<无>",
"URL": "null",
"成本": "0.00"
}
}
]
}
1.4. 错误返回
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | BAD_PARAMETER_VALUE | 参数(modelKey)不能为空 | NULL | 参数modelKey为空 |
1.5. 备注
暂无备注
1.6. 注意事项
- 只返回存在族类型的构件
- 数据库启用gacl时,有模型关联的BOSF文档读取权限的用户
- 数据库未启用gacl时,有数据库访问权限的用户