查询分页构件信息

最近更新时间：2024-03-12 02:07:47

我的收藏

本页目录：

1. 接口描述

接口请求域名： weilingwith.tencentcloudapi.com 。

查询分页构件信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeElementProfilePage。
Version	是	String	公共参数，本接口取值：2023-04-27。
Region	是	String	公共参数，详见产品支持的地域列表。
BuildingId	是	String	建筑id 示例值："956bd069-c802-4bbb-b325-18d30d7bcd3c"
PageNumber	是	Integer	页码示例值：1
PageSize	是	Integer	页容量示例值：10
WorkspaceId	是	String	项目空间id 示例值："1016"
ApplicationToken	是	String	应用token 示例值："ZRCJHdnhqEUEqO1vyskCgWimPucHhREV"
ParentElementIds.N	否	Array of String	父级构件id 示例值：""
Level	否	Integer	空间层级示例值：7
SpaceTypeCode	否	String	空间分类代码示例值：""
EntityTypes.N	否	Array of String	构件类型示例值：[ "TBIM_SPACE", "TBIM_BUILDINGSTOREY" ]
IncludeDelete	否	Boolean	是否包含已删除构件示例值：false
StartTime	否	Integer	时间范围-开始示例值：1683981442
EndTime	否	Integer	时间范围-结束示例值：1699879043

3. 输出参数

参数名称	类型	描述
Result	ElementProfilePageRes	分页查询构件出参示例值：{ "List": [ { "BottomHeight": -100, "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c", "ElementDesc": "", "ElementId": "1Kjh8u2qf4uRSkCPoKigTI", "ElementName": "1F（结） -0.100", "EntityType": "TBIM_BUILDINGSTOREY", "IsDelete": 0, "Level": 7, "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c", "Sort": 1, "SpaceCode": "000185004", "SpacePoiId": "", "SpaceTypeCode": "", "SpaceTypeName": "" } ], "TotalCount": 1 }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询分页构件信息

查询分页构件信息成功响应示例

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeElementProfilePage
<公共请求参数>

{
    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
    "PageNumber": 1,
    "PageSize": 10,
    "EntityTypes": [
        "TBIM_SPACE",
        "TBIM_BUILDINGSTOREY"
    ],
    "WorkspaceId": "1016",
    "ApplicationToken": "ZRCJHdnhqEUEqO1vyskCgWimPucHhREV"
}

输出示例

{
    "Response": {
        "RequestId": "f21ec011-9dde-478f-acd4-6adecb8a1c32",
        "Result": {
            "List": [
                {
                    "BottomHeight": -100,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKigTI",
                    "ElementName": "1F（结） -0.100",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 1,
                    "SpaceCode": "000185004",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "3Mph_S_ef13f4LIAEQPvzw",
                    "ElementName": "1",
                    "EntityType": "TBIM_SPACE",
                    "IsDelete": 0,
                    "Level": 8,
                    "ParentElementId": "1Kjh8u2qf4uRSkCPoKj36O",
                    "Sort": 2,
                    "SpaceCode": "00018500100000001",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKj36O",
                    "ElementName": "1F 0.000",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 3,
                    "SpaceCode": "000185001",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 5900,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKiWWT",
                    "ElementName": "2F（结）5.900",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 4,
                    "SpaceCode": "000185007",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 6000,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKj38P",
                    "ElementName": "2F 6.000",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 5,
                    "SpaceCode": "000185002",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 11000,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKlbkh",
                    "ElementName": "3F(结）",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 6,
                    "SpaceCode": "000185003",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 11100,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKiVXm",
                    "ElementName": "F3",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 7,
                    "SpaceCode": "000185005",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 16200,
                    "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "ElementDesc": "",
                    "ElementId": "1Kjh8u2qf4uRSkCPoKiVdy",
                    "ElementName": "F4",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 7,
                    "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c",
                    "Sort": 8,
                    "SpaceCode": "000185006",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                }
            ],
            "TotalCount": 8
        }
    }
}

示例2 查询分页构件信息示例-prod

查询分页构件信息示例-prod

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeElementProfilePage
<公共请求参数>

{
    "BuildingId": "9e98dc3920df4230b431404222fefe37",
    "PageNumber": 1,
    "PageSize": 5,
    "WorkspaceId": "1124",
    "ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}

输出示例

{
    "Response": {
        "RequestId": "aa86cd58-027d-46b4-8d59-a7e15c733f18",
        "Result": {
            "List": [
                {
                    "BottomHeight": 0,
                    "BuildingId": "9e98dc3920df4230b431404222fefe37",
                    "ElementDesc": "",
                    "ElementId": "9e98dc3920df4230b431404222fefe37",
                    "ElementName": "rvm",
                    "EntityType": "TBIM_BUILDING",
                    "IsDelete": 0,
                    "Level": 6,
                    "ParentElementId": "",
                    "Sort": 1,
                    "SpaceCode": "000147",
                    "SpacePoiId": "86162",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "9e98dc3920df4230b431404222fefe37",
                    "ElementDesc": "/SAMPLE-ADMIN built by rvm",
                    "ElementId": "4cf3865c355048d0be117466b89ff5ae",
                    "ElementName": "/SAMPLE-ADMIN",
                    "EntityType": "TBIM_BUILDINGSTOREY",
                    "IsDelete": 0,
                    "Level": 0,
                    "ParentElementId": "9e98dc3920df4230b431404222fefe37",
                    "Sort": 2,
                    "SpaceCode": "",
                    "SpacePoiId": "861620006",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "9e98dc3920df4230b431404222fefe37",
                    "ElementDesc": "/HS-ADMIN/ADMIN built by rvm",
                    "ElementId": "f5dfeea83847436a98dd02957b283d0d",
                    "ElementName": "/HS-ADMIN/ADMIN",
                    "EntityType": "TBIM_BUILDINGELEMENTPROXY",
                    "IsDelete": 0,
                    "Level": 0,
                    "ParentElementId": "4cf3865c355048d0be117466b89ff5ae",
                    "Sort": 3,
                    "SpaceCode": "",
                    "SpacePoiId": "8616200060004",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "9e98dc3920df4230b431404222fefe37",
                    "ElementDesc": "/GRID-STABILIZER/1 built by rvm",
                    "ElementId": "b3f9777344214077a65d3673b17578bc",
                    "ElementName": "/GRID-STABILIZER/1",
                    "EntityType": "TBIM_BUILDINGELEMENTPROXY",
                    "IsDelete": 0,
                    "Level": 0,
                    "ParentElementId": "6ab5d7d6f6264824a1318435a0a09b4c",
                    "Sort": 4,
                    "SpaceCode": "",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                },
                {
                    "BottomHeight": 0,
                    "BuildingId": "9e98dc3920df4230b431404222fefe37",
                    "ElementDesc": "CYLINDER 2 of EQUIPMENT /P1502B built by rvm",
                    "ElementId": "fc1a114cf16d4f999f4825294a6b378f",
                    "ElementName": "CYLINDER 2 of EQUIPMENT /P1502B",
                    "EntityType": "TBIM_BUILDINGELEMENTPROXY",
                    "IsDelete": 0,
                    "Level": 0,
                    "ParentElementId": "2fa2c48f06ee40a5a8a24f296925e532",
                    "Sort": 5,
                    "SpaceCode": "",
                    "SpacePoiId": "",
                    "SpaceTypeCode": "",
                    "SpaceTypeName": ""
                }
            ],
            "TotalCount": 2501
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.BIMAppInternalError	BIM服务内部错误
InvalidParameterValue.InvalidElementIdOrProjectId	项目id或构件id取值错误
ResourceNotFound.ElementNotFound	未查询到构件信息

上一篇: 查询建筑信息下一篇: 查询构件树