创建组件数据

POST https://api.bimface.com/module/v1/module-data

说明

通过基本的配置信息创建组件数据，不同组件类型的配置信息不同。创建成功后返回组件数据ID，通过组件数据ID可以获取组件数据加载的View Token。

参数

Header

Authorization *

Bearer {accessToken}

string

*为必填项

Body

moduleType *	组件类型，“Linkage2D3D”为图模联动。	string
name *	数据名称	string
projectId	项目ID，不传时为默认项目ID	int64
sources *	文件列表	< ModuleDataSourceItem >array
id *	轻量化模型或图纸ID	int64
type *	轻量化模型或图纸类型，singleModel为单模型或图纸，integrateModel为集成模型	string
data *	组件数据，内容由组件类型确定	object

响应

HTTP代码	说明	类型
200	OK	GeneralResponseV1«ModuleDataResponse»
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

200响应参数

GeneralResponseV1«ModuleDataResponse»

名称	说明	类型
code	样例: "code"	string
data	返回数据	ModuleDataResponse
reason	失败原因	string
moduleType	组件类型	string
createTime	创建时间	int64
name	数据名称	string
updateTime	更新时间	int64
moduleDataId	组件数据ID	int64
status	状态	string
message	提示消息	string

消耗

• application/json

生成

• */*
• application/json

HTTP请求示例

请求 path

https://api.bimface.com/module/v1/module-data

请求 header

"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

请求 body

{
  "moduleType": "Linkage2D3D",
  "name": "图模联动示例",
  "projectId": 10000000006014,
  "sources": [
    {
      "id": "10000018070125",
      "type": "singleModel"
    }
  ],
  "data": {
    "model": {
      "id": "10000018070125",
      "type": "singleModel"
    },
    "drawings": [
      {
        "list": [],
        "displayMode": {
          "toolbar": {
            "drawingToolbars": [
              "MainToolbar",
              "DrawingList",
              "SearchToolbar"
            ],
            "modelToolbars": [
              "MainToolbar",
              "ModelTree",
              "ViewHouse"
            ]
          }
        }
      }
    ]
  }
}

HTTP响应示例

响应 200

{
  "code": "bimfaceservice-0000",
  "message": null,
  "data": {
    "createTime": "2022-10-31T15:04:18.000Z",
    "moduleDataId": 2502450510451488,
    "moduleType": "Linkage2D3D",
    "name": "图模联动示例",
    "reason": null,
    "status": "success",
    "updateTime": "2022-10-31T15:04:18.000Z"
  }
}