警告

1. 调用本页面的接口方法都需要激活对应模型
2. 批注接口采用标准的REST接口形式提供服务
   • {url} 表示 BIM DCP 服务接口，转换器对外提供的服务
   • {id} 表示当前数据的 批注编号

流程示意图

提示

• 圆形为 WEB 浏览器处理
• 矩形为 BIM API 接口

数据结构体

// 批注编号
id: Number
// 批注名称
title: String
// 批注描述
description: String
// 上传文件标识符UUID, 也是模型列表的AssetID
uuid: String
// 模型构件NodeId
nodeId: null | String
// 批注创建时间，unix时间戳
createdTime: Number
// 批注修改时间，unix时间戳
updatedTime: Number

获取批注

单条

GET {url}/tag/{id}

入参

无

出参

{
  "code": "0000",
  "message": "OK",
  "data": {
    "id": 6,
    "title": "house",
    "description": "1111",
    "uuid": "7c6b741e-d3c1-4486-a55c-c763b6c59a53",
    "nodeId": null,
    "createdTime": 1657533010000,
    "updatedTime": 1657533010000
  }
}

分页

GET {url}/tag/page

入参

id: Number
title: String
description: String
uuid: String
nodeId: null | String
// 当前页数，从 1 开始
pi: Number
// 每页条数，默认 10
ps: Number

出参

{
  "code": "0000",
  "message": "OK",
  "timestamp": 1657703500551,
  "data": {
    // 总条数
    "total": 11,
    // 每页条数
    "ps": 10, 
    // 当前页数
    "pi": 1,
    // 当前页数据
    "data": [
      {
        "id": 6,
        "title": "house",
        "description": "1111",
        "uuid": "7c6b741e-d3c1-4486-a55c-c763b6c59a53",
        "nodeId": null,
        "createdTime": 1657533010000,
        "updatedTime": 1657533010000
      },
    ]
  }
}

批量

GET {url}/tag

入参

id: Number
title: String
description: String
uuid: String
nodeId: null | String

出参

{
  "code": "0000",
  "message": "OK",
  "timestamp": 1657703500551,
  "data": [
    {
      "id": 6,
      "title": "house",
      "description": "1111",
      "uuid": "7c6b741e-d3c1-4486-a55c-c763b6c59a53",
      "nodeId": null,
      "createdTime": 1657533010000,
      "updatedTime": 1657533010000
    },
  ]
}

添加批注

POST {url}/tag

入参

注意

参数为 form 形式，请求头 Content-Type: application/x-www-form-urlencoded

// 必须
title: String
description: String | null | undefined
// 必须
uuid: String
nodeId: String | null | undefined

出参

{
  "code": "0000",
  "message": "OK",
  "timestamp": 1657703500551,
  "data": {
    "id": 6,
    "title": "house",
    "description": "1111",
    "uuid": "7c6b741e-d3c1-4486-a55c-c763b6c59a53",
    "nodeId": null,
    "createdTime": 1657533010000,
    "updatedTime": 1657533010000
  }
}

修改批注

PUT {url}/tag/{id}

入参

注意

参数为 json 形式，请求头 Content-Type: application/json

{
  "title": "house",
  "description": "1111",
  "uuid": "7c6b741e-d3c1-4486-a55c-c763b6c59a53",
  "nodeId": null
}

出参

无

删除批注

DELETE {url}/tag/{id}

入参

无

出参

无