API：获取修改构件属性差异

GET https://api.bimface.com/data/compare/element

注意： 只有变更类型diffType=change的才能调用此接口获取差异对比，新增new和删除delete的调用属性接口查看构件原始属性。

---

请求（Request）

Header

key	value	示例
Authorization	bearer {accessToken}	bearer xxxx-xxxx-xxxx-xxxx
Content-Type	application/json	…

Url Parameter

字段	类型	必填	描述	示例
compareId	Number	Y	模型对比ID	…
previousFileId	Number	Y	对比差异构件来源文件ID	…
previousElementId	String	Y	对比差异构件来源构件ID	…
followingFileId	Number	Y	对比差异构件变更文件ID	…
followingElementId	String	Y	对比差异构件互为变更构件ID	…

Request Body

无

curl -X GET 
-H "Content-Type: application/json" 
-H "Authorization: bearer <your accessToken>" 
"https://api.bimface.com/data/compare/element?compareId=<your compareId>&previousFileId=<your previousFileId>&previousElementId=<your previousElementId>&followingFileId=<your followingFileId>&followingElementId=<your followingElementId> "

---

响应（Response）

HTTP STATUS

200

成功返回

{
    "code": "success",
    "message": null,
    "data": {
        "A": "变化图元前一个版本的ID",
        "B": "变化图元后一个版本的ID",
        "newAttributes": [{
            "key": "属性名",
            "value": "属性值",
            "unit": ""
        }],
        "deleteAttributes": [{
            "key": "属性名",
            "value": "属性值",
            "unit": ""
        }],
        "changeAttributes": [{
            "A": {
                "key": "属性名",
                "value": "属性值",
                "unit": "",
                 
            },
            "B": {
                "key": "属性名",
                "value": "属性值",
                "unit": "",
                 
            }
        }],
        "newQuantities": [{                           // 表示新加入的工程量
            "code": "工程量编码(用于运算)",
            "desc": "工程量描述",
            "name": "工程量名称(用于显示)",
            "unit": "单位",
            "qty": 数值
        }],
        "deleteQuantities": [{                         // 表示删除的工程量
            "code": "工程量编码(用于运算)",
            "desc": "工程量描述",
            "name": "工程量名称(用于显示)",
            "unit": "单位",
            "qty": 数值
        }],
        "changeQuantities": [{                        // 表示变化的工程量
            "A": {                                    // 前一个版本
                "code": "工程量编码(用于运算)",
                "desc": "工程量描述",
                "name": "工程量名称(用于显示)",
                "unit": "单位",
                "qty": 数值
            },
            "B": {                                     // 后一个版本
                "code": "工程量编码(用于运算)",
                "desc": "工程量描述",
                "name": "工程量名称(用于显示)",
                "unit": "单位",
                "qty": 数值
            }
        }]
    }
}

字段	类型	描述	示例
A	String	变化图元前一个版本的ID	1274969781330112.332749
B	String	变化图元后一个版本的ID	1274969736151232.332749
newAttributes	newAttributes[]	新增属性列表	…
deleteAttributes	deleteAttributes[]	删除属性列表	…
changeAttributes	changeAttributes[]	修改属性列表	…

失败返回

{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}

错误码

code	说明
system.error	BIMFACE系统异常
authentication.failed	API访问合法性校验失败
compare.not.found	对比ID不存在
compare.not.complete	对比还末完成
compare.failed	对比失败
change.not.found	差异未找到