1. 分页获取模型删除构件明细

分页获取模型变更概要中删除构件的属性。


请求方式:GET

请求地址:/api/{databaseKey}/compares/deleted/list? compareKey={compareKey}&pageNumber={pageNumber}&pageSize={pageSize} &filters={filter1,filter2,……}&attributes={xxx,yyy,zzz}

1.1. 请求参数

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
compareKey string NULL 模型对比key
pageNumber int NULL 分页返回的页码,从0开始
pageSize int NULL 分页返回每页最大条目,取值100~10000
filters string NULL 筛选条件,可选;多个筛选条件之间用英文逗号连接
attributes string NULL 需要返回的属性,可选;多个属性之间用英文逗号连接

Body

application/json:

NULL

参数说明

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

1.2. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "content": [
            {
                "key": "M208081111_3",
                "name": "xxxxxxxxxxxxxxxxxxxx"
            }

        ],
        "totalElements": 521,  //总数
        "totalPages": 6,  //总页数
        "last": false,  //是否最后一页
        "number": 0,  //当前页码
        "size": 100,  //每页最大数量        
        "first": true,  //是否第一页
        "numberOfElements": 100 //本页数量
    }
}

1.3. 状态码

状态码 code message data 原因
NULL NULL NULL NULL NULL

1.4. 备注

暂无备注

1.5. 注意事项

1、分页返回模型对比结果中新增构件信息。

2、filters为可选参数,用于根据构件属性筛选变更构件,当filters参数指定时,仅返回符合过滤条件的构件变更明细。

3、多个筛选条件用英文逗号分隔,其中一个条件满足即可。

4、筛选条件以旧模型为基准,由属性名和属性值构成,采用英文冒号连接,格式如下:

 filter_attribute:filter_value,其中filter_attribute表示过滤的属性字段名,filter_value表示过滤的属性值(如不指定,代表不为空)
 举例:
 1)type:墙  表示type属性值包含墙的构件
 2)attribute.code  表示attribute.code属性不为空的构件

5、attributes不指定或为空时,返回构件key以及有变更的属性;否则返回指定的属性。

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

results matching ""

    No results matching ""