1. 对比两个模型

比较模型两个不同版本之间的差异。


请求方式:POST

请求地址:/api/{databaseKey}/compares

1.1. 请求参数

Headers:

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

PathParas:

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

SearchParas:

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

Body

application/json:

{
    "old": "M208081111", //旧版模型key
    "new": "M208081112", //新版模型key
    "name": "test", //比较的名称
    "base": "guid", //构件标识字段名
    "permission": "public", //对比访问权限
    "force": false //是否强制比较
}

1.2. 参数说明

参数名 类型 示例 是否必填 参数含义
old string M208081111 旧版模型key
new string M208081112 新版模型key
name string test 比较的名称
base string guid 构件标识字段名
permission string public 对比访问权限
force Boolean false 是否强制比较

1.3. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "old": "M208081111",
        "new": "M208081112",
        "name": "test",
        "base": "guid",
        "remark": "模型正在对比",
        "key": "C2080811111",
        "status": "0"
    }
}

1.4. 状态码

状态码 code message data 原因
400 BAD_PARAMETER
1、提取精度范围:1-3,1级提取构件最少,3级提取构件最多。
2、模型解析成功后才能提取模型外轮廓。
3、level默认为1,即默认提取精度为1。
4、createScene默认为true,即默认自动创建场景。
NULL 当old、new值相同时
400 BAD_PARAMETER_VALUE 参数(base)值不正确 NULL 当base值不是guid、name或attribute.xxx时
400 PARSE_FAILED 模型(xxxx)解析失败 NULL 当模型解析已经失败时
400 PARSE_NOT_FINISHED 模型(xxxx)正在解析 NULL 当模型解析尚未完成时
400 BAD_PARAMETER 模型(XXX)属性(XXX)存在重复,无法对比 NULL 当模型构件标识字段值有重复时

1.5. 备注

暂无备注

1.6. 注意事项

1、两个版本的模型均解析成功后才能对比;同一模型不能对比。
2、用新模型对比旧模型,得到新增构件、删除构件、修改构件清单。
3、base为构件标识字段名,每个模型中构件的标识字段值不能重复,标识字段值相同的构件比较具体差异,base可以设置为guid(默认)、name 或 attribute.xxx(attribute中的标识属性)。
4、force指定是否强制对比,默认为false。当force为false时,如果系统已对比过,则直接返回;当false为true时,重新执行对比。当对比的模型中有替换或升版时,建议设置此参数为true。
5、permission为对比结果访问权限,默认为public(不限制访问),可以设置为system(BOS用户可以访问)、private(仅本人可以访问)或BOS 应用的key(该BOS应用的用户可以访问);如用户未登录,则仅可为public。
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2021 all right reserved,powered by Gitbook该文件修订时间: 2021-09-24 14:14:57

results matching ""

    No results matching ""