1. 根据属性查询构件

在一个或多个模型中根据属性值查询符合条件的构件,返回构件key。


请求方式:POST

请求地址:/api/{databaseKey}/queries/attributes?share={share}

1.1. 请求参数

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
share string NULL 分享key

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. 参数说明

参数名 类型 示例 是否必填 参数含义
type string "filter" 类型
field string "parentId" 字段名
operator string "==" 操作类型
value string 128

1.3. 正确返回

{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": [
        "key1",
        "key2"
    ]
}

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、model、models必填其一、不可同时指定,限定查询范围为指定一个模型或多个模型。
2、condition非必填,可设置一个或多个查询条件,多个查询条件之间的逻辑关系为“与”(必须同时满足)。查询条件的type必须为filter、and、or三种类型之一:
and:组合逻辑,对应节点必须设置items,items内的查询条件之间间的逻辑关系为"与"(必须同时满足)。
or:组合逻辑,对应节点必须设置items,items内的查询条件之间的逻辑关系为"或"(满足其一即可)。
filter:某个特定字段的查询条件,对应节点必须设置field、operator和value:
field:表示查询字段,可以为字段名(如name)或者对象字段的具体属性(如attribute.机械.系统类型或者attribute['机械']['系统类型'])。
operator:表示比较运算符,支持==、!=、<、<=、>、>=、like、in、not in;
value:表示值。如operator为like,则value应为字符串;如operator为in或not in,则value应为列表;其他情况可以为字符串、数字或null。
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2021 all right reserved,powered by Gitbook该文件修订时间: 2021-10-27 10:10:04

results matching ""

    No results matching ""