1. 根据抽取 Id 多条件查询抽取 tags

根据抽取 Id 多条件查询抽取 tags。

请求方式:POST

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

1.1. 请求参数:

Headers:

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

PathParas:

参数名 类型 示例 是否必填 参数含义
key string xb05cd3a35614caa85c0f8f86c58fcc2 抽取任务 Id

SearchParas:

参数名 类型 示例 是否必填 参数含义
noRelation boolean true/false true 表示不返回关联关系;false 表示返回所有关联关系
page number 1 第几页
per_page number 5 每页返回数量
sortby string order 指定返回结果按照哪个属性排序;
order string asc 排序顺序,asc 升序,desc 降序;

Body:

application/json:

{
    "condition": [
        {
            "field": "name", // 查询字段
            "operator": "like", // 匹配规则 精确查询,模糊查询等等
            "value": "zhao", // 值
            "number": "false", //比较时将内容转化为数字后再比较
            "logic": " " // 条件连接,若只有一条查询条件则为空。值可为Or,And。
        }
    ],
    "nestOr": [
        {
            "field": "name",
            "operator": "==",
            "value": "file1",
            "number": "false"
        },
        {
            "nestAnd": [
                {
                    "field": "name",
                    ...
                },
                {...}
            ]
        }
    ],
    "select": [
        "name" // 指定返回字段,若未指定,返回实体所有内容。
    ]
}

1.2. 参数说明:

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

1.3. 正确返回:

(Http Status Code:200{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
            count: 100, //总记录数
            data: {
              "parameter": {
                  "key": "",
                  "bosclass": "",
                  "code": "",
                  "description": "",
                  "name": "",
                  "gtime": "",
                  "guser": "",
                  "gacl": [
                      {
                          "principal": "user/187611711",
                          "permissions": "rwdc",
                          "flags": ""
                      }
                  ],
                  "currentUserPermissions": "rwdc"
              },
              "relationship": {
                  "irFolderDocument": {
                      "documents": [
                          {
                              "key": "document04_0",
                              "uri": " http://xxx.xxx/documents/document04_0",
                              "relationshipKey": "XXX"
                          },
                          {
                              "key": "document05_0",
                              "uri": " http://xxx.xxx/documents/document05_0",
                              "relationshipKey": "YYY"
                          }
                      ]
                  }
              }
        }
    }}

1.4. 状态码:

状态码 code message data 原因
200 JSON_FORMAT_WRONG Json 格式错误 NULL 当传入 body 格式错误时
200 ENTITY_NOTFOUND key 为{key}的抽取任务不存在 NULL 当传入任务 key 错误时
200 ENTITY_QUERY_NUMBER_SETTING_CONFLICT 不可同时设置 number 为 true、operator 为非数字运算符{operator} NULL 如 condition 或 nestAnd/nestOr 参数中 number 值为 true,但 operator 值为 like
200 ENTITY_QUERY_NUMBER_CONVERT_WRONG value 参数值{value }非数字 NULL 如 condition 或 nestAnd/nestOr 参数中 number 值为 true,但 value 值无法转换为数字
200 ENTITY_QUERY_NUMBER_SETTING_INVALID number 参数值{number}无效 NULL 如 condition 或 nestAnd/nestOr 参数中 number 值为 true、false、空以外的其他值
200 ENTITY_QUERY_PAGE_SETTING_INVALID page 参数值{page}非数字 NULL 查询参数 page 值为数字以外的值时
200 ENTITY_QUERY_PERPAGE_SETTING_INVALID per_page 参数值{per_page}非数字 NULL 查询参数 per_page 值为数字以外的值时
200 ENTITY_QUERY_ORDER_SETTING_INVALID order 参数值{order}无效 NULL 查询参数 order 值为 asc 或 desc 以外的值时

1.5. 注意事项:

通过多条件查询某次抽取任务 taskId 下抽取的 tags

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

results matching ""

    No results matching ""