1. 根据空间树和属性查询物项

根据空间树和属性查询物项。

请求方式:POST

请求地址:/bosdesignservice/{appKey}/tags/query

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

SearchParas:

参数名 类型 示例 是否必填 参数含义
page int NULL 第几页
per_page int NULL 每页返回数量

Body:

application/json:

{
    "scope": [
        "all",
        "noModel",
        "model1",
        "model2",
        "model3"
    ],
    "condition": [
        {
            "bosclass": "locations", //空间查询
            "field": "key", // 
            "operator": "==", // 匹配规则 精确查询,模糊查询等等
            "value": "zhao", //值
            "number": "false", //比较时将内容转化为数字后再比较
            "logic": " " //条件连接,若只有一条查询条件则为空。值可为Or,And。
        },
        {
            "bosclass": "tags", //属性查询
            "field": "name", // 查询字段
            "operator": "like", //匹配规则 精确查询,模糊查询等等
            "value": "zhao", // 值
            "number": "false", //比较时将内容转化为数字后再比较
            "logic": " " // 条件连接,若只有一条查询条件则为空。值可为Or,And。
        }
    ],
    "select": [
        "code",
        "name" // 指定返回字段,若未指定,返回物项所有内容。
    ]
}

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
scope string model
condition 数组 空间

1.3. 正确返回:

(Http Status Code:200{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": [
        {
            //返回select字段
            "code": "A",
            "name": "folder1"
        },]
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_QUERY_PAGE_SETTING_INVALID page参数值{page}非数字 NULL 当传入page、per_page格式错误时
200 JSON_FORMAT_WRONG Json格式错误 NULL 当传入body格式错误时
200 ENTITY_QUERY_CONDITION_REQUIRED 需指定查询条件 NULL 当condition为空时

1.5. 注意事项:

scope:物项的查询范围,all表示全部,默认为all,noModel表示与模型无关联的物项,其他值可以为modelKey,表示与该模型关联的物项。以上范围取并集。

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

results matching ""

    No results matching ""