1. 计算模型最佳视口

计算模型最佳视口。

请求方式：POST

请求地址：/api/{databaseKey}/models/viewport

1.1. 请求参数

Headers：

PathParas：

Body

application/json:

{
    "modelKey": "M1599732658374",
    "redo": true,  // 可选，需要重新计算时设置。
    "scheme": 1  // 方案编号，1、2、3、4
}

1.2. 参数说明

1.3. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        “status”:“1”,
        “viewport”:{},
        "remark": "正在生成中",
        "timestamp": "2021-11-18 10:53:35"
    }
}

1.4. 错误返回

1）当modelKey不存在时，返回：
{"code":"MODEL_NOT_FOUND","message":"模型（xxx）不存在",data:null}；

2）当模型类型为DWG时，返回：
{"code":"BIZ_EXCEPTION", "message": "DWG模型无需计算最佳视口", "data": null}

3）当模型解析失败时，返回：
{"message": "模型（xxx）解析失败","code": "PARSE_FAILED","data": null}

4）当模型未解析完成时，返回：
{"message": "模型（xxx）正在解析","code": "PARSE_NOT_FINISHED","data": null}

1.5. 状态码

1.6. 备注

暂无备注

1.7. 注意事项

1）校验模型是否存在，如不存在则返回错误信息
2）只有3d模型可以计算最佳视口
3）最佳视口正在计算时，返回状态为0
4）最佳视计算完成且redo未设置或为false时，则返回状态为1和最佳视口信息
5）最佳视口计算错误且redo未设置或为false时，返回状态为-1
6）最佳视口计算完成，如果想重新计算，需要在body里面设置redo:true
7）方案编号参数，与需求文档中方案编号对应，方案一36个点，方案二20个点，方案三、四12个点，默认选择方案一。该参数在测试结束后删除
8）数据库启用gacl时，有模型关联的BOSF文档编辑权限的用户
9）数据库未启用gacl时，有数据库访问权限的用户

2. 查询最佳视口开启状态

查询最佳视口开启状态。

请求方式：GET

请求地址：/api/{databaseKey}/models/viewport/status? modelKey={modelKey}

2.1. 请求参数

Headers：

PathParas：

Body

application/json:

null

2.2. 参数说明

2.3. 正确返回

{
    "message": "请求处理成功",
     "code": "SUCCESS",
     "data": {
          "portNum": "1-1",
          "viewport": "{\"position\":{\"camera\":[70980.82955078126,-68909.84352539062,20066.37919921874],\"target\":[3328.78369140625,-8421.33984375,-1600.7666015624995]},\"idx\":0}",
          "status": "1",
          "timestamp": "2021-12-22 16:15:19",
          "switch": "false"
    }
}

2.4. 错误返回

1）当modelKey不存在时，返回：
{"code":"MODEL_NOT_FOUND","message":"模型（xxx）不存在",data:null}；

2）当模型类型为DWG时，返回：
{"code":"BIZ_EXCEPTION", "message": "DWG模型无需计算最佳视口", "data": null}

3）当模型解析失败时，返回：
{"message": "模型（xxx）解析失败","code": "PARSE_FAILED","data": null}

4）当模型未解析完成时，返回：
{"message": "模型（xxx）正在解析","code": "PARSE_NOT_FINISHED","data": null}

2.5. 状态码

2.6. 备注

暂无备注

2.7. 注意事项

1）若用户未指定过最佳视口开启状态，默认返回false
2）只有3d模型可以计算最佳视口
3）数据库启用gacl时，有模型关联的BOSF文档读取权限的用户
4）数据库未启用gacl时，有数据库访问权限的用户

3. 修改最佳视口开启状态

修改最佳视口开启状态。

请求方式：POST

请求地址：/api/{databaseKey}/models/viewport/status

3.1. 请求参数

Headers：

PathParas：

Body

application/json:

{
    "modelKey": "M1599732658374", // 模型key，必传
    "switch": "true"  // 是否开启最佳视口，必传
}

3.2. 参数说明

3.3. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "switch": "true"
    }
}

3.4. 错误返回

1）当modelKey不存在时，返回：
{"code":"MODEL_NOT_FOUND","message":"模型（xxx）不存在",data:null}；

2）当模型类型为DWG时，返回：
{"code":"BIZ_EXCEPTION", "message": "DWG模型无需计算最佳视口", "data": null}

3）当模型解析失败时，返回：
{"message": "模型（xxx）解析失败","code": "PARSE_FAILED","data": null}

4）当模型未解析完成时，返回：
{"message": "模型（xxx）正在解析","code": "PARSE_NOT_FINISHED","data": null}

5）当参数switch的值不为"true"或"false"时：
{"message": "参数（switch）值不正确","code": "BAD_PARAMETER_VALUE","data": null}

3.5. 状态码

3.6. 备注

暂无备注

3.7. 注意事项

1）参数switch指定最佳视口开启状态，true为开启，false为关闭
2）只有3d模型可以计算最佳视口
3）数据库启用gacl时，有模型关联的BOSF文档编辑权限的用户
4）数据库未启用gacl时，有数据库访问权限的用户