# 获取组件数据列表

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

# 说明

调用方创建组件数据后,通过该接口按筛选条件批量查询组件数据的ID列表。

# 参数

Authorization * Bearer {accessToken} string
*为必填项
# Body
moduleType * 组件类型,"Linkage2D3D"为图模联动。 string
endDate 创建组件数据的结束日期,采用ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ss.MSZ date-time
pageNo 页码 int32
pageSize 每页记录条数,默认为20 int32
keyword 名称关键字 string
projectId 项目ID,不传时为默认项目ID int64
startDate 创建组件数据的开始日期,采用ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ss.MSZ date-time
moduleDataId 组件数据ID int64
*为必填项

# 响应

HTTP代码 说明 类型
200 OK GeneralResponseV1«PagedList«ModuleDataBean»»
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -
# 200响应参数
GeneralResponseV1«PagedList«ModuleDataBean»»
名称 说明 类型
code 样例: "success" string
data 返回数据 PagedList«ModuleDataBean»
page Page
startIndex 起始序号 int32
prePage 上一页 int32
nextPage 下一页 int32
pageNo 页码 int32
htmlDisplay string
totalPages 总页数 int32
pageSize 每页记录条数 int32
totalCount 总条数 int32
list < ModuleDataBean >array
reason 失败原因 string
moduleType 样例: "Linkage2D3D" string
createTime 创建时间 int64
name 数据名称 string
errorCode 错误码 string
updateTime 更新时间 int64
projectId 项目ID int64
moduleDataId 组件数据ID int64
status 数据状态 string
message 提示消息 string

# 消耗

  • application/json

# 生成

  • */*
  • application/json

# HTTP请求示例

# 请求 path
https://api.bimface.com/module/v1/module-data/list
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"
# 请求 body
{
  "moduleType" : "moduleType"
}

# HTTP响应示例

# 响应 200
{
  "code": "bimfaceservice-0000",
  "message": null,
  "data": {
    "page": {
      "nextPage": 1,
      "pageNo": 1,
      "pageSize": 20,
      "prePage": 1,
      "startIndex": 0,
      "totalCount": 1,
      "totalPages": 1
    },
    "list": [
      {
        "createTime": "2022-01-01T07:00:00.000Z",
        "updateTime": "2022-01-01T07:00:00.000Z",
        "errorCode": null,
        "moduleDataId": 2502450510451488,
        "name": "图模联动示例",
        "moduleType": "Linkage2D3D",
        "projectId": "10000000006016",
        "reason": "reason",
        "status": "success"
      }
    ]
  }
}