1. 属性查询构件分页返回构件

根据属性查询构件并分页返回构件信息。


请求方式:POST

请求地址:/api/{databaseKey}/queries/attributes/details?pageNumber={xx}&pageSize={yy}&attributes={zz}&share={share}

1.1. 请求参数

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea 操作的通关令牌

PathParas:

参数名 类型 示例 是否必填 参数含义
databaseKey string test 数据库key,必传

SearchParas:

参数名 类型 示例 是否必填 参数含义
share string NULL 分享key
pageNumber string NULL 分页返回的页码,从0开始
pageSize string NULL 是分页返回每页最大条目,取值1~100
attributes string NULL 是返回属性列表,如不指定则返回全部

Body

application/json:

{
"model": "M34345435352","models":["M34345435352","M34345435353"]
    "condition": [
        {
            "type": "filter",
            "field": "attribute.其他.类别",
            "operator": "==",
            "value": "管\"件"
        },
        {
            "type": "filter",
            "field": "attribute.机械.系统类型",
            "operator": "==",
            "value": "管道系统: 暖通-空冷供水"            
        },
        {
            "type": "or",
            "items": [
                {
                    "type": "filter",
                    "field": "name",
                    "operator": "==",
                    "value": "三'通"
                },
                {
                    "type": "filter",
                    "field": "parentId",
                    "operator": "==",
                    "value": 128
                }
            ]
        }
    ]
}

1.2. 参数说明

参数名 类型 示例 是否必填 参数含义
model string M34345435352 模型key

1.3. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "content": [
            {
                "name": "斜檩条:斜檩条-1m:2824483",
                "type": "IfcBuildingElementProxy",
                "key": "M1577178468831_03xNH48oj7Wv6Pwjg1c_RA"
            },
            {
                "name": "斜檩条:斜檩条:2745945",
                "type": "IfcBuildingElementProxy",
                "key": "M1577178468831_3gTr6XEtj3kO57N2kFyI$W"
            }
        ],
        "first": false,
        "last": false,
        "number": 2,
        "numberOfElements": 2,
        "size": 2,
        "totalElements": 27,
        "totalPages": 14
    }
}

1.4. 状态码

状态码 code message data 原因
400 PARAMETER_REQUIRED model、models不可同时为空 NULL 当参数model、models都未指定时
400 BAD_PARAMETER model、models不可同时指定 NULL 当参数model、models同时指定时
400 BAD_PARAMETER type未指定 NULL 当type未指定时
400 BAD_PARAMETER type只能为filter、and或or之一 NULL 为filter、and、or以外的值时
400 BAD_PARAMETER filter节点必须包含field、operator和value字段 NULL 当filter节点缺少field、operator或value字段时
400 PARSE_FAILED 模型(XXX)解析失败 NULL 当模型解析已经失败时
400 PARSE_NOT_FINISHED 模型(XXX)正在解析 NULL 当模型解析尚未完成时
400 BAD_PARAMETER filter节点operator(XXX)不支持 NULL 当operator值非法时

1.5. 备注

暂无备注

1.6. 注意事项

1、数据库启用gacl时,有模型关联的BOSF文档读取权限的用户。

2、数据库未启用gacl时,有数据库访问权限的用户。

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2021 all right reserved,powered by Gitbook该文件修订时间: 2021-08-25 16:16:24

results matching ""

    No results matching ""