1. 查询模型的族属性
获取模型中指定族类型的属性。
请求方式:GET
请求地址:/api/{databaseKey}/models/families/attributes?modelKey={modelKey}&share={share}&familyName={familyName}&familySymbol={familySymbol}
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
modelKey | string | NULL | 是 | 模型key |
familyName | string | NULL | 是 | 族名称 |
familySymbol | string | NULL | 是 | 族类型名称 |
share | string | NULL | 否 | 分享key 可不指定 |
Body:
NULL
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"机械": {
"分类": "无"
},
"文字": {
"族版本号": "2020.0615.1432"
},
"标识数据": {
"OmniClass 编号": "null",
"型号": "null",
"类型图像": "<无>",
"成本": "0.00"
}
}
}
1.4. 错误返回
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | BAD_PARAMETER | 指定族类型和族名称的构件不存在! | NULL | 不存在满足指定族信息的构件 |
1.5. 备注
暂无备注
1.6. 注意事项
1、数据库启用gacl时,有模型关联的BOSF文档读取权限的用户。
2、数据库未启用gacl时,有数据库访问权限的用户。
1.7. 逻辑要点
- 族名称和族类型必须同时满足条件时才返回