1. 获取数据目录包含的子目录和数据列表

请求方式:POST

请求地址:/bosgeoservice/{appKey}/geoCategories/geoCategories&geoData

1.1. 请求参数:

Body:

application/json:

{    
"key": "F1" , # 目录key,如果不传,就默认查询根目录,如果不存在目录,则初始化目录
    "entity": "both", # 查询的类别,目录(geoCategories),数据(geoData),都查(both),    默认为both
    "page"1, #指定当前查询第几页,从1开始;
    "per_page"20, # 每页的记录数;
"sortby""name",# 指定返回结果按照哪个属性排序;
    "order"" asc",#排序,asc升序,desc降序;
    "condition": [{
            "field": "name",# 查询字段
            "operator": "like",# 匹配规则 精确查询( = ),模糊查询(like),大于查询( > )等等
            "value": "zhao",# 值
            "number": "false",# 比较时将内容转化为数字后再比较
            "logic": " " # 条件连接,值只可为Or,    And
    }],
    "nestAnd": [{# 嵌套条件,表示内部之间是and关系
            "field": "name",
            "operator": "like",
            "value": "doc",
            "number": "false"
        }, {
            "nestOr": [{# 嵌套条件,表示内部数组之间是or关系
                    "field": "name",
                    "operator": "like",
                    "value": "a",
                    "number": "false"
                }
            ]
        }
    ]
}

1.2. 参数说明:

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

1.3. 正确返回:

(Http Status Code:200{
"code":"SUCCESS",
"message":"请求处理成功",
"data":{
    "data": [
        {
            "bosclass": "geoCategories",
            "code": "FLD-1913-001",
            "description": "", 
            ……            
        },
        {
            "bosclass": "geoData",
            "code": "geoData1913-5",
"description": "",
"longCode":"",   #所属目录code路径
"longName":""   #所属目录name路径
           ……
        }
    ],
    "count": 10,
    "page": 1,
    "per_page": 20
}
}

1.4. 状态码:

状态码 code message data
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL
200 JSON_FORMAT_WRONG Json格式错误 NULL
200 ENTITY_QUERY_LOGIC_SETTING_INVALID logic参数值{logic}无效 NULL
200 ENTITY_QUERY_NUMBER_SETTING_CONFLICT 不可同时设置number为true、operator为非数字运算符{operator} NULL
200 ENTITY_QUERY_NUMBER_CONVERT_WRONG value参数值{value }非数字 NULL
200 ENTITY_QUERY_NUMBER_SETTING_INVALID number参数值{number}无效 NULL
200 ENTITY_QUERY_PAGE_SETTING_INVALID page参数值{page}非数字 NULL
200 ENTITY_QUERY_PERPAGE_SETTING_INVALID per_page参数值{per_page}非数字 NULL

1.5. 注意事项:

(1)返回目录下包含的子目录和子数据(第一层) (2)如果系统不存在根目录,则创建默认的五个根目录 (3)只展示该目录下面该用户拥有查看权限的数据/目录 (4)排序的时候目录在最上面 (5)目前不支持value值为数组的查询 (6)operator仅支持==,!=,<,<=,>,>=,like操作: 1)==:等于 2)!=:不等于 3)<:小于 4)<=:小于等于 5)>:大于 6)>=:大于等于 7)like:模糊查询,如当field为name,value为AAA时,则查找name属性中值包含AAA的实体对象。 (7)condition参数中number可不传入,如传入且值为true则operator值不可为like,且比较时将数据转换为数字后再比较;如number值为false、空或number不传入,则进行字符串比较。 (8)condition参数中logic为必填,每个条件的logic表示与前一个条件的逻辑关系;logic 只支持Or,And。第一个搜索条件的logic建议设置为and,如设置为or,则在搜索时忽略该条件设置,如第一个搜索条件的logic设置为or,其后紧接着还有1个及以上条件的logic设置为or,则在搜索时忽略这些条件设置。 (9)condition、nestAnd、nestOr非必填,如三者都未传,则返回所有结果。 (10)nestAnd、nestOr可以嵌套在任意一个对象的查询条件中,nestAnd表示其内部的查询条件之间为and与关系,nestOr表示其内部的查询条件之间为or或关系。 (11)不建议condition与nestAnd/nestOr混用;一般情况简单的查询条件可使用condition,当多个查询条件需要进行and、or的复杂组合时建议使用nestAnd和nestOr。 (12)查询结果按照sortby字段的order顺序进行排序。sortby不传或为非对象字段时则查询结果不排序。 (13)按照参数page和per_page获取用户有读取权限的数据:page>0,per_page>0 则data部分返回第page页数据(如无数据则为空数组),count值为总记录数;page未提供,per_page>0 则data部分返回第一页数据(如无数据则为空数组),count值为总记录数;per_page=0则data为空数组,count值为总记录数;per_page不传则data部分返回所有数据(如无数据则为空数组),count值为总记录数。 (14)返回数据中bosclass为geoCategories表示返回的是目录, bosclass为geoData表示返回的是数据。

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

results matching ""

    No results matching ""