BimfaceClient (bimface 3.3.3 API)

java.lang.Object
- com.bimface.sdk.BimfaceClient

```
public class BimfaceClient
extends Object
```
访问bimface服务的入口

作者:

bimface, 2016-06-01.

构造器概要

构造器
构造器和说明
`BimfaceClient(String appKey, String appSecret)` 构造BimfaceClient对象
`BimfaceClient(String appKey, String appSecret, Config config)` 构造BimfaceClient对象
`BimfaceClient(String appKey, String appSecret, Endpoint endpoint)` 构造BimfaceClient对象
`BimfaceClient(String appKey, String appSecret, Endpoint endpoint, Config config)` 构造BimfaceClient对象
`BimfaceClient(String appKey, String appSecret, Endpoint endpoint, Config config, AccessTokenStorage accessTokenStorage)` 构造BimfaceClient对象

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`String`	`abortMultiPartUpload(String projectId, com.bimface.bdfs.bean.dto.v1.multipartupload.AbortMultipartUploadRequest abortMultipartUploadRequest)` 终止分片上传任务
`void`	`addAssociations(String integrateId, String fromIntegrationId, String fromBusinessType, String fromBusinessFlag, com.bimface.data.bean.BusinessAssociationRequest request)` 新增双向业务挂接,可以在request body中指定新增项，也可以指定从其他集成拷贝
`com.bimface.bdfs.bean.dto.FileItemAppendFileDTO`	`appendUpload(InputStream fileIn, String projectId, String appendFileId, String position)` 追加上传文件
`void`	`batchDeleteFileItems(String projectId, List<String> fileItemIds)` 批量删除文件
`com.bimface.api.bean.compatible.response.BatchDeleteResultBean<Long>`	`batchDeteleShare(List<Long> sourceIds)` 批量删除分享链接
`com.bimface.api.bean.response.ModelCompareBean`	`compare(com.bimface.api.bean.request.modelCompare.ModelCompareRequest modelCompareRequest)` 已过时。
`com.bimface.api.bean.response.ModelCompareBean`	`compareV2(com.bimface.api.bean.request.modelCompare.CompareRequest compareRequest)` 发起模型对比，V2
`com.bimface.bdfs.bean.dto.v1.FileItemDTOV1`	`completeMultiPartUpload(String projectId, com.bimface.bdfs.bean.dto.v1.multipartupload.CompleteMultipartUploadRequest completeMultipartUploadRequest)` 合并分片生成文件
`List<com.bimface.bdfs.bean.dto.FileItemDTO>`	`copyFile(String projectId, com.bimface.bdfs.bean.CopyFileRequest copyFileRequest)` 复制文件
`com.bimface.file.bean.AppendFileBean`	`createAppendFile(String name, String sourceId, Long length)` 创建追加文件
`com.bimface.bdfs.bean.dto.FileItemAppendFileDTO`	`createAppendFile(String projectId, String parentId, String parentPath, String name, Long length, String sourceId)` 创建追加文件
`com.bimface.api.bean.response.clashDetective.ClashDetectiveResponse`	`createClashDetective(com.bimface.api.bean.request.clashDetective.ClashDetectiveRequest request)` 发起碰撞检测
`com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean`	`createDrawingSplit(Long fileId, String callback, Map<String,String> config)` 发起图纸拆分
`com.bimface.bdfs.bean.dto.FileItemDTO`	`createFolder(String projectId, CreateFolderRequest createFolderRequest)` 指定目录创建文件夹
`com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean`	`createIntegrateBakeDatabag(Long integrateId, String callback, Map<String,String> config)` 为集成模型创建bake数据包需要模型集成成功后调用
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createIntegrateShare(Long integrateId)` 创建集成文件浏览分享链接,永久有效
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createIntegrateShare(Long integrateId, Integer activeHours)` 创建集成文件浏览分享链接
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createIntegrateShare(Long integrateId, String expireDate, Boolean needPassword)` 创建集成文件浏览分享链接,带分享密码
`com.bimface.bdfs.bean.dto.ProjectDTO`	`createProject(String hubId, ProjectCreateRequest request)` 创建项目
`com.bimface.scene.bean.CreateSceneResp`	`createScene(com.bimface.scene.bean.CreateSceneRequest sceneInfo)` 创建场景
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createSceneShare(Long sceneId)`
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createSceneShare(Long sceneId, Integer activeHours)`
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createSceneShare(Long sceneId, String expireDate, Boolean needPassword)` 创建场景分享链接，带分享密码
`com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean`	`createTranslateBakeDatabag(Long fileId, String callback, Map<String,String> config)` 为文件创建bake数据包需要文件转换成功后调用
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createTranslateShare(Long fileId)` 创建单个文件浏览分享链接,永久有效
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createTranslateShare(Long fileId, Integer activeHours)` 创建单个文件浏览分享链接
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`createTranslateShare(Long fileId, String expireDate, Boolean needPassword)` 创建单个文件浏览分享链接,带分享密码
`com.bimface.bdfs.bean.dto.FileItemDTO`	`createVersion(InputStream fileIn, String projectId, String fileItemId, String path, String name, Long length, String sourceId)` 上传版本文件
`void`	`deleteAssociationsByBizIds(String integrateId, String businessType, String businessFlag, List<String> businessIds)` 删除业务挂接
`void`	`deleteAssociationsByBusinessId(String integrateId, String businessType, String businessId)` 删除业务ID关联的业务挂接
`void`	`deleteAssociationsByElementId(String integrateId, String elementId, String businessType, String businessFlag, List<String> businessIds)` 删除构件关联的业务挂接
`void`	`deleteAssociationsByElements(String integrateId, String businessType, String businessFlag, List<String> elementIds)` 删除业务挂接
`void`	`deleteCompare(Long compareId)` 已过时。
`void`	`deleteFile(Long fileId)` 删除文件
`String`	`deleteFolder(String projectId, String folderId, String path)` 删除文件夹根据folderId(path)删除文件夹
`void`	`deleteIntegrate(Long integrateId)` 删除集成模型
`String`	`deleteIntegrateModelElementProperties(Long integrateId, String fileIdHash, String elementId, List<com.bimface.data.bean.PropertyGroup> propertyGroups)` 删除集成模型指定构件的属性, V2
`void`	`deleteIntegrateShare(Long integrateId)` 取消集成文件浏览分享链接
`com.bimface.bdfs.bean.dto.ProjectDTO`	`deleteProject(String hubId, String projectId)` 删除项目
`void`	`deleteSceneShare(Long sceneId)` 取消场景分享
`String`	`deleteSingleModelElementProperties(Long fileId, String elementId, List<com.bimface.data.bean.PropertyGroup> propertyGroups)` 删除构件基本属性组以外的属性, V2
`void`	`deleteTranslateShare(Long fileId)` 取消单个文件浏览分享链接
`String`	`deleteVersion(String projectId, List<String> fileIds)` 删除指定版本文件
`InputStream`	`download(Long fileId, String fileName)` 获取文件流
`String`	`downloadFiles(String projectId, List<String> fileItemIds)` 打包下载压缩文件
`com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean`	`exportIntegrate3DTilesDatabag(Long integrateId, String callback, Map<String,String> config)` 通过集成模型ID创建3DTiles数据包需要模型集成成功后调用
`com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean`	`exportIntegrateGltfDatabag(Long integrateId, String callback)` 通过集成模型ID创建gltf数据包
`com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean`	`exportTranslate3DTilesDatabag(Long fileId, String callback, Map<String,String> config)` 通过文件ID创建3DTiles数据包需要文件转换成功后调用
`com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean`	`exportTranslateGltfDatabag(Long fileId, String callback)` 通过文件ID导出gltf数据包
`com.bimface.bdfs.bean.dto.FileItemDTO`	`fileRename(String projectId, com.bimface.bdfs.bean.UpdateFileRequest updateFileRequest)` 文件重命名
`com.bimface.page.es.PagedList<com.bimface.api.bean.response.v1.FileTranslateResponseV1>`	`fileTranslateList(Long projectId, com.bimface.api.bean.request.v1.FileTranslateRequestV1 request)` 获取转换资源列表
`com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean`	`generateOfflineDatabag(OfflineDatabagRequest offlineDatabagRequest)` 构建离线数据包
`AccessTokenService`	`getAccessTokenService()`
`com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO>`	`getAllVersions(String projectId, String fileItemId, String path, Integer pageNo, Integer pageSize)` 获取所有版本文件信息
`com.bimface.bdfs.bean.dto.FileItemAppendFileDTO`	`getAppendFile(String projectId, String appendFileId)` 获取追加文件信息获取FileItemAppendFile
`List<com.bimface.data.bean.SearchAreaIdsResp>`	`getAreas(String requestBody)` 查询areaId
`List<com.bimface.data.bean.BusinessElementAssociation>`	`getAssociationsByBusinessId(String integrateId, String businessType, String businessId)` 根据业务ID查询对应构件
`List<com.bimface.data.bean.ElementBusinessAssociation>`	`getAssociationsByElementId(String integrateId, String elementId, String businessType, String businessFlag)` 根据构件ID查询对应业务挂接
`BakeService`	`getBakeService()`
`List<com.bimface.data.bean.ElementIdWithBoundingBox>`	`getBoundingBoxesByEleIds(Long integrateId, List<String> fileIdWithEleIdList)` 计算指定构件列表的包围盒列表获取每个构件对应的包围盒
`List<com.bimface.data.bean.Category>`	`getCategory(Long fileId)` 已过时。
`CategoryTreeService`	`getCategoryService()`
`List<com.bimface.data.bean.Tree.TreeNode>`	`getCategoryV2(Long fileId)` 已过时。
`com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO>`	`getChildrenFileItems(String projectId, FileItemQueryRequest fileItemQueryRequest)` 获取children列表（不包含itemSource）
`Object`	`getClashDetectiveResult(Long clashDetectiveId)` 获取碰撞检测的结果
`com.bimface.data.bean.ModelCompareChange`	`getCompareElementDiff(CompareElementRequest compareElementRequest)` 获取模型对比构件差异已过时，推荐使用： getModelCompareElementChange(java.lang.Long, java.lang.Long, java.lang.String, java.lang.Long, java.lang.String)
`com.bimface.api.bean.response.ModelCompareBean`	`getCompareInfo(Long compareId)` 获取模型对比状态
`List<com.bimface.data.bean.ModelCompareTree.SpecialtyNode>`	`getCompareResult(Long compareId)` 获取模型对比结果
`com.bimface.page.PagedList<com.bimface.api.bean.response.ModelCompareBean>`	`getCompares(com.bimface.api.bean.request.modelCompare.ModelCompareQueryRequest modelCompareQueryRequest)` 批量获取模型对比状态
`Credential`	`getCredential()`
`DownloadService`	`getDownloadService()`
`String`	`getDownloadUrl(Long fileId)` 获取文件下载链接，直接从OSS下载
`String`	`getDownloadUrl(Long fileId, String fileName)` 获取文件下载链接，直接从OSS下载
`String`	`getDownloadURl(String projectId, String fileItemId, String path, Integer expireTime)` 获取文件下载签名URL
`List`	`getDrawingFrames(Long fileId)` 获取图纸拆分结果
`com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean`	`getDrawingSplit(Long fileId)` 获取拆图状态图纸发起拆分后，可以通过该接口查询拆图状态
`DrawingSplitService`	`getDrawingSplitService()`
`String`	`getDwgPdfUrl(Long dwgFileId)` 获取DWG文件转换生成的pdf文件的url
`String`	`getDwgPreviewImageUrl(Long dwgFileId, String layoutName)` 获取DWG文件转换生成的预览图片的url
`List<String>`	`getElementIdsV2(Long fileId, QueryElementIdsRequest queryElementIdsRequest)` 按查询条件查询单模型构件ID 组，v2
`List<String>`	`getElementIdsV2(Long fileId, String specialty, String floor, String categoryId, String family, String familyType)` 已过时。
`com.bimface.data.bean.Property`	`getElementPropertyV2(Long fileId, List<String> elementIds)` 获取单文件的构件属性，v2
`com.bimface.data.bean.Property`	`getElementPropertyV2(Long fileId, List<String> elementIds, Boolean includeOverrides)` 获取单文件的构件属性，v2 支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
`List<String>`	`getElements(Long fileId, String categoryId, String family, String familyType)` 已过时。
`List<String>`	`getElements(Long fileId, String floor, String specialty, String categoryId, String family, String familyType)` 已过时。
`List<com.bimface.data.bean.SearchElementIdsResp>`	`getElements(String requestBody)` 查询符合条件的构件ID列表
`List<com.bimface.data.bean.SearchElementIdsResp>`	`getElements(String requestBody, Boolean includeOverrides)` 查询符合条件的构件ID列表支持查询模型属性重写后符合条件的构件ID列表，需要设置请求参数includeOverrides的值为true
`ElementService`	`getElementService()`
`Endpoint`	`getEndpoint()`
`com.bimface.file.bean.FileBean`	`getFile(Long fileId)` 根据文件id获取文件元信息
`InputStream`	`getFileDatabagContent(Long fileId)` 获取数据包下载流
`List<com.bimface.data.bean.DatabagResourceUrl>`	`getFileDatabagResource(Long fileId, Long integrateId, Long compareId, com.bimface.data.bean.DatabagResourceRequest databagResourceRequest)` 获取数据包资源，v2
`String`	`getFileDataBagRootUrl(Long fileId)` 获取文件的数据包根URL
`Long`	`getFileDatabagSize(Long fileId)` 获取数据包大小
`List<com.bimface.data.bean.Floor>`	`getFileFloors(Long fileId)` 已过时。
`List<com.bimface.data.bean.Floor>`	`getFileFloors(Long fileId, Boolean includeArea, Boolean includeRoom)` 获取楼层信息
`com.bimface.bdfs.bean.dto.FileItemDTO`	`getFileItemMeta(String projectId, String fileItemId, String path, Boolean withItemSource)` 获取文件信息
`String`	`getFileItemPathById(String projectId, String fileItemId)` 获取文件路径根据fileItemId获取fileItemPath
`com.bimface.bdfs.bean.UploadPolicyResponse`	`getFileItemPolicy(String projectId, String parentId, String parentPath, String name, String sourceId, Long maxLength)` 获取文件直传的policy凭证获取上传file的policy
`FileItemUploadStatusBean`	`getFileItemStatus(String projectId, String fileItemId, String path)` 获取文件状态
`com.bimface.file.bean.FileBean`	`getFileMetadata(Long fileId)` 已过时。
`com.bimface.bdfs.bean.UploadPolicyResponse`	`getFilePolicy(String projectId, String fileItemId, String path, String name, String sourceId, Long maxLength)` 获取新版本直传的policy凭证
`List<com.bimface.file.bean.FileBean>`	`getFiles(FileBatchQueryRequest request)` 批量查询文件元信息
`FileService`	`getFileService()`
`String`	`getFileThumbnailUrl(Long fileId, Integer size)` 获取缩略图url
`com.bimface.file.bean.FileUploadStatusBean`	`getFileUploadStatus(Long fileId)` 根据文件id获取文件上传状态信息
`com.bimface.data.bean.FloorTree`	`getFloorTree(Long integrateId)` 已过时。
`com.bimface.bdfs.bean.dto.FileItemDTO`	`getFolder(String projectId, String folderId, String path)` 获取文件夹信息
`String`	`getFolderPathById(String projectId, String folderId)` 根据folderId 获取path
`List<com.bimface.bdfs.bean.dto.HubDTO>`	`getHubList(String name, String tenantCode, String info, String dateTimeFrom, String dateTimeTo)` 获取hub列表
`com.bimface.bdfs.bean.dto.HubDTO`	`getHubMeta(Long hubId)` 获取Hub Meta信息
`com.bimface.api.bean.response.FileIntegrateBean`	`getIntegrate(Long integrateId)` 获取文件集成状态
`List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean>`	`getIntegrate3DTilesDatabags(Long integrateId)` 查询集成模型3DTiles数据包
`String`	`getIntegrate3dTilesDatabagUrl(Long integrateId, String databagVersion)` 指定集成ID，获取3DTiles数据包下载地址数据包版本；如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入3DTiles数据包的下载地址，即可下载得到对应模型的3DTiles数据包。
`List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean>`	`getIntegrateBakeDatabags(Long integrateId)` 查询集成模型bake数据包
`String`	`getIntegrateDatabagRootUrl(Long integrateId)` 获取集成数据包的根Url
`List<com.bimface.data.bean.Property>`	`getIntegrateElementBatch(Long integrateId, boolean includeOverrides, com.bimface.data.bean.IntegrateElementPropertyFilterRequest filterRequest)` 批量获取集成模型构件, v2
`com.bimface.data.bean.ElementsWithBoundingBox`	`getIntegrateElements(Long integrateId, String floor, String specialty, String categoryId, String family, String familyType)` 已过时。
`List<com.bimface.data.bean.IntegrateFileData>`	`getIntegrateFiles(Long integrateId)` 查询指定的集成模型内参与集成的子文件信息, v2
`List<com.bimface.data.bean.IntegrateFileData>`	`getIntegrateFiles(Long integrateId, Boolean includeDrawingSheet)` 查询指定的集成模型内参与集成的子文件信息, v2 支持将文件下转换出的图纸数量一起返回，需要设置请求参数includeDrawingSheet的值为true
`List<com.bimface.data.bean.Floor>`	`getIntegrateFloors(Long integrateId)` 已过时。
`List<com.bimface.data.bean.Floor>`	`getIntegrateFloors(Long integrateId, Boolean includeArea, Boolean includeRoom)` 获取集成模型楼层信息
`List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean>`	`getIntegrateGltfDatabags(Long integrateId)` 查询集成模型gltf数据包
`String`	`getIntegrateGltfDatabagUrl(Long integrateId, String databagVersion)` 指定集成ID，获取gltf数据包的下载链接如果只有一个数据包版本，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入gltf数据包的下载地址，即可下载得到对应模型的gltf数据包。
`com.bimface.data.bean.Area`	`getIntegrateModelArea(Long integrateId, String areaId)` 集成模型查询Area, v2
`List<com.bimface.data.bean.Area>`	`getIntegrateModelAreas(Long integrateId, String floorId)` 集成模型查询楼层对应Area列表, v2
`com.bimface.data.bean.Property`	`getIntegrateModelCommonElementProperties(Long integrateId, List<com.bimface.data.bean.FileIdHashWithElementIds> fileIdHashWithElementIds)` 集成模型获取构件属性
`com.bimface.data.bean.Property`	`getIntegrateModelCommonElementProperties(Long integrateId, List<com.bimface.data.bean.FileIdHashWithElementIds> fileIdHashWithElementIds, Boolean includeOverrides)` 集成模型获取构件属性支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
`com.bimface.data.bean.Property`	`getIntegrateModelElement(Long integrateId, String elementId)` 获取集成模型构件, v2
`com.bimface.data.bean.Property`	`getIntegrateModelElement(Long integrateId, String fileIdHash, String elementId)` 获取集成模型构件, v2
`com.bimface.data.bean.Property`	`getIntegrateModelElement(Long integrateId, String fileIdHash, String elementId, Boolean includeOverrides)` 获取集成模型构件, v2 支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
`com.bimface.data.bean.ElementsWithBoundingBox`	`getIntegrateModelElementIds(Long integrateId, QueryElementIdsRequest queryElementIdsRequest)` 获取集成模型构件ID组, v2
`com.bimface.data.bean.ElementsWithBoundingBox`	`getIntegrateModelElementIds(Long integrateId, String specialty, String roomId, String floor, String categoryId, String family, String familyType, String systemType)` 已过时。
`List<com.bimface.data.bean.MaterialInfo>`	`getIntegrateModelElementMaterials(Long integrateId, String fileIdHash, String elementId)` 获取集成模型构件材质, v2
`List<com.bimface.data.bean.FileViews>`	`getIntegrateModelFileViews(Long integrateId, String viewType)` 获取集成模型三维视点/二维视点, v2
`com.bimface.data.bean.Room`	`getIntegrateModelRoom(Long integrateId, String roomId)` 集成模型查询房间属性，v2
`List<com.bimface.data.bean.Room>`	`getIntegrateModelRooms(Long integrateId, String floorId)` 已过时。
`List<com.bimface.data.bean.Room>`	`getIntegrateModelRooms(Long integrateId, String floorId, String fildIdHash, String elementId, com.bimface.data.enums.ToleranceType roomToleranceZ, com.bimface.data.enums.ToleranceType roomToleranceXY)` 集成模型查询楼层对应房间列表, v2 当前支持两种方式查询房间列表：1）使用楼层ID查询属于给定楼层的房间列表；2）使用构件ID在空间中计算查询包含该构件的房间列表这两种方式只能取其一，楼层ID优先。
`List<com.bimface.data.bean.Room>`	`getIntegrateModelRooms(Long integrateId, String floorId, String elementId, com.bimface.data.enums.ToleranceType roomToleranceZ, com.bimface.data.enums.ToleranceType roomToleranceXY)` 集成模型查询楼层对应房间列表, v2 当前支持两种方式查询房间列表：1）使用楼层ID查询属于给定楼层的房间列表；2）使用构件ID在空间中计算查询包含该构件的房间列表这两种方式只能取其一，楼层ID优先。
`List<String>`	`getIntegrateModelSegmentElementIds(Long integrateId, String segmentId)` 获取流水段对应的所有构件id
`List<com.bimface.data.bean.SegmentGroupDto>`	`getIntegrateModelSegmentGroups(Long integrateId)` 获取集成模型中所有的流水段分组，v2
`List<com.bimface.data.bean.SegmentDto>`	`getIntegrateModelSegments(Long integrateId, String segmentGroupId)` 获取流水段分组中的所有流水段, v2
`List<com.bimface.data.bean.SegmentGroupDto>`	`getIntegrateModelSegmentTree(Long integrateId)` 获取集成模型的流水段树, v2
`com.bimface.data.bean.Tree`	`getIntegrateModelTree(Long integrateId, String treeType, List<String> desiredHierarchy, com.bimface.data.bean.IntegrationTreeOptionalRequestBody requestBody)` 获取集成模型分类树，v2
`String`	`getIntegrateModelViewToken(Long integrateId, String fileId)` 根据集成ID,文件ID获取viewToken，v2
`com.bimface.page.PagedList<com.bimface.api.bean.response.FileIntegrateDetailBean>`	`getIntegrates(com.bimface.api.bean.request.integrate.IntegrateQueryRequest integrateQueryRequest)` 批量获取文件集成状态
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`getIntegrateShare(Long integrateId)` 获取分享链接信息
`com.bimface.data.bean.Property`	`getIntegrationProperty(Long integrateId, Long fileId, String elementId)` 已过时。
`com.bimface.data.bean.MaterialOverrideSetVO`	`getMaterialOverrideSet(Long id)` 获取材质配置方案, v2
`List<com.bimface.data.bean.MEPSystem>`	`getMEPSystem(Long fileId, String systemCategory, String systemType)` 获取MEP系统信息
`com.bimface.data.bean.ModelCompareChange`	`getModelCompareElementChange(Long comparisonId, Long previousFileId, String previousElementId, Long followingFileId, String followingElementId)` 获取模型构件对比差异, v2
`com.bimface.data.bean.Pagination<com.bimface.data.bean.ModelCompareDiff>`	`getModelCompareResult(Long comparisonId, String family, String elementName, Integer page, Integer pageSize)` 分页获取模型对比结果, v2
`com.bimface.data.bean.Tree`	`getModelCompareTree(Long comparisonId)` 获取模型对比构件分类树, v2
`String`	`getMultipartSignedUrl(String projectId, com.bimface.bdfs.bean.dto.v1.multipartupload.MultipartSignedUrlRequest multipartSignedUrlRequest)` 获取分片上传url
`OfflineDatabagService`	`getOfflineDatabagService()`
`String`	`getOfflineDatabagUrl(Long fileId, Long integrateId, Long compareId, String databagVersion)` 获取离线数据包下载链接
`String`	`getOfflineDatabagUrl(OfflineDatabagRequest offlineDatabagRequest)` 已过时。
`String`	`getPaginationContextId()` 生成分页查询的ContextId
`com.bimface.bdfs.bean.dto.FileItemDTO`	`getParent(String projectId, String folderId)` 获取父文件夹
`com.bimface.file.bean.UploadPolicyBean`	`getPolicy(String name)` 获取上传凭证，用于直传到OSS
`com.bimface.file.bean.UploadPolicyBean`	`getPolicy(String name, String sourceId)` 获取上传凭证，用于直传到OSS
`List<com.bimface.bdfs.bean.dto.ProjectDTO>`	`getProjectList(String hubId, String name, Boolean useFuzzySearch)` 获取项目列表
`com.bimface.bdfs.bean.dto.ProjectDTO`	`getProjectMeta(String hubId, String projectId)` 获取项目信息
`com.bimface.bdfs.bean.dto.FileItemWithPathDTO`	`getProjectRootFolderInfo(String hubId, String projectId)` 获取项目根文件夹信息
`com.bimface.data.bean.Property`	`getProperty(Long fileId, String elementId)` 已过时。
`PropertyService`	`getPropertyService()`
`List<com.bimface.data.bean.PropertyValuesResp>`	`getPropertyValues(List<String> targetIds, String targetType, List<String> properties)` 查询指定模型构件属性的所有可能值仅支持查询单模型，即targetType可填：file
`List<com.bimface.data.bean.PropertyValuesResp>`	`getPropertyValues(List<String> targetIds, String targetType, List<String> properties, Boolean includeOverrides)` 查询指定模型构件属性的所有可能值仅支持查询单模型，即targetType可填：file 支持查询模型属性重写后构件的属性的所有可能值，需要设置请求参数includeOverrides的值为true
`List<String>`	`getRfaFamilyPropertyNames(Long rfaFileId)` 获取rfa文件族属性key列表, v2
`com.bimface.data.bean.RfaFamilyTypeProperty`	`getRfaFamilyTypeProperty(Long rfaFileId, String familyTypeGuid)` 获取rfa文件族类型属性列表, v2
`List<com.bimface.data.bean.RfaFamilyType>`	`getRfaFamilyTypes(Long rfaFileId)` rfa文件族类型列表, v2
`List<com.bimface.data.bean.SearchRoomIdsResp>`	`getRooms(String requestBody)` 查询roomId
`com.bimface.scene.bean.response.SceneInfoResponse`	`getScene(Long sceneId)` 获取场景
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`getSceneShare(Long sceneId)` 获取分享信息链接
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`getShareLink(String token)` 获取分享链接信息
`ShareLinkService`	`getShareLinkService()`
`SignatureService`	`getSignatureService()`
`com.bimface.data.bean.Area`	`getSingleModelArea(Long fileId, String areaId)` Rvt单模型查询 Area, v2
`List<com.bimface.data.bean.Area>`	`getSingleModelAreas(Long fileId, String floorId)` Rvt单模型查询楼层对应Area列表, v2
`List<com.bimface.data.bean.ElementIdWithName>`	`getSingleModelChildElementIds(Long fileId, String elementId)` 获取构件的子构件 id，v2
`com.bimface.data.bean.Tree`	`getSingleModelCustomizedTree(Long fileId, com.bimface.data.bean.FileTreeRequestBody requestBody)` 查询单模型自定义构件分类树
`List<com.bimface.data.bean.DrawingSheet>`	`getSingleModelDrawingSheets(Long fileId)` 已过时。
`List<com.bimface.data.bean.DrawingSheet>`	`getSingleModelDrawingSheets(Long fileId, String elementId)` 单模型查询drawingSheets信息, v2
`List<com.bimface.data.bean.Property>`	`getSingleModelElementsV2(Long fileId, List<String> elementIds)` 已过时。
`List<com.bimface.data.bean.Property>`	`getSingleModelElementsV2(Long fileId, List<String> elementIds, List<com.bimface.data.bean.ElementPropertyFilterRequest.GroupAndKeysPair> filter, boolean includeOverrides)` 根据构件 ID 批量获取单模型的单个构件，v2 支持查询模型属性重写后构件的属性，需要设置请求参数includeOverrides的值为true
`com.bimface.data.bean.Property`	`getSingleModelElementV2(Long fileId, String elementId)` 获取单模型构件，v2
`com.bimface.data.bean.Property`	`getSingleModelElementV2(Long fileId, String elementId, boolean includeOverrides)` 获取单模型构件，v2
`List<Map<String,Object>>`	`getSingleModelFileIdFloorsMapping(List<String> fileIds, Boolean includeArea, Boolean includeRoom)` 获取单模型文件 id 与楼层的映射关系，v2
`List<com.bimface.data.bean.Link>`	`getSingleModelLinks(Long fileId)` 单模型查询链接, v2
`List<com.bimface.data.bean.MaterialInfo>`	`getSingleModelMaterials(Long fileId, String elementId)` 获取单模型的构件材质，v2
`Object`	`getSingleModelModelInfo(Long fileId)` 获取模型数据包meta信息, v2
`com.bimface.data.bean.Room`	`getSingleModelRoom(Long fileId, String roomId)` Rvt单模型查询楼层对应房间, v2
`List<com.bimface.data.bean.Room>`	`getSingleModelRooms(Long fileId, String floorId)` 已过时。
`List<com.bimface.data.bean.Room>`	`getSingleModelRooms(Long fileId, String floorId, String elementId, com.bimface.data.enums.ToleranceType roomToleranceZ, com.bimface.data.enums.ToleranceType roomToleranceXY)` Rvt单模型查询楼层对应房间列表，v2 当前支持两种方式查询房间列表：1）使用楼层ID查询属于给定楼层的房间列表；2）使用构件ID在空间中计算查询包含该构件的房间列表这两种方式只能取其一，楼层ID优先。
`List<com.bimface.data.bean.Tree.TreeNode>`	`getSingleModelTreeV2(Long fileId, com.bimface.data.bean.FileTreeRequestBody requestBody)` 查询单模型获取构件分类树，v2
`List<com.bimface.data.bean.View>`	`getSingleModelViews(Long fileId)` 查询单模型三维视点信息，v2
`com.bimface.data.bean.SpecialtyTree`	`getSpecialtyTree(Long integrateId)` 已过时。
`com.bimface.file.bean.SupportFileBean`	`getSupport()` 获取支持的文件格式及文件大小
`com.bimface.api.bean.response.FileTranslateBean`	`getTranslate(Long fileId)` 获取文件转换状态
`List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean>`	`getTranslate3DTilesDatabags(Long fileId)` 查询文件的3DTiles数据包
`String`	`getTranslate3dTilesDatabagUrl(Long fileId, String databagVersion)` 指定文件ID，获取3DTiles数据包下载地址数据包版本；如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入3DTiles数据包的下载地址，即可下载得到对应模型的3DTiles数据包。
`List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean>`	`getTranslateBakeDatabags(Long fileId)` 查询文件bake数据包
`List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean>`	`getTranslateGltfDatabag(Long fileId)` 查询gltf数据包信息
`String`	`getTranslateGltfDatabagUrl(Long fileId, String databagVersion)` 指定文件ID，获取gltf数据包的下载链接如果只有一个数据包版本，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入gltf数据包的下载地址，即可下载得到对应模型的gltf数据包。
`com.bimface.page.PagedList<com.bimface.api.bean.response.FileTranslateDetailBean>`	`getTranslates(com.bimface.api.bean.request.translate.TranslateQueryRequest translateQueryRequest)` 批量获取文件转换状态
`TranslateService`	`getTranslateService()`
`com.bimface.api.bean.compatible.response.ShareLinkBean`	`getTranslateShare(Long fileId)` 获取分享链接信息
`com.bimface.bdfs.bean.dto.FileItemDTO`	`getVersion(String projectId, String fileId, Boolean withFileSource)` 获取指定版本文件信息
`String`	`getVersionSignedUrl(String projectId, String fileId, Integer expireTime)` 下载指定版本文件
`String`	`getViewTokenByClashDetectiveId(Long clashDetectiveId)` 获取viewToken, 用于碰撞检测
`String`	`getViewTokenByCompareId(Long compareId)` 获取模型对比viewToken, 用于模型预览的凭证
`String`	`getViewTokenByFileId(Long fileId)` 获取viewToken, 用于模型预览的凭证
`String`	`getViewTokenByIntegrateId(Long integrateId)` 获取集成模型viewToken, 用于模型预览的凭证
`String`	`getViewTokenBySceneId(Long sceneId)` 获取viewToken，用于场景预览
`ViewTokenService`	`getViewTokenService()`
`com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadDTO`	`initMultipartUpload(String projectId, com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadRequest initMultipartUploadRequest)` 创建分片上传任务
`com.bimface.api.bean.response.FileIntegrateBean`	`integrate(com.bimface.api.bean.request.integrate.FileIntegrateRequest request)` 发起文件集成
`com.bimface.api.bean.response.FileIntegrateBean`	`integrate2Bimtiles(com.bimface.api.bean.request.integrate.FileIntegrateRequest request)` 发起模型集成
`com.bimface.api.bean.response.FileIntegrateBean`	`modify(Long integrateId, String name)` 更新集成信息
`List<com.bimface.bdfs.bean.dto.FileItemDTO>`	`moveFile(String projectId, com.bimface.bdfs.bean.MoveFileRequest moveFileRequest)` 移动文件位置
`com.bimface.data.bean.Pagination<com.bimface.data.bean.DrawingCompareDiff>`	`pageGetDrawingCompareResult(Long comparisonId, String layer, Integer page, Integer pageSize)` 分页获取图纸对比结果
`com.bimface.file.bean.AppendFileBean`	`queryAppendFile(Long appendFileId)` 查询追加文件信息
`com.bimface.api.bean.response.clashDetective.ClashDetectiveResponse`	`queryClashDetective(Long clashDetectiveId)` 获取碰撞检测状态
`com.bimface.api.bean.response.clashDetective.ClashDetectiveList`	`queryClashDetectiveByModelId(Long fileId, Long integrateId)` 根据模型ID查询碰撞检测ID列表
`List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean>`	`queryCompareOfflineDatabag(Long compareId)` 查询离线数据包
`List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean>`	`queryIntegrateOfflineDatabag(Long integrateId)` 查询离线数据包
`List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean>`	`queryOfflineDatabag(OfflineDatabagRequest offlineDatabagRequest)` 已过时。
`List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean>`	`queryTranslateOfflineDatabag(Long fileId)` 查询离线数据包
`com.bimface.page.PagedList<com.bimface.api.bean.compatible.response.ShareLinkBean>`	`shares(Integer pageNo, Integer pageSize)` 获取分享列表
`com.bimface.api.bean.response.FileTranslateBean`	`translate(com.bimface.api.bean.request.translate.FileTranslateRequest fileTranslateRequest)` 发起文件转换
`com.bimface.api.bean.response.FileTranslateBean`	`translate(Long fileId)` 发起文件转换
`com.bimface.api.bean.response.FileTranslateBean`	`translate(Long fileId, String callback)` 发起文件转换
`com.bimface.api.bean.response.FileTranslateBean`	`translate2Bimtiles(com.bimface.api.bean.request.translate.FileTranslateRequest request)` 发起模型转换
`com.bimface.bdfs.bean.dto.FileItemDTO`	`updateFolder(String projectId, com.bimface.bdfs.bean.UpdateFolderRequest updateFolderReq)` 文件夹重命名根据folderId(path)更新文件夹
`String`	`updateIntegrateModelElementProperties(Long integrateId, String fileIdHash, String elementId, List<com.bimface.data.bean.PropertyGroup> propertyGroups)` 修改集成模型指定构件的属性, V2
`com.bimface.bdfs.bean.dto.ProjectDTO`	`updateProject(String hubId, String projectId, com.bimface.bdfs.bean.UpdateProjectRequest updateProjectReq)` 更新项目信息
`String`	`updateScene(Long sceneId, com.bimface.scene.bean.CreateSceneRequest sceneInfo)` 更新场景
`String`	`updateSingleModelElementProperties(Long fileId, String elementId, List<com.bimface.data.bean.PropertyGroup> propertyGroups)` 修改（包含添加和更新）构件基本属性组以外的属性, V2
`com.bimface.file.bean.FileBean`	`upload(FileUploadRequest fileUploadRequest)` 上传文件
`com.bimface.file.bean.FileBean`	`upload(String name, Long contentLength, InputStream inputStream)` 上传文件,文件流方式
`com.bimface.file.bean.FileBean`	`upload(String name, String url)` 上传文件,URL方式
`com.bimface.file.bean.FileBean`	`upload(String name, String sourceId, Long contentLength, InputStream inputStream)` 上传文件,文件流方式
`com.bimface.file.bean.FileBean`	`upload(String name, String sourceId, String url)` 上传文件,URL方式
`com.bimface.file.bean.AppendFileBean`	`uploadAppendFile(InputStream inputStream, Long appendFileId)` 追加上传
`com.bimface.file.bean.AppendFileBean`	`uploadAppendFile(InputStream inputStream, Long appendFileId, Long length, Long position)` 追加上传
`com.bimface.file.bean.FileBean`	`uploadByPolicy(String name, Long contentLength, InputStream inputStream)` 基于阿里云的policy机制，将文件直接上传阿里云分两步：1.
`com.bimface.file.bean.FileBean`	`uploadByPolicy(String name, String sourceId, Long contentLength, InputStream inputStream)` 基于阿里云的policy机制，将文件直接上传阿里云分两步：1.
`com.bimface.bdfs.bean.dto.FileItemDTO`	`uploadByUrl(String projectId, String parentId, String parentPath, String name, String sourceId, String url, String etag, Long maxLength)` 指定外部文件url方式上传
`com.bimface.bdfs.bean.dto.FileItemDTO`	`uploadFileItem(InputStream fileIn, String projectId, String parentId, String parentPath, String name, Long length, String sourceId)` 上传文件流
`boolean`	`validateSignature(String signature, String id, String status, String nonce)` 验证签名, 接收回调时使用

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

BimfaceClient

public BimfaceClient(String appKey,
                     String appSecret)

构造BimfaceClient对象

参数:: appKey - AppKey; appSecret - AppSecret

BimfaceClient

public BimfaceClient(String appKey,
                     String appSecret,
                     Config config)

构造BimfaceClient对象

参数:: appKey - AppKey; appSecret - AppSecret; config - 参数配置

BimfaceClient

public BimfaceClient(String appKey,
                     String appSecret,
                     Endpoint endpoint)

构造BimfaceClient对象

参数:: appKey - AppKey; appSecret - AppSecret; endpoint - 参数配置

BimfaceClient

public BimfaceClient(String appKey,
                     String appSecret,
                     Endpoint endpoint,
                     Config config)

构造BimfaceClient对象

参数:: appKey - AppKey; appSecret - AppSecret; endpoint - API调用地址入口; config - 参数配置

BimfaceClient

public BimfaceClient(String appKey,
                     String appSecret,
                     Endpoint endpoint,
                     Config config,
                     AccessTokenStorage accessTokenStorage)

构造BimfaceClient对象

参数:: appKey - AppKey; appSecret - AppSecret; endpoint - API调用地址入口; config - 参数配置; accessTokenStorage - AccessToken的缓存方式

方法详细资料

getSupport
```
public com.bimface.file.bean.SupportFileBean getSupport()
                                                 throws com.bimface.exception.BimfaceException
```
获取支持的文件格式及文件大小

返回:

文件后缀名数组 SupportFileBean

抛出:

com.bimface.exception.BimfaceException - BimfaceException

upload

public com.bimface.file.bean.FileBean upload(FileUploadRequest fileUploadRequest)
                                      throws com.bimface.exception.BimfaceException

上传文件

参数:: fileUploadRequest - FileUploadRequest
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

upload

public com.bimface.file.bean.FileBean upload(String name,
                                             Long contentLength,
                                             InputStream inputStream)
                                      throws com.bimface.exception.BimfaceException

上传文件,文件流方式

参数:: name - 文件名; contentLength - 文件长度; inputStream - 文件流
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

upload

public com.bimface.file.bean.FileBean upload(String name,
                                             String sourceId,
                                             Long contentLength,
                                             InputStream inputStream)
                                      throws com.bimface.exception.BimfaceException

上传文件,文件流方式

参数:: name - 文件名; sourceId - 上传源文件Id; contentLength - 文件长度; inputStream - 文件流
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

upload

public com.bimface.file.bean.FileBean upload(String name,
                                             String url)
                                      throws com.bimface.exception.BimfaceException

上传文件,URL方式

参数:: name - 文件名; url - 文件下载地址
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

upload

public com.bimface.file.bean.FileBean upload(String name,
                                             String sourceId,
                                             String url)
                                      throws com.bimface.exception.BimfaceException

上传文件,URL方式

参数:: name - 文件名; sourceId - 上传源文件Id; url - 文件下载地址
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileMetadata
```
@Deprecated
public com.bimface.file.bean.FileBean getFileMetadata(Long fileId)
                                                            throws com.bimface.exception.BimfaceException
```
已过时。

根据文件id获取文件元信息已过时，推荐使用： getFile(java.lang.Long)

参数:

fileId - 文件Id

返回:

FileBean

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getFile

public com.bimface.file.bean.FileBean getFile(Long fileId)
                                       throws com.bimface.exception.BimfaceException

根据文件id获取文件元信息

参数:: fileId - 文件Id
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFiles

public List<com.bimface.file.bean.FileBean> getFiles(FileBatchQueryRequest request)
                                              throws com.bimface.exception.BimfaceException

批量查询文件元信息

参数:: request - FileBatchQueryRequest
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileUploadStatus

public com.bimface.file.bean.FileUploadStatusBean getFileUploadStatus(Long fileId)
                                                               throws com.bimface.exception.BimfaceException

根据文件id获取文件上传状态信息

参数:: fileId - 文件Id
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteFile
```
public void deleteFile(Long fileId)
                throws com.bimface.exception.BimfaceException
```
删除文件

参数:

fileId - 文件id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getPolicy

public com.bimface.file.bean.UploadPolicyBean getPolicy(String name)
                                                 throws com.bimface.exception.BimfaceException

获取上传凭证，用于直传到OSS

参数:: name - 文件名
返回:: UploadPolicyBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getPolicy

public com.bimface.file.bean.UploadPolicyBean getPolicy(String name,
                                                        String sourceId)
                                                 throws com.bimface.exception.BimfaceException

获取上传凭证，用于直传到OSS

参数:: name - 文件名; sourceId - 上传源文件Id
返回:: UploadPolicyBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

uploadByPolicy

public com.bimface.file.bean.FileBean uploadByPolicy(String name,
                                                     Long contentLength,
                                                     InputStream inputStream)
                                              throws com.bimface.exception.BimfaceException

基于阿里云的policy机制，将文件直接上传阿里云分两步：1. 调用bimface接口取得policy；2. 用policy将文件直接上传阿里云

参数:: name - 文件名; contentLength - 文件内容长度; inputStream - 文件流
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

uploadByPolicy

public com.bimface.file.bean.FileBean uploadByPolicy(String name,
                                                     String sourceId,
                                                     Long contentLength,
                                                     InputStream inputStream)
                                              throws com.bimface.exception.BimfaceException

基于阿里云的policy机制，将文件直接上传阿里云分两步：1. 调用bimface接口取得policy；2. 用policy将文件直接上传阿里云

参数:: name - 文件名; sourceId - 上传源文件Id; contentLength - 文件内容长度; inputStream - 文件流
返回:: FileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getDownloadUrl
```
public String getDownloadUrl(Long fileId)
                      throws com.bimface.exception.BimfaceException
```
获取文件下载链接，直接从OSS下载

参数:

fileId - 文件ID

返回:

String 文件下载链接

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getDownloadUrl

public String getDownloadUrl(Long fileId,
                             String fileName)
                      throws com.bimface.exception.BimfaceException

获取文件下载链接，直接从OSS下载

参数:: fileId - 文件ID; fileName - 文件名
返回:: String 文件下载链接
抛出:: com.bimface.exception.BimfaceException - BimfaceException

download

public InputStream download(Long fileId,
                            String fileName)
                     throws com.bimface.exception.BimfaceException

获取文件流

参数:: fileId - 文件id; fileName - 文件名
返回:: InputStream 文件流
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getHubList

public List<com.bimface.bdfs.bean.dto.HubDTO> getHubList(String name,
                                                         String tenantCode,
                                                         String info,
                                                         String dateTimeFrom,
                                                         String dateTimeTo)
                                                  throws com.bimface.exception.BimfaceException

获取hub列表

参数:: name - hub名称; tenantCode - 租户标识; info - 描述信息; dateTimeFrom - 开始时间; dateTimeTo - 结束时间
返回:: HubDTO 项目hub列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getHubMeta

public com.bimface.bdfs.bean.dto.HubDTO getHubMeta(Long hubId)
                                            throws com.bimface.exception.BimfaceException

获取Hub Meta信息

参数:: hubId - hubId
返回:: 单个Hub
抛出:: com.bimface.exception.BimfaceException

createProject

public com.bimface.bdfs.bean.dto.ProjectDTO createProject(String hubId,
                                                          ProjectCreateRequest request)
                                                   throws com.bimface.exception.BimfaceException

创建项目

参数:: hubId - hubId; request - 项目目创建请求
返回:: ProjectDTO 项目
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getProjectList

public List<com.bimface.bdfs.bean.dto.ProjectDTO> getProjectList(String hubId,
                                                                 String name,
                                                                 Boolean useFuzzySearch)
                                                          throws com.bimface.exception.BimfaceException

获取项目列表

参数:: hubId - hubId; name - 项目名称; useFuzzySearch - 是否使用模糊查询
返回:: ProjectDTO 项目列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getProjectMeta

public com.bimface.bdfs.bean.dto.ProjectDTO getProjectMeta(String hubId,
                                                           String projectId)
                                                    throws com.bimface.exception.BimfaceException

获取项目信息

参数:: hubId - hubId; projectId - 项目Id
返回:
抛出:: com.bimface.exception.BimfaceException

deleteProject

public com.bimface.bdfs.bean.dto.ProjectDTO deleteProject(String hubId,
                                                          String projectId)
                                                   throws com.bimface.exception.BimfaceException

删除项目

参数:: hubId - hubId; projectId - 项目Id
返回:
抛出:: com.bimface.exception.BimfaceException

updateProject

public com.bimface.bdfs.bean.dto.ProjectDTO updateProject(String hubId,
                                                          String projectId,
                                                          com.bimface.bdfs.bean.UpdateProjectRequest updateProjectReq)
                                                   throws com.bimface.exception.BimfaceException

更新项目信息

参数:: hubId - hubId; projectId - 项目Id; updateProjectReq - 更新项目信息请求体
返回:
抛出:: com.bimface.exception.BimfaceException

getProjectRootFolderInfo

public com.bimface.bdfs.bean.dto.FileItemWithPathDTO getProjectRootFolderInfo(String hubId,
                                                                              String projectId)
                                                                       throws com.bimface.exception.BimfaceException

获取项目根文件夹信息

参数:: hubId - hubId; projectId - 项目Id
返回:
抛出:: com.bimface.exception.BimfaceException

createFolder

public com.bimface.bdfs.bean.dto.FileItemDTO createFolder(String projectId,
                                                          CreateFolderRequest createFolderRequest)
                                                   throws com.bimface.exception.BimfaceException

指定目录创建文件夹

参数:: projectId - 项目id; createFolderRequest - 文件夹创建请求
返回:: FileItemDTO 文件项
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFolder

public com.bimface.bdfs.bean.dto.FileItemDTO getFolder(String projectId,
                                                       String folderId,
                                                       String path)
                                                throws com.bimface.exception.BimfaceException

获取文件夹信息

抛出:: com.bimface.exception.BimfaceException

getChildrenFileItems

public com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO> getChildrenFileItems(String projectId,
                                                                                              FileItemQueryRequest fileItemQueryRequest)
                                                                                       throws com.bimface.exception.BimfaceException

获取children列表（不包含itemSource）

参数:: projectId - 项目ID; fileItemQueryRequest - 请求body
返回:: FileItemDTO 文件项
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFolderPathById

public String getFolderPathById(String projectId,
                                String folderId)
                         throws com.bimface.exception.BimfaceException

根据folderId 获取path

参数:: projectId - 项目ID; folderId - 文件夹ID
返回:: String 文件路径
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getParent

public com.bimface.bdfs.bean.dto.FileItemDTO getParent(String projectId,
                                                       String folderId)
                                                throws com.bimface.exception.BimfaceException

获取父文件夹

参数:: projectId -; folderId -
返回:
抛出:: com.bimface.exception.BimfaceException

updateFolder

public com.bimface.bdfs.bean.dto.FileItemDTO updateFolder(String projectId,
                                                          com.bimface.bdfs.bean.UpdateFolderRequest updateFolderReq)
                                                   throws com.bimface.exception.BimfaceException

文件夹重命名根据folderId(path)更新文件夹

参数:: projectId - 项目id; updateFolderReq - 更新文件夹请求体
返回:
抛出:: com.bimface.exception.BimfaceException

deleteFolder
```
public String deleteFolder(String projectId,
                           String folderId,
                           String path)
                    throws com.bimface.exception.BimfaceException
```
删除文件夹根据folderId(path)删除文件夹

参数:

projectId - 项目id

folderId - 文件夹id(folderId和path,必须二选一填入)

path - 文件夹路径,使用URL编码（UTF-8）,最多256个字符(folderId和path,必须二选一填入)

返回:

抛出:

com.bimface.exception.BimfaceException

uploadFileItem

public com.bimface.bdfs.bean.dto.FileItemDTO uploadFileItem(InputStream fileIn,
                                                            String projectId,
                                                            String parentId,
                                                            String parentPath,
                                                            String name,
                                                            Long length,
                                                            String sourceId)
                                                     throws com.bimface.exception.BimfaceException

上传文件流

参数:: fileIn - 文件流; projectId - 项目id; parentId - 父文件夹id; parentPath - 父文件夹路径; name - 文件名称; length - 文件大小; sourceId - 源文件id
返回:: FileItemDTO 文件项
抛出:: com.bimface.exception.BimfaceException - BimfaceException

uploadByUrl

public com.bimface.bdfs.bean.dto.FileItemDTO uploadByUrl(String projectId,
                                                         String parentId,
                                                         String parentPath,
                                                         String name,
                                                         String sourceId,
                                                         String url,
                                                         String etag,
                                                         Long maxLength)
                                                  throws com.bimface.exception.BimfaceException

指定外部文件url方式上传

参数:: projectId - 项目ID; parentId - 父文件夹Id; parentPath - 父文件夹路径; name - 文件名称; sourceId - 调用方的文件源ID，不能重复; url - sourceUrl; etag - 文件etag; maxLength - maxLength
返回:
抛出:: com.bimface.exception.BimfaceException

createAppendFile

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO createAppendFile(String projectId,
                                                                        String parentId,
                                                                        String parentPath,
                                                                        String name,
                                                                        Long length,
                                                                        String sourceId)
                                                                 throws com.bimface.exception.BimfaceException

创建追加文件

参数:: projectId - 项目ID; parentId - 父文件夹Id; parentPath - 父文件夹路径; name - 文件名称; length - 文件流的长度; sourceId - 调用方的文件源ID，不能重复
返回:
抛出:: com.bimface.exception.BimfaceException

getAppendFile

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO getAppendFile(String projectId,
                                                                     String appendFileId)
                                                              throws com.bimface.exception.BimfaceException

获取追加文件信息获取FileItemAppendFile

参数:: projectId - 项目ID; appendFileId - 追加上传ID
返回:
抛出:: com.bimface.exception.BimfaceException

appendUpload

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO appendUpload(InputStream fileIn,
                                                                    String projectId,
                                                                    String appendFileId,
                                                                    String position)
                                                             throws com.bimface.exception.BimfaceException

追加上传文件

参数:: projectId - 项目ID; appendFileId - 父文件夹Id; position - 父文件夹路径
返回:
抛出:: com.bimface.exception.BimfaceException

copyFile

public List<com.bimface.bdfs.bean.dto.FileItemDTO> copyFile(String projectId,
                                                            com.bimface.bdfs.bean.CopyFileRequest copyFileRequest)
                                                     throws com.bimface.exception.BimfaceException

复制文件

参数:: projectId - 项目ID; copyFileRequest - 复制文件请求体
返回:
抛出:: com.bimface.exception.BimfaceException

getFileItemPolicy

public com.bimface.bdfs.bean.UploadPolicyResponse getFileItemPolicy(String projectId,
                                                                    String parentId,
                                                                    String parentPath,
                                                                    String name,
                                                                    String sourceId,
                                                                    Long maxLength)
                                                             throws com.bimface.exception.BimfaceException

获取文件直传的policy凭证获取上传file的policy

参数:: projectId - 项目ID; parentId - 父文件ID; parentPath - 父文件路径; name - 文件名称; sourceId - 调用方的文件源ID; maxLength - 文件流的长度
返回:
抛出:: com.bimface.exception.BimfaceException

getFileItemMeta

public com.bimface.bdfs.bean.dto.FileItemDTO getFileItemMeta(String projectId,
                                                             String fileItemId,
                                                             String path,
                                                             Boolean withItemSource)
                                                      throws com.bimface.exception.BimfaceException

获取文件信息

参数:: projectId - 项目id; fileItemId - 文件id; path - 文件路径; withItemSource - 是否携带fileItemSource信息
返回:: FileItemDTO 文件项
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileItemStatus

public FileItemUploadStatusBean getFileItemStatus(String projectId,
                                                  String fileItemId,
                                                  String path)
                                           throws com.bimface.exception.BimfaceException

获取文件状态

参数:: projectId - 项目id; fileItemId - 文件id; path - 文件路径
返回:: FileItemUploadStatusBean 文件上传状态
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getDownloadURl

public String getDownloadURl(String projectId,
                             String fileItemId,
                             String path,
                             Integer expireTime)
                      throws com.bimface.exception.BimfaceException

获取文件下载签名URL

参数:: projectId - 项目id; fileItemId - 文件id; path - 文件路径; expireTime - 过期时间
返回:: String 文件下载地址
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileItemPathById

public String getFileItemPathById(String projectId,
                                  String fileItemId)
                           throws com.bimface.exception.BimfaceException

获取文件路径根据fileItemId获取fileItemPath

参数:: projectId - 项目ID; fileItemId - 文件ID
返回:
抛出:: com.bimface.exception.BimfaceException

downloadFiles

public String downloadFiles(String projectId,
                            List<String> fileItemIds)
                     throws com.bimface.exception.BimfaceException

打包下载压缩文件

参数:: projectId - 项目ID; fileItemIds - 文件ID
返回:
抛出:: com.bimface.exception.BimfaceException

moveFile

public List<com.bimface.bdfs.bean.dto.FileItemDTO> moveFile(String projectId,
                                                            com.bimface.bdfs.bean.MoveFileRequest moveFileRequest)
                                                     throws com.bimface.exception.BimfaceException

移动文件位置

参数:: projectId - 项目ID; moveFileRequest - 移动文件请求体
返回:
抛出:: com.bimface.exception.BimfaceException

fileRename

public com.bimface.bdfs.bean.dto.FileItemDTO fileRename(String projectId,
                                                        com.bimface.bdfs.bean.UpdateFileRequest updateFileRequest)
                                                 throws com.bimface.exception.BimfaceException

文件重命名

参数:: projectId - 项目ID; updateFileRequest - 更新文件请求体
返回:
抛出:: com.bimface.exception.BimfaceException

batchDeleteFileItems

public void batchDeleteFileItems(String projectId,
                                 List<String> fileItemIds)
                          throws com.bimface.exception.BimfaceException

批量删除文件

参数:: projectId - 项目id; fileItemIds - 文件id集合
抛出:: com.bimface.exception.BimfaceException - BimfaceException

initMultipartUpload

public com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadDTO initMultipartUpload(String projectId,
                                                                                               com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadRequest initMultipartUploadRequest)
                                                                                        throws com.bimface.exception.BimfaceException

创建分片上传任务

参数:: projectId - 项目id; initMultipartUploadRequest - 初始化分片上传的请求体
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getMultipartSignedUrl

public String getMultipartSignedUrl(String projectId,
                                    com.bimface.bdfs.bean.dto.v1.multipartupload.MultipartSignedUrlRequest multipartSignedUrlRequest)
                             throws com.bimface.exception.BimfaceException

获取分片上传url

参数:: projectId - 项目 id; multipartSignedUrlRequest - 获取分片的 signedUrl的请求体
返回:: 生成的 signed url
抛出:: com.bimface.exception.BimfaceException

completeMultiPartUpload

public com.bimface.bdfs.bean.dto.v1.FileItemDTOV1 completeMultiPartUpload(String projectId,
                                                                          com.bimface.bdfs.bean.dto.v1.multipartupload.CompleteMultipartUploadRequest completeMultipartUploadRequest)
                                                                   throws com.bimface.exception.BimfaceException

合并分片生成文件

参数:: projectId - 项目 id; completeMultipartUploadRequest - 完成分片上传的请求体
返回:: 返回生成的 FileItem
抛出:: com.bimface.exception.BimfaceException

abortMultiPartUpload

public String abortMultiPartUpload(String projectId,
                                   com.bimface.bdfs.bean.dto.v1.multipartupload.AbortMultipartUploadRequest abortMultipartUploadRequest)
                            throws com.bimface.exception.BimfaceException

终止分片上传任务

参数:: projectId - 项目 id; abortMultipartUploadRequest - 终止分片上传的请求体
返回:: 提示信息
抛出:: com.bimface.exception.BimfaceException

getAllVersions

public com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO> getAllVersions(String projectId,
                                                                                        String fileItemId,
                                                                                        String path,
                                                                                        Integer pageNo,
                                                                                        Integer pageSize)
                                                                                 throws com.bimface.exception.BimfaceException

获取所有版本文件信息

参数:: projectId - 项目ID; fileItemId - 文件Id; path - 文件路径; pageNo - 开始页码; pageSize - 每页大小
返回:: PagedList
抛出:: com.bimface.exception.BimfaceException

createVersion

public com.bimface.bdfs.bean.dto.FileItemDTO createVersion(InputStream fileIn,
                                                           String projectId,
                                                           String fileItemId,
                                                           String path,
                                                           String name,
                                                           Long length,
                                                           String sourceId)
                                                    throws com.bimface.exception.BimfaceException

上传版本文件

参数:: fileIn - 文件流; projectId - 项目ID; fileItemId - 文件Id; path - 文件路径; name - 文件名称; length - 文件长度; sourceId - 调用方的文件源ID，不能重复
返回:: FileItemDTO
抛出:: com.bimface.exception.BimfaceException

getFilePolicy

public com.bimface.bdfs.bean.UploadPolicyResponse getFilePolicy(String projectId,
                                                                String fileItemId,
                                                                String path,
                                                                String name,
                                                                String sourceId,
                                                                Long maxLength)
                                                         throws com.bimface.exception.BimfaceException

获取新版本直传的policy凭证

参数:: projectId - 项目ID; fileItemId - 文件Id; path - 文件路径; name - 文件名称; sourceId - 调用方的文件源ID，不能重复; maxLength - 文件流的长度
返回:: UploadPolicyResponse
抛出:: com.bimface.exception.BimfaceException

getVersion

public com.bimface.bdfs.bean.dto.FileItemDTO getVersion(String projectId,
                                                        String fileId,
                                                        Boolean withFileSource)
                                                 throws com.bimface.exception.BimfaceException

获取指定版本文件信息

参数:: projectId - 项目ID; fileId - 文件版本Id; withFileSource - 是否携带itemSource
返回:: FileItemDTO
抛出:: com.bimface.exception.BimfaceException

getVersionSignedUrl

public String getVersionSignedUrl(String projectId,
                                  String fileId,
                                  Integer expireTime)
                           throws com.bimface.exception.BimfaceException

下载指定版本文件

参数:: projectId - 项目ID; fileId - 文件版本Id; expireTime - 有限期，默认3600s
返回:: String
抛出:: com.bimface.exception.BimfaceException

deleteVersion

public String deleteVersion(String projectId,
                            List<String> fileIds)
                     throws com.bimface.exception.BimfaceException

删除指定版本文件

参数:: projectId - 项目ID; fileIds - 文件版本Id
返回:: String
抛出:: com.bimface.exception.BimfaceException

getElements

@Deprecated
public List<String> getElements(Long fileId,
                                             String categoryId,
                                             String family,
                                             String familyType)
                                      throws com.bimface.exception.BimfaceException

已过时。

通过条件查询构件ID组已过时，推荐使用： getElementIdsV2(java.lang.Long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

参数:: fileId - 文件ID; categoryId - 构件类型ID; family - 族名称; familyType - 族类型
返回:: List<String> 文件列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getElements

@Deprecated
public List<String> getElements(Long fileId,
                                             String floor,
                                             String specialty,
                                             String categoryId,
                                             String family,
                                             String familyType)
                                      throws com.bimface.exception.BimfaceException

已过时。

通过条件查询构件ID组已过时，推荐使用： getElementIdsV2(java.lang.Long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

参数:: fileId - 文件ID; floor - 楼层; specialty - 专业; categoryId - 构件类型ID; family - 族名称; familyType - 族类型
返回:: List<String>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateElements

@Deprecated
public com.bimface.data.bean.ElementsWithBoundingBox getIntegrateElements(Long integrateId,
                                                                                       String floor,
                                                                                       String specialty,
                                                                                       String categoryId,
                                                                                       String family,
                                                                                       String familyType)
                                                                                throws com.bimface.exception.BimfaceException

已过时。

参数:: integrateId - 集成id; floor - 楼层; specialty - 专业; categoryId - 分类id; family - 族; familyType - 族类型
返回:: ElementsWithBoundingBox
抛出:: com.bimface.exception.BimfaceException - BimfaceException

translate

public com.bimface.api.bean.response.FileTranslateBean translate(com.bimface.api.bean.request.translate.FileTranslateRequest fileTranslateRequest)
                                                          throws com.bimface.exception.BimfaceException

发起文件转换

参数:: fileTranslateRequest - FileTranslateRequest
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

translate

public com.bimface.api.bean.response.FileTranslateBean translate(Long fileId)
                                                          throws com.bimface.exception.BimfaceException

发起文件转换

参数:: fileId - 文件id
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

translate

public com.bimface.api.bean.response.FileTranslateBean translate(Long fileId,
                                                                 String callback)
                                                          throws com.bimface.exception.BimfaceException

发起文件转换

参数:: fileId - 文件id; callback - 回调地址以http或者https开头
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslate

public com.bimface.api.bean.response.FileTranslateBean getTranslate(Long fileId)
                                                             throws com.bimface.exception.BimfaceException

获取文件转换状态

参数:: fileId - 文件id
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslates

public com.bimface.page.PagedList<com.bimface.api.bean.response.FileTranslateDetailBean> getTranslates(com.bimface.api.bean.request.translate.TranslateQueryRequest translateQueryRequest)
                                                                                                throws com.bimface.exception.BimfaceException

批量获取文件转换状态

参数:: translateQueryRequest - TranslateQueryRequest
返回:: PagedList<FileTranslateDetailBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

translate2Bimtiles

public com.bimface.api.bean.response.FileTranslateBean translate2Bimtiles(com.bimface.api.bean.request.translate.FileTranslateRequest request)
                                                                   throws com.bimface.exception.BimfaceException

发起模型转换

参数:: request - FileTranslateRequest请求体
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

fileTranslateList

public com.bimface.page.es.PagedList<com.bimface.api.bean.response.v1.FileTranslateResponseV1> fileTranslateList(Long projectId,
                                                                                                                 com.bimface.api.bean.request.v1.FileTranslateRequestV1 request)
                                                                                                          throws com.bimface.exception.BimfaceException

获取转换资源列表

参数:: projectId - 项目ID; request - FileTranslateRequestV1请求体
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

compare

@Deprecated
public com.bimface.api.bean.response.ModelCompareBean compare(com.bimface.api.bean.request.modelCompare.ModelCompareRequest modelCompareRequest)
                                                                    throws com.bimface.exception.BimfaceException

已过时。

发起模型对比已过期，推荐使用： compareV2(com.bimface.api.bean.request.modelCompare.CompareRequest)

参数:: modelCompareRequest - ModelCompareBean
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

compareV2

public com.bimface.api.bean.response.ModelCompareBean compareV2(com.bimface.api.bean.request.modelCompare.CompareRequest compareRequest)
                                                         throws com.bimface.exception.BimfaceException

发起模型对比，V2

参数:: compareRequest - ModelCompareBean
返回:: FileTranslateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getCompareInfo

public com.bimface.api.bean.response.ModelCompareBean getCompareInfo(Long compareId)
                                                              throws com.bimface.exception.BimfaceException

获取模型对比状态

参数:: compareId - 模型对比id
返回:: ModelCompareBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getCompares

public com.bimface.page.PagedList<com.bimface.api.bean.response.ModelCompareBean> getCompares(com.bimface.api.bean.request.modelCompare.ModelCompareQueryRequest modelCompareQueryRequest)
                                                                                       throws com.bimface.exception.BimfaceException

批量获取模型对比状态

参数:: modelCompareQueryRequest - ModelCompareQueryRequest
返回:: PagedList <ModelCompareBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteCompare
```
public void deleteCompare(Long compareId)
                   throws com.bimface.exception.BimfaceException
```
已过时。

删除模型对比

参数:

compareId - 模型对比id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getCompareResult

public List<com.bimface.data.bean.ModelCompareTree.SpecialtyNode> getCompareResult(Long compareId)
                                                                            throws com.bimface.exception.BimfaceException

获取模型对比结果

参数:: compareId - 模型对比id
返回:: ModelCompareTree.SpecialtyNode
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getCompareElementDiff
```
public com.bimface.data.bean.ModelCompareChange getCompareElementDiff(CompareElementRequest compareElementRequest)
                                                               throws com.bimface.exception.BimfaceException
```
获取模型对比构件差异已过时，推荐使用： getModelCompareElementChange(java.lang.Long, java.lang.Long, java.lang.String, java.lang.Long, java.lang.String)

参数:

compareElementRequest - CompareElementRequest

返回:

ModelCompareChange

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getViewTokenByIntegrateId
```
public String getViewTokenByIntegrateId(Long integrateId)
                                 throws com.bimface.exception.BimfaceException
```
获取集成模型viewToken, 用于模型预览的凭证

参数:

integrateId - 集成id

返回:

String viewToken 预览凭证

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getViewTokenByCompareId
```
public String getViewTokenByCompareId(Long compareId)
                               throws com.bimface.exception.BimfaceException
```
获取模型对比viewToken, 用于模型预览的凭证

参数:

compareId - 模型对比id

返回:

String viewToken 预览凭证

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getViewTokenByFileId
```
public String getViewTokenByFileId(Long fileId)
                            throws com.bimface.exception.BimfaceException
```
获取viewToken, 用于模型预览的凭证

参数:

fileId - 文件id

返回:

String viewToken 预览凭证

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createTranslateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createTranslateShare(Long fileId,
                                                                                   Integer activeHours)
                                                                            throws com.bimface.exception.BimfaceException

创建单个文件浏览分享链接

参数:: fileId - 文件id; activeHours - 从当前算起，分享链接的有效时间，单位：小时; 如果为空，表示该分享链接永久有效
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createTranslateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createTranslateShare(Long fileId,
                                                                                   String expireDate,
                                                                                   Boolean needPassword)
                                                                            throws com.bimface.exception.BimfaceException

创建单个文件浏览分享链接,带分享密码

参数:: fileId - 文件id; expireDate - 过期日期; needPassword - 是否需要密码
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createTranslateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createTranslateShare(Long fileId)
                                                                            throws com.bimface.exception.BimfaceException

创建单个文件浏览分享链接,永久有效

参数:: fileId - 文件id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteTranslateShare
```
public void deleteTranslateShare(Long fileId)
                          throws com.bimface.exception.BimfaceException
```
取消单个文件浏览分享链接

参数:

fileId - 文件id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createIntegrateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createIntegrateShare(Long integrateId,
                                                                                   Integer activeHours)
                                                                            throws com.bimface.exception.BimfaceException

创建集成文件浏览分享链接

参数:: integrateId - 集成id; activeHours - 从当前算起，分享链接的有效时间，单位：小时; 如果为空，表示该分享链接永久有效
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createIntegrateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createIntegrateShare(Long integrateId,
                                                                                   String expireDate,
                                                                                   Boolean needPassword)
                                                                            throws com.bimface.exception.BimfaceException

创建集成文件浏览分享链接,带分享密码

参数:: integrateId - 集成id; expireDate - 过期日期; needPassword - 是否需要密码
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createIntegrateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createIntegrateShare(Long integrateId)
                                                                            throws com.bimface.exception.BimfaceException

创建集成文件浏览分享链接,永久有效

参数:: integrateId - 集成id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteIntegrateShare
```
public void deleteIntegrateShare(Long integrateId)
                          throws com.bimface.exception.BimfaceException
```
取消集成文件浏览分享链接

参数:

integrateId - 集成id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

batchDeteleShare

public com.bimface.api.bean.compatible.response.BatchDeleteResultBean<Long> batchDeteleShare(List<Long> sourceIds)
                                                                                      throws com.bimface.exception.BimfaceException

批量删除分享链接

参数:: sourceIds - 源id
返回:: BatchDeleteResultBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getShareLink

public com.bimface.api.bean.compatible.response.ShareLinkBean getShareLink(String token)
                                                                    throws com.bimface.exception.BimfaceException

获取分享链接信息

参数:: token - token
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean getTranslateShare(Long fileId)
                                                                         throws com.bimface.exception.BimfaceException

获取分享链接信息

参数:: fileId - 文件id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateShare

public com.bimface.api.bean.compatible.response.ShareLinkBean getIntegrateShare(Long integrateId)
                                                                         throws com.bimface.exception.BimfaceException

获取分享链接信息

参数:: integrateId - 集成id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSceneShare

public com.bimface.api.bean.compatible.response.ShareLinkBean getSceneShare(Long sceneId)
                                                                     throws com.bimface.exception.BimfaceException

获取分享信息链接

参数:: sceneId - 场景id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

public com.bimface.page.PagedList<com.bimface.api.bean.compatible.response.ShareLinkBean> shares(Integer pageNo,
                                                                                                 Integer pageSize)
                                                                                          throws com.bimface.exception.BimfaceException

获取分享列表

参数:: pageNo - 分页查询的页数; pageSize - 分页查询的每页大小
返回:: PagedList <ShareLinkBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getProperty

@Deprecated
public com.bimface.data.bean.Property getProperty(Long fileId,
                                                               String elementId)
                                                        throws com.bimface.exception.BimfaceException

已过时。

获取单文件模型对应构件下的属性已过时，推荐使用： getSingleModelElementV2(java.lang.Long, java.lang.String)

参数:: fileId - 文件id; elementId - 构件id
返回:: PropertyBean Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrationProperty

@Deprecated
public com.bimface.data.bean.Property getIntegrationProperty(Long integrateId,
                                                                          Long fileId,
                                                                          String elementId)
                                                                   throws com.bimface.exception.BimfaceException

已过时。

获取集成模型对应构件下的属性已过时，推荐使用： getIntegrateModelElementMaterials(java.lang.Long, java.lang.String, java.lang.String)

参数:: integrateId - 集成id; fileId - 文件id; elementId - 构件id
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getCategory
```
@Deprecated
public List<com.bimface.data.bean.Category> getCategory(Long fileId)
                                                              throws com.bimface.exception.BimfaceException
```
已过时。

获取单文件构件分类树已过时，推荐使用V2版本文件分类数 getSingleModelTreeV2(java.lang.Long, com.bimface.data.bean.FileTreeRequestBody)

参数:

fileId - 文件id

返回:

List<Category>

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getCategoryV2
```
@Deprecated
public List<com.bimface.data.bean.Tree.TreeNode> getCategoryV2(Long fileId)
                                                                     throws com.bimface.exception.BimfaceException
```
已过时。

获取单文件构件分类树V2 已过时，推荐使用： getSingleModelTreeV2(java.lang.Long, com.bimface.data.bean.FileTreeRequestBody)

参数:

fileId - 文件id

返回:

List <Tree.TreeNode >

抛出:

com.bimface.exception.BimfaceException - BimfaceException BimfaceException

getSpecialtyTree
```
@Deprecated
public com.bimface.data.bean.SpecialtyTree getSpecialtyTree(Long integrateId)
                                                                  throws com.bimface.exception.BimfaceException
```
已过时。

获取集成模型专业层次结构已过时，推荐使用： getIntegrateModelTree(java.lang.Long, java.lang.String, java.util.List, com.bimface.data.bean.IntegrationTreeOptionalRequestBody)

参数:

integrateId - 集成id

返回:

SpecialtyTree

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getFloorTree
```
@Deprecated
public com.bimface.data.bean.FloorTree getFloorTree(Long integrateId)
                                                          throws com.bimface.exception.BimfaceException
```
已过时。

获取集成模型楼层层次结构已过时，推荐使用： getIntegrateModelTree(java.lang.Long, java.lang.String, java.util.List, com.bimface.data.bean.IntegrationTreeOptionalRequestBody)

参数:

integrateId - 集成id

返回:

FloorTree

抛出:

com.bimface.exception.BimfaceException - BimfaceException

integrate

public com.bimface.api.bean.response.FileIntegrateBean integrate(com.bimface.api.bean.request.integrate.FileIntegrateRequest request)
                                                          throws com.bimface.exception.BimfaceException

发起文件集成

参数:: request - FileIntegrateRequest
返回:: FileIntegrateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrate

public com.bimface.api.bean.response.FileIntegrateBean getIntegrate(Long integrateId)
                                                             throws com.bimface.exception.BimfaceException

获取文件集成状态

参数:: integrateId - 集成Id
返回:: FileIntegrateBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrates

public com.bimface.page.PagedList<com.bimface.api.bean.response.FileIntegrateDetailBean> getIntegrates(com.bimface.api.bean.request.integrate.IntegrateQueryRequest integrateQueryRequest)
                                                                                                throws com.bimface.exception.BimfaceException

批量获取文件集成状态

参数:: integrateQueryRequest - 集成文件查询条件
返回:: PagedList <FileIntegrateDetailBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

integrate2Bimtiles

public com.bimface.api.bean.response.FileIntegrateBean integrate2Bimtiles(com.bimface.api.bean.request.integrate.FileIntegrateRequest request)
                                                                   throws com.bimface.exception.BimfaceException

发起模型集成

参数:: request - 模型集成请求体
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteIntegrate
```
public void deleteIntegrate(Long integrateId)
                     throws com.bimface.exception.BimfaceException
```
删除集成模型

参数:

integrateId - 集成模型id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

modify

public com.bimface.api.bean.response.FileIntegrateBean modify(Long integrateId,
                                                              String name)
                                                       throws com.bimface.exception.BimfaceException

更新集成信息

参数:: integrateId - 集成模型id; name - 集成新名称
抛出:: com.bimface.exception.BimfaceException - BimfaceException

validateSignature

public boolean validateSignature(String signature,
                                 String id,
                                 String status,
                                 String nonce)
                          throws com.bimface.exception.BimfaceException

验证签名, 接收回调时使用

参数:: signature - 签名字符; id - 可以是fileId或者integrateId; status - 转换状态(success || failed); nonce - 随机数
返回:: true: 验证成功, false: 校验失败
抛出:: com.bimface.exception.BimfaceException - BimfaceException

generateOfflineDatabag

public com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean generateOfflineDatabag(OfflineDatabagRequest offlineDatabagRequest)
                                                                                             throws com.bimface.exception.BimfaceException

构建离线数据包

参数:: offlineDatabagRequest - OfflineDatabagRequest
返回:: DatabagDerivativeBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryOfflineDatabag
```
@Deprecated
public List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean> queryOfflineDatabag(OfflineDatabagRequest offlineDatabagRequest)
                                                                                                                       throws com.bimface.exception.BimfaceException
```
已过时。

查询离线数据包已过时：推荐使用：查询转换的离线数据包 queryTranslateOfflineDatabag(java.lang.Long) 查询集成的离线数据包 queryIntegrateOfflineDatabag(java.lang.Long) 查询比较的离线数据包 queryCompareOfflineDatabag(java.lang.Long)

参数:

offlineDatabagRequest - OfflineDatabagRequest

返回:

List <DatabagDerivativeBean>

抛出:

com.bimface.exception.BimfaceException - BimfaceException

queryTranslateOfflineDatabag

public List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean> queryTranslateOfflineDatabag(Long fileId)
                                                                                                                   throws com.bimface.exception.BimfaceException

查询离线数据包

参数:: fileId - 文件id
返回:: List <DatabagDerivativeBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryIntegrateOfflineDatabag

public List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean> queryIntegrateOfflineDatabag(Long integrateId)
                                                                                                                   throws com.bimface.exception.BimfaceException

查询离线数据包

参数:: integrateId - 集成id
返回:: List <DatabagDerivativeBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryCompareOfflineDatabag

public List<? extends com.bimface.api.bean.response.databagDerivative.DatabagDerivativeBean> queryCompareOfflineDatabag(Long compareId)
                                                                                                                 throws com.bimface.exception.BimfaceException

查询离线数据包

参数:: compareId - 比较id
返回:: List <DatabagDerivativeBean>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

exportTranslateGltfDatabag

public com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean exportTranslateGltfDatabag(Long fileId,
                                                                                                                 String callback)
                                                                                                          throws com.bimface.exception.BimfaceException

通过文件ID导出gltf数据包

参数:: fileId - 文件id; callback - 回调url地址，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方
返回:: TranslateDatabagDerivativeBean TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslateGltfDatabag

public List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean> getTranslateGltfDatabag(Long fileId)
                                                                                                             throws com.bimface.exception.BimfaceException

查询gltf数据包信息

参数:: fileId - 文件id
返回:: List<TranslateDatabagDerivativeBean> TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

exportIntegrateGltfDatabag

public com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean exportIntegrateGltfDatabag(Long integrateId,
                                                                                                                 String callback)
                                                                                                          throws com.bimface.exception.BimfaceException

通过集成模型ID创建gltf数据包

参数:: integrateId - 集成id; callback - 回调url地址，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方
返回:: IntegrateDatabagDerivativeBean IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateGltfDatabags

public List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean> getIntegrateGltfDatabags(Long integrateId)
                                                                                                              throws com.bimface.exception.BimfaceException

查询集成模型gltf数据包

参数:: integrateId - 集成id
返回:: List<IntegrateDatabagDerivativeBean> IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslateGltfDatabagUrl
```
public String getTranslateGltfDatabagUrl(Long fileId,
                                         String databagVersion)
                                  throws com.bimface.exception.BimfaceException
```
指定文件ID，获取gltf数据包的下载链接如果只有一个数据包版本，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入gltf数据包的下载地址，即可下载得到对应模型的gltf数据包。

参数:

fileId - 文件id

databagVersion - 数据包版本

返回:

gltf数据包的下载地址

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getIntegrateGltfDatabagUrl
```
public String getIntegrateGltfDatabagUrl(Long integrateId,
                                         String databagVersion)
                                  throws com.bimface.exception.BimfaceException
```
指定集成ID，获取gltf数据包的下载链接如果只有一个数据包版本，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入gltf数据包的下载地址，即可下载得到对应模型的gltf数据包。

参数:

integrateId - 集成id

databagVersion - 数据包版本

返回:

gltf数据包的下载地址

抛出:

com.bimface.exception.BimfaceException - BimfaceException

exportTranslate3DTilesDatabag

public com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean exportTranslate3DTilesDatabag(Long fileId,
                                                                                                                    String callback,
                                                                                                                    Map<String,String> config)
                                                                                                             throws com.bimface.exception.BimfaceException

通过文件ID创建3DTiles数据包需要文件转换成功后调用

参数:: fileId - 文件id; callback - 回调url，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方; config - 参数设置
返回:: TranslateDatabagDerivativeBean TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslate3DTilesDatabags

public List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean> getTranslate3DTilesDatabags(Long fileId)
                                                                                                                 throws com.bimface.exception.BimfaceException

查询文件的3DTiles数据包

参数:: fileId - 文件id
返回:: List<TranslateDatabagDerivativeBean> TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

exportIntegrate3DTilesDatabag

public com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean exportIntegrate3DTilesDatabag(Long integrateId,
                                                                                                                    String callback,
                                                                                                                    Map<String,String> config)
                                                                                                             throws com.bimface.exception.BimfaceException

通过集成模型ID创建3DTiles数据包需要模型集成成功后调用

参数:: integrateId - 集成id; callback - 回调url，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方; config - 参数设置
返回:: IntegrateDatabagDerivativeBean IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrate3DTilesDatabags

public List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean> getIntegrate3DTilesDatabags(Long integrateId)
                                                                                                                 throws com.bimface.exception.BimfaceException

查询集成模型3DTiles数据包

参数:: integrateId - 集成id
返回:: List<IntegrateDatabagDerivativeBean> IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslate3dTilesDatabagUrl
```
public String getTranslate3dTilesDatabagUrl(Long fileId,
                                            String databagVersion)
                                     throws com.bimface.exception.BimfaceException
```
指定文件ID，获取3DTiles数据包下载地址数据包版本；如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入3DTiles数据包的下载地址，即可下载得到对应模型的3DTiles数据包。

参数:

fileId - 文件Id

databagVersion - 数据包的版本

返回:

3DTiles数据包的下载地址

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getIntegrate3dTilesDatabagUrl
```
public String getIntegrate3dTilesDatabagUrl(Long integrateId,
                                            String databagVersion)
                                     throws com.bimface.exception.BimfaceException
```
指定集成ID，获取3DTiles数据包下载地址数据包版本；如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本在浏览器中输入3DTiles数据包的下载地址，即可下载得到对应模型的3DTiles数据包。

参数:

integrateId - 集成Id

databagVersion - 数据包版本

返回:

3DTiles数据包的下载地址

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createTranslateBakeDatabag

public com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean createTranslateBakeDatabag(Long fileId,
                                                                                                                 String callback,
                                                                                                                 Map<String,String> config)
                                                                                                          throws com.bimface.exception.BimfaceException

为文件创建bake数据包需要文件转换成功后调用

参数:: fileId - 文件id; callback - 回调url，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方; config - 参数设置
返回:: TranslateDatabagDerivativeBean TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getTranslateBakeDatabags

public List<com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean> getTranslateBakeDatabags(Long fileId)
                                                                                                              throws com.bimface.exception.BimfaceException

查询文件bake数据包

参数:: fileId - 文件id
返回:: List<TranslateDatabagDerivativeBean> TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createIntegrateBakeDatabag

public com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean createIntegrateBakeDatabag(Long integrateId,
                                                                                                                 String callback,
                                                                                                                 Map<String,String> config)
                                                                                                          throws com.bimface.exception.BimfaceException

为集成模型创建bake数据包需要模型集成成功后调用

参数:: integrateId - 集成id; callback - 回调url，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方; config - 参数设置
返回:: IntegrateDatabagDerivativeBean IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateBakeDatabags

public List<com.bimface.api.bean.response.databagDerivative.IntegrateDatabagDerivativeBean> getIntegrateBakeDatabags(Long integrateId)
                                                                                                              throws com.bimface.exception.BimfaceException

查询集成模型bake数据包

参数:: integrateId - 集成id
返回:: List<IntegrateDatabagDerivativeBean> IntegrateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createDrawingSplit

public com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean createDrawingSplit(Long fileId,
                                                                                                         String callback,
                                                                                                         Map<String,String> config)
                                                                                                  throws com.bimface.exception.BimfaceException

发起图纸拆分

参数:: fileId - 文件id; callback - 回调url，BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方; config - 参数设置
返回:: TranslateDatabagDerivativeBean TranslateDatabagDerivativeBean 数据包元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getDrawingSplit
```
public com.bimface.api.bean.response.databagDerivative.TranslateDatabagDerivativeBean getDrawingSplit(Long fileId)
                                                                                               throws com.bimface.exception.BimfaceException
```
获取拆图状态图纸发起拆分后，可以通过该接口查询拆图状态

参数:

fileId - 文件id

返回:

TranslateDatabagDerivativeBean TranslateDatabagDerivativeBean 数据包元信息

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getDrawingFrames
```
public List getDrawingFrames(Long fileId)
                      throws com.bimface.exception.BimfaceException
```
获取图纸拆分结果

参数:

fileId - 文件id

返回:

List<DrawingSplitLayout> DrawingSplitLayout

抛出:

com.bimface.exception.BimfaceException - BimfaceException

pageGetDrawingCompareResult

public com.bimface.data.bean.Pagination<com.bimface.data.bean.DrawingCompareDiff> pageGetDrawingCompareResult(Long comparisonId,
                                                                                                              String layer,
                                                                                                              Integer page,
                                                                                                              Integer pageSize)
                                                                                                       throws com.bimface.exception.BimfaceException

分页获取图纸对比结果

参数:: comparisonId - 图纸对比ID; layer - 图层名称; page - 页码; pageSize - 每页记录数
返回:: Pagination <DrawingCompareDiff>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getMEPSystem

public List<com.bimface.data.bean.MEPSystem> getMEPSystem(Long fileId,
                                                          String systemCategory,
                                                          String systemType)
                                                   throws com.bimface.exception.BimfaceException

获取MEP系统信息

参数:: fileId - 需要获取系统信息的文件Id; systemCategory - 希望获取的系统的systemCategory; systemType - 希望获取的系统的systemType
返回:: List<MEPSystem> MEPSystem
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getBoundingBoxesByEleIds

public List<com.bimface.data.bean.ElementIdWithBoundingBox> getBoundingBoxesByEleIds(Long integrateId,
                                                                                     List<String> fileIdWithEleIdList)
                                                                              throws com.bimface.exception.BimfaceException

计算指定构件列表的包围盒列表获取每个构件对应的包围盒

参数:: integrateId - 模型集成ID; fileIdWithEleIdList - 构件ID列表,由','分隔.每个构件ID由fileID和elementID组成,由'.'分隔;也可以由单个elementId组成
返回:: List<ElementIdWithBoundingBox> ElementIdWithBoundingBox
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getOfflineDatabagUrl
```
@Deprecated
public String getOfflineDatabagUrl(OfflineDatabagRequest offlineDatabagRequest)
                                         throws com.bimface.exception.BimfaceException
```
已过时。

获取离线数据包信息已过时：请使用： getOfflineDatabagUrl(java.lang.Long, java.lang.Long, java.lang.Long, java.lang.String)

参数:

offlineDatabagRequest - OfflineDatabagRequest

返回:

离线数据包下载地址

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getOfflineDatabagUrl

public String getOfflineDatabagUrl(Long fileId,
                                   Long integrateId,
                                   Long compareId,
                                   String databagVersion)
                            throws com.bimface.exception.BimfaceException

获取离线数据包下载链接

参数:: fileId - 文件id; integrateId - 集成id; compareId - 比较id; databagVersion - 离线数据包版本
返回:: 离线数据包下载链接
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createAppendFile

public com.bimface.file.bean.AppendFileBean createAppendFile(String name,
                                                             String sourceId,
                                                             Long length)
                                                      throws com.bimface.exception.BimfaceException

创建追加文件

参数:: name - 文件的全名，使用URL编码（UTF-8），最多256个字符; sourceId - 调用方的文件源ID，不能重复; length - 上传文件长度
返回:: AppendFileBean AppendFileBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryAppendFile
```
public com.bimface.file.bean.AppendFileBean queryAppendFile(Long appendFileId)
                                                     throws com.bimface.exception.BimfaceException
```
查询追加文件信息

参数:

appendFileId - 追加文件ID

返回:

AppendFileBean AppendFileBean 追加文件的元信息

抛出:

com.bimface.exception.BimfaceException - BimfaceException

uploadAppendFile

public com.bimface.file.bean.AppendFileBean uploadAppendFile(InputStream inputStream,
                                                             Long appendFileId)
                                                      throws com.bimface.exception.BimfaceException

追加上传

参数:: inputStream - 文件的整个完整流; appendFileId - 追加文件ID
返回:: AppendFileBean AppendFileBean 追加文件的元信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

uploadAppendFile

public com.bimface.file.bean.AppendFileBean uploadAppendFile(InputStream inputStream,
                                                             Long appendFileId,
                                                             Long length,
                                                             Long position)
                                                      throws com.bimface.exception.BimfaceException

追加上传

参数:: inputStream - 文件的整个完整流; appendFileId - 追加文件ID; length - 上传文件长度; position - 追加上传开始位置
返回:: AppendFileBean AppendFileBean 追加文件的元信息
抛出:: com.bimface.exception.BimfaceException

getFileFloors
```
@Deprecated
public List<com.bimface.data.bean.Floor> getFileFloors(Long fileId)
                                                             throws com.bimface.exception.BimfaceException
```
已过时。

获取楼层信息已过时：推荐使用： getFileFloors(java.lang.Long, Boolean, Boolean)

参数:

fileId - 文件Id

返回:

楼层列表

抛出:

com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getFileFloors

public List<com.bimface.data.bean.Floor> getFileFloors(Long fileId,
                                                       Boolean includeArea,
                                                       Boolean includeRoom)
                                                throws com.bimface.exception.BimfaceException

获取楼层信息

参数:: fileId - fileId 文件Id; includeArea - 是否将楼层中的面积分区ID、名称一起返回; includeRoom - 是否将楼层中的房间ID、名称一起返回
返回:: 楼层列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateFloors
```
@Deprecated
public List<com.bimface.data.bean.Floor> getIntegrateFloors(Long integrateId)
                                                                  throws com.bimface.exception.BimfaceException
```
已过时。

获取集成模型楼层信息已过时：推荐使用 getIntegrateFloors(java.lang.Long, java.lang.Boolean, java.lang.Boolean)

参数:

integrateId - 模型集成ID

返回:

楼层列表

抛出:

com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getIntegrateFloors

public List<com.bimface.data.bean.Floor> getIntegrateFloors(Long integrateId,
                                                            Boolean includeArea,
                                                            Boolean includeRoom)
                                                     throws com.bimface.exception.BimfaceException

获取集成模型楼层信息

参数:: integrateId - 模型集成ID; includeArea - 是否将楼层中的空间ID、名称一起返回; includeRoom - 是否将楼层中的房间ID、名称一起返回
返回:: 楼层列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getElementIdsV2

@Deprecated
public List<String> getElementIdsV2(Long fileId,
                                                 String specialty,
                                                 String floor,
                                                 String categoryId,
                                                 String family,
                                                 String familyType)
                                          throws com.bimface.exception.BimfaceException

已过时。

按查询条件查询单模型构件ID 组，v2 已过时：推荐使用：

getElementIdsV2(java.lang.Long, com.bimface.sdk.bean.request.QueryElementIdsRequest)

参数:: fileId - 文件ID; specialty - 专业; floor - 楼层; categoryId - 类别; family - 族; familyType - 族类型
返回:: 构件 ID 列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getElementIdsV2

public List<String> getElementIdsV2(Long fileId,
                                    QueryElementIdsRequest queryElementIdsRequest)
                             throws com.bimface.exception.BimfaceException

按查询条件查询单模型构件ID 组，v2

参数:: fileId - 文件id; queryElementIdsRequest - 元素查询条件
返回:: 构建id
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelFileIdFloorsMapping

public List<Map<String,Object>> getSingleModelFileIdFloorsMapping(List<String> fileIds,
                                                                  Boolean includeArea,
                                                                  Boolean includeRoom)
                                                           throws com.bimface.exception.BimfaceException

获取单模型文件 id 与楼层的映射关系，v2

参数:: fileIds - 文件 IDs; includeArea - includeArea; includeRoom - includeRoom
返回:: 楼层的映射关系
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getSingleModelElementV2

public com.bimface.data.bean.Property getSingleModelElementV2(Long fileId,
                                                              String elementId)
                                                       throws com.bimface.exception.BimfaceException

获取单模型构件，v2

参数:: fileId - 文件ID; elementId - 构件ID
返回:: 构件
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getSingleModelElementV2

public com.bimface.data.bean.Property getSingleModelElementV2(Long fileId,
                                                              String elementId,
                                                              boolean includeOverrides)
                                                       throws com.bimface.exception.BimfaceException

获取单模型构件，v2

参数:: fileId - 文件ID; elementId - 构件ID; includeOverrides - 是否查询修改的属性
返回:: 构件
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getSingleModelElementsV2

@Deprecated
public List<com.bimface.data.bean.Property> getSingleModelElementsV2(Long fileId,
                                                                                  List<String> elementIds)
                                                                           throws com.bimface.exception.BimfaceException

已过时。

根据构件 ID 批量获取单模型的单个构件，v2 即将过期，推荐使用：

getSingleModelElementsV2(java.lang.Long, java.util.List, java.util.List, boolean)

参数:: fileId - 文件ID; elementIds - 构件IDs
返回:: List <Property> 构件
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getSingleModelElementsV2

public List<com.bimface.data.bean.Property> getSingleModelElementsV2(Long fileId,
                                                                     List<String> elementIds,
                                                                     List<com.bimface.data.bean.ElementPropertyFilterRequest.GroupAndKeysPair> filter,
                                                                     boolean includeOverrides)
                                                              throws com.bimface.exception.BimfaceException

根据构件 ID 批量获取单模型的单个构件，v2 支持查询模型属性重写后构件的属性，需要设置请求参数includeOverrides的值为true

参数:: fileId - 文件ID; elementIds - 构件IDs; filter - 查询筛选条件，可选; includeOverrides - 是否查询修改的属性
返回:: List <Property> 构件
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceClient

getElementPropertyV2

public com.bimface.data.bean.Property getElementPropertyV2(Long fileId,
                                                           List<String> elementIds)
                                                    throws com.bimface.exception.BimfaceException

获取单文件的构件属性，v2

参数:: fileId - 文件id; elementIds - 构件id
返回:: Property构件属性
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getElementPropertyV2

public com.bimface.data.bean.Property getElementPropertyV2(Long fileId,
                                                           List<String> elementIds,
                                                           Boolean includeOverrides)
                                                    throws com.bimface.exception.BimfaceException

获取单文件的构件属性，v2 支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true

参数:: fileId - 文件id; elementIds - 构件id; includeOverrides - 是否包括覆盖的属性
返回:: Property构件属性
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelMaterials

public List<com.bimface.data.bean.MaterialInfo> getSingleModelMaterials(Long fileId,
                                                                        String elementId)
                                                                 throws com.bimface.exception.BimfaceException

获取单模型的构件材质，v2

参数:: fileId - 文件ID; elementId - 构件ID
返回:: 构件材质 MaterialInfo
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileDatabagResource

public List<com.bimface.data.bean.DatabagResourceUrl> getFileDatabagResource(Long fileId,
                                                                             Long integrateId,
                                                                             Long compareId,
                                                                             com.bimface.data.bean.DatabagResourceRequest databagResourceRequest)
                                                                      throws com.bimface.exception.BimfaceException

获取数据包资源，v2

参数:: fileId - 文件ID; integrateId - 集成ID; compareId - 对比ID; databagResourceRequest - 资源名称和路径列表
返回:
抛出:: com.bimface.exception.BimfaceException

getSingleModelViews

public List<com.bimface.data.bean.View> getSingleModelViews(Long fileId)
                                                     throws com.bimface.exception.BimfaceException

查询单模型三维视点信息，v2

参数:: fileId - 文件ID
返回:: List <View>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelRooms
```
@Deprecated
public List<com.bimface.data.bean.Room> getSingleModelRooms(Long fileId,
                                                                         String floorId)
                                                                  throws com.bimface.exception.BimfaceException
```
已过时。

Rvt单模型查询楼层对应房间列表，v2 已过时：推荐使用 getSingleModelRooms(java.lang.Long, java.lang.String, java.lang.String, com.bimface.data.enums.ToleranceType, com.bimface.data.enums.ToleranceType)

参数:

fileId - 文件id

floorId - 楼层id

返回:

List <Room>

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getSingleModelRooms

public List<com.bimface.data.bean.Room> getSingleModelRooms(Long fileId,
                                                            String floorId,
                                                            String elementId,
                                                            com.bimface.data.enums.ToleranceType roomToleranceZ,
                                                            com.bimface.data.enums.ToleranceType roomToleranceXY)
                                                     throws com.bimface.exception.BimfaceException

Rvt单模型查询楼层对应房间列表，v2 当前支持两种方式查询房间列表：1）使用楼层ID查询属于给定楼层的房间列表；2）使用构件ID在空间中计算查询包含该构件的房间列表这两种方式只能取其一，楼层ID优先。

参数:: fileId - 文件id; floorId - 楼层id; elementId - 元素id; roomToleranceZ - 房间Z方向容忍类型; roomToleranceXY - 房间Y方向容忍类型
返回:: List <Room>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelRoom

public com.bimface.data.bean.Room getSingleModelRoom(Long fileId,
                                                     String roomId)
                                              throws com.bimface.exception.BimfaceException

Rvt单模型查询楼层对应房间, v2

参数:: fileId - 文件id; roomId - 房间id
返回:: Room
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelAreas

public List<com.bimface.data.bean.Area> getSingleModelAreas(Long fileId,
                                                            String floorId)
                                                     throws com.bimface.exception.BimfaceException

Rvt单模型查询楼层对应Area列表, v2

参数:: fileId - 文件id; floorId - 楼层id
返回:: Area
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelArea

public com.bimface.data.bean.Area getSingleModelArea(Long fileId,
                                                     String areaId)
                                              throws com.bimface.exception.BimfaceException

Rvt单模型查询 Area, v2

参数:: fileId - 文件id; areaId - 区域id
返回:: Area
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelTreeV2

public List<com.bimface.data.bean.Tree.TreeNode> getSingleModelTreeV2(Long fileId,
                                                                      com.bimface.data.bean.FileTreeRequestBody requestBody)
                                                               throws com.bimface.exception.BimfaceException

查询单模型获取构件分类树，v2

参数:: fileId - 文件id; requestBody - FileTreeRequestBody 构件分类树查询请求体
返回:: List <Tree.TreeNode >
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelCustomizedTree

public com.bimface.data.bean.Tree getSingleModelCustomizedTree(Long fileId,
                                                               com.bimface.data.bean.FileTreeRequestBody requestBody)
                                                        throws com.bimface.exception.BimfaceException

查询单模型自定义构件分类树

参数:: fileId - 文件id; requestBody - FileTreeRequestBody 构件分类树查询请求体
返回:: Tree
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelLinks

public List<com.bimface.data.bean.Link> getSingleModelLinks(Long fileId)
                                                     throws com.bimface.exception.BimfaceException

单模型查询链接, v2

参数:: fileId - 文件id
返回:: List <Link>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelDrawingSheets
```
@Deprecated
public List<com.bimface.data.bean.DrawingSheet> getSingleModelDrawingSheets(Long fileId)
                                                                                  throws com.bimface.exception.BimfaceException
```
已过时。

单模型查询drawingSheets信息, v2 已过时：推荐使用 getSingleModelDrawingSheets(java.lang.Long, java.lang.String)

参数:

fileId - 文件ID

返回:

List <DrawingSheet>图纸列表

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getSingleModelDrawingSheets

public List<com.bimface.data.bean.DrawingSheet> getSingleModelDrawingSheets(Long fileId,
                                                                            String elementId)
                                                                     throws com.bimface.exception.BimfaceException

单模型查询drawingSheets信息, v2

参数:: fileId - 文件ID; elementId - 构件ID
返回:: 图纸列表
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getSingleModelModelInfo
```
public Object getSingleModelModelInfo(Long fileId)
                               throws com.bimface.exception.BimfaceException
```
获取模型数据包meta信息, v2

参数:

fileId -

返回:

数据包meta信息

抛出:

com.bimface.exception.BimfaceException - BimfaceException BimfaceException

getSingleModelChildElementIds

public List<com.bimface.data.bean.ElementIdWithName> getSingleModelChildElementIds(Long fileId,
                                                                                   String elementId)
                                                                            throws com.bimface.exception.BimfaceException

获取构件的子构件 id，v2

参数:: fileId - 文件id; elementId - 元素id
返回:: List <ElementIdWithName>
抛出:: com.bimface.exception.BimfaceException - BimfaceException BimfaceException

updateSingleModelElementProperties

public String updateSingleModelElementProperties(Long fileId,
                                                 String elementId,
                                                 List<com.bimface.data.bean.PropertyGroup> propertyGroups)
                                          throws com.bimface.exception.BimfaceException

修改（包含添加和更新）构件基本属性组以外的属性, V2

参数:: fileId - 文件id; elementId - 构件元素id; propertyGroups - 修改的属性 PropertyGroup
返回:: 修改是否成功
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteSingleModelElementProperties

public String deleteSingleModelElementProperties(Long fileId,
                                                 String elementId,
                                                 List<com.bimface.data.bean.PropertyGroup> propertyGroups)
                                          throws com.bimface.exception.BimfaceException

删除构件基本属性组以外的属性, V2

参数:: fileId - 文件id; elementId - 构件元素id; propertyGroups - 删除的属性
返回:: 删除是否成功
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElementIds

@Deprecated
public com.bimface.data.bean.ElementsWithBoundingBox getIntegrateModelElementIds(Long integrateId,
                                                                                              String specialty,
                                                                                              String roomId,
                                                                                              String floor,
                                                                                              String categoryId,
                                                                                              String family,
                                                                                              String familyType,
                                                                                              String systemType)
                                                                                       throws com.bimface.exception.BimfaceException

已过时。

获取集成模型构件ID组, v2 已过时：推荐使用： getIntegrateModelElementIds(java.lang.Long, com.bimface.sdk.bean.request.QueryElementIdsRequest)

参数:: integrateId - 集成id; specialty - 筛选条件专业; roomId - 房间id; floor - 楼层id; categoryId - 分类id; family - 筛选条件族; familyType - 筛选条件族类型; systemType - 筛选条件系统类型
返回:: ElementsWithBoundingBox
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElementIds

public com.bimface.data.bean.ElementsWithBoundingBox getIntegrateModelElementIds(Long integrateId,
                                                                                 QueryElementIdsRequest queryElementIdsRequest)
                                                                          throws com.bimface.exception.BimfaceException

获取集成模型构件ID组, v2

参数:: integrateId - 集成id; queryElementIdsRequest - 查询条件
返回:: ElementsWithBoundingBox
抛出:: com.bimface.exception.BimfaceException - BimfaceException

updateIntegrateModelElementProperties

public String updateIntegrateModelElementProperties(Long integrateId,
                                                    String fileIdHash,
                                                    String elementId,
                                                    List<com.bimface.data.bean.PropertyGroup> propertyGroups)
                                             throws com.bimface.exception.BimfaceException

修改集成模型指定构件的属性, V2

参数:: integrateId - 集成Id; fileIdHash - 文件Id hash值; elementId - 构建Id; propertyGroups - 属性群
返回:: 是否修改成功
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteIntegrateModelElementProperties

public String deleteIntegrateModelElementProperties(Long integrateId,
                                                    String fileIdHash,
                                                    String elementId,
                                                    List<com.bimface.data.bean.PropertyGroup> propertyGroups)
                                             throws com.bimface.exception.BimfaceException

删除集成模型指定构件的属性, V2

参数:: integrateId - 集成Id; fileIdHash - 文件Id hash 值; elementId - 构建Id; propertyGroups - 属性群
返回:: 是否删除成功
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElement

public com.bimface.data.bean.Property getIntegrateModelElement(Long integrateId,
                                                               String fileIdHash,
                                                               String elementId)
                                                        throws com.bimface.exception.BimfaceException

获取集成模型构件, v2

参数:: integrateId - 集成Id; fileIdHash - 文件Id hash值; elementId - 构建Id
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElement

public com.bimface.data.bean.Property getIntegrateModelElement(Long integrateId,
                                                               String fileIdHash,
                                                               String elementId,
                                                               Boolean includeOverrides)
                                                        throws com.bimface.exception.BimfaceException

获取集成模型构件, v2 支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true

参数:: integrateId - 集成id; fileIdHash - 文件id的hash值; elementId - 元素id; includeOverrides - 是否包含被覆盖的构件
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElement

public com.bimface.data.bean.Property getIntegrateModelElement(Long integrateId,
                                                               String elementId)
                                                        throws com.bimface.exception.BimfaceException

获取集成模型构件, v2

参数:: integrateId -; elementId -
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateElementBatch

public List<com.bimface.data.bean.Property> getIntegrateElementBatch(Long integrateId,
                                                                     boolean includeOverrides,
                                                                     com.bimface.data.bean.IntegrateElementPropertyFilterRequest filterRequest)
                                                              throws com.bimface.exception.BimfaceException

批量获取集成模型构件, v2

参数:: integrateId - 集成Id; includeOverrides - 是否包含覆盖Id; filterRequest - 请求
返回:: 属性信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelElementMaterials

public List<com.bimface.data.bean.MaterialInfo> getIntegrateModelElementMaterials(Long integrateId,
                                                                                  String fileIdHash,
                                                                                  String elementId)
                                                                           throws com.bimface.exception.BimfaceException

获取集成模型构件材质, v2

参数:: integrateId - 集成Id; fileIdHash - 文件Id hash 值; elementId - 构建Id
返回:: List <MaterialInfo>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelTree

public com.bimface.data.bean.Tree getIntegrateModelTree(Long integrateId,
                                                        String treeType,
                                                        List<String> desiredHierarchy,
                                                        com.bimface.data.bean.IntegrationTreeOptionalRequestBody requestBody)
                                                 throws com.bimface.exception.BimfaceException

获取集成模型分类树，v2

参数:: integrateId - 集成Id; treeType - 可选为：floor, specialty和customized三种类型; desiredHierarchy - 期望的结构; requestBody - 请求body
返回:: Tree
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelFileViews

public List<com.bimface.data.bean.FileViews> getIntegrateModelFileViews(Long integrateId,
                                                                        String viewType)
                                                                 throws com.bimface.exception.BimfaceException

获取集成模型三维视点/二维视点, v2

参数:: integrateId - 集成Id; viewType - viewType
返回:: List <FileViews>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelRooms

@Deprecated
public List<com.bimface.data.bean.Room> getIntegrateModelRooms(Long integrateId,
                                                                            String floorId)
                                                                     throws com.bimface.exception.BimfaceException

已过时。

集成模型查询楼层对应房间列表, v2 已过时：推荐使用： getIntegrateModelRooms(java.lang.Long, java.lang.String, java.lang.String, com.bimface.data.enums.ToleranceType, com.bimface.data.enums.ToleranceType)

参数:: integrateId - 集成Id; floorId - 楼层Id
返回:: 房间信息
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelRooms

public List<com.bimface.data.bean.Room> getIntegrateModelRooms(Long integrateId,
                                                               String floorId,
                                                               String elementId,
                                                               com.bimface.data.enums.ToleranceType roomToleranceZ,
                                                               com.bimface.data.enums.ToleranceType roomToleranceXY)
                                                        throws com.bimface.exception.BimfaceException

集成模型查询楼层对应房间列表, v2 当前支持两种方式查询房间列表：1）使用楼层ID查询属于给定楼层的房间列表；2）使用构件ID在空间中计算查询包含该构件的房间列表这两种方式只能取其一，楼层ID优先。

参数:: integrateId - 集成id; floorId - 楼层id; elementId - 元素id; roomToleranceZ - Z坐标轴方向对构件的筛选容忍度; roomToleranceXY - XY坐标轴方向对构件的筛选容忍度
返回:: List <Room>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelRooms

public List<com.bimface.data.bean.Room> getIntegrateModelRooms(Long integrateId,
                                                               String floorId,
                                                               String fildIdHash,
                                                               String elementId,
                                                               com.bimface.data.enums.ToleranceType roomToleranceZ,
                                                               com.bimface.data.enums.ToleranceType roomToleranceXY)
                                                        throws com.bimface.exception.BimfaceException

参数:: integrateId - 集成id; floorId - 楼层id; fildIdHash - 子文件ID; elementId - 元素id; roomToleranceZ - Z坐标轴方向对构件的筛选容忍度; roomToleranceXY - XY坐标轴方向对构件的筛选容忍度
返回:: List <Room>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelRoom

public com.bimface.data.bean.Room getIntegrateModelRoom(Long integrateId,
                                                        String roomId)
                                                 throws com.bimface.exception.BimfaceException

集成模型查询房间属性，v2

参数:: integrateId - 集成id; roomId - 房间id
返回:: Room
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelAreas

public List<com.bimface.data.bean.Area> getIntegrateModelAreas(Long integrateId,
                                                               String floorId)
                                                        throws com.bimface.exception.BimfaceException

集成模型查询楼层对应Area列表, v2

参数:: integrateId - 集成id; floorId - 房间id
返回:: List <Area>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelArea

public com.bimface.data.bean.Area getIntegrateModelArea(Long integrateId,
                                                        String areaId)
                                                 throws com.bimface.exception.BimfaceException

集成模型查询Area, v2

参数:: integrateId -; areaId -
返回:: Area
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateFiles

public List<com.bimface.data.bean.IntegrateFileData> getIntegrateFiles(Long integrateId)
                                                                throws com.bimface.exception.BimfaceException

查询指定的集成模型内参与集成的子文件信息, v2

参数:: integrateId -
返回:: List <IntegrateFileData>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateFiles
```
public List<com.bimface.data.bean.IntegrateFileData> getIntegrateFiles(Long integrateId,
                                                                       Boolean includeDrawingSheet)
                                                                throws com.bimface.exception.BimfaceException
```
查询指定的集成模型内参与集成的子文件信息, v2 支持将文件下转换出的图纸数量一起返回，需要设置请求参数includeDrawingSheet的值为true

参数:

integrateId - 集成ID

includeDrawingSheet - 是否将文件下转换出的图纸数量一起返回

返回:

List <IntegrateFileData>

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelViewToken

public String getIntegrateModelViewToken(Long integrateId,
                                         String fileId)
                                  throws com.bimface.exception.BimfaceException

根据集成ID,文件ID获取viewToken，v2

参数:: integrateId -; fileId -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelSegmentGroups

public List<com.bimface.data.bean.SegmentGroupDto> getIntegrateModelSegmentGroups(Long integrateId)
                                                                           throws com.bimface.exception.BimfaceException

获取集成模型中所有的流水段分组，v2

参数:: integrateId -
返回:: List <SegmentGroupDto>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelSegmentTree

public List<com.bimface.data.bean.SegmentGroupDto> getIntegrateModelSegmentTree(Long integrateId)
                                                                         throws com.bimface.exception.BimfaceException

获取集成模型的流水段树, v2

参数:: integrateId -
返回:: List <SegmentGroupDto>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelSegments

public List<com.bimface.data.bean.SegmentDto> getIntegrateModelSegments(Long integrateId,
                                                                        String segmentGroupId)
                                                                 throws com.bimface.exception.BimfaceException

获取流水段分组中的所有流水段, v2

参数:: integrateId -; segmentGroupId -
返回:: List <SegmentDto>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelSegmentElementIds

public List<String> getIntegrateModelSegmentElementIds(Long integrateId,
                                                       String segmentId)
                                                throws com.bimface.exception.BimfaceException

获取流水段对应的所有构件id

参数:: integrateId - 集成ID; segmentId - 流水段ID；支持批量查询，多个segment id用逗号隔开
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelCommonElementProperties

public com.bimface.data.bean.Property getIntegrateModelCommonElementProperties(Long integrateId,
                                                                               List<com.bimface.data.bean.FileIdHashWithElementIds> fileIdHashWithElementIds)
                                                                        throws com.bimface.exception.BimfaceException

集成模型获取构件属性

参数:: integrateId -; fileIdHashWithElementIds -
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getIntegrateModelCommonElementProperties

public com.bimface.data.bean.Property getIntegrateModelCommonElementProperties(Long integrateId,
                                                                               List<com.bimface.data.bean.FileIdHashWithElementIds> fileIdHashWithElementIds,
                                                                               Boolean includeOverrides)
                                                                        throws com.bimface.exception.BimfaceException

集成模型获取构件属性支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true

参数:: integrateId -; fileIdHashWithElementIds -; includeOverrides -
返回:: Property
抛出:: com.bimface.exception.BimfaceException - BimfaceException

addAssociations

public void addAssociations(String integrateId,
                            String fromIntegrationId,
                            String fromBusinessType,
                            String fromBusinessFlag,
                            com.bimface.data.bean.BusinessAssociationRequest request)
                     throws com.bimface.exception.BimfaceException

新增双向业务挂接,可以在request body中指定新增项，也可以指定从其他集成拷贝

参数:: integrateId -; fromIntegrationId -; fromBusinessType -; fromBusinessFlag -; request -
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getAssociationsByElementId

public List<com.bimface.data.bean.ElementBusinessAssociation> getAssociationsByElementId(String integrateId,
                                                                                         String elementId,
                                                                                         String businessType,
                                                                                         String businessFlag)
                                                                                  throws com.bimface.exception.BimfaceException

根据构件ID查询对应业务挂接

参数:: integrateId -; elementId -; businessType -; businessFlag -
返回:: List <ElementBusinessAssociation>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getAssociationsByBusinessId

public List<com.bimface.data.bean.BusinessElementAssociation> getAssociationsByBusinessId(String integrateId,
                                                                                          String businessType,
                                                                                          String businessId)
                                                                                   throws com.bimface.exception.BimfaceException

根据业务ID查询对应构件

参数:: integrateId -; businessType -; businessId -
返回:: List <BusinessElementAssociation>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteAssociationsByElementId

public void deleteAssociationsByElementId(String integrateId,
                                          String elementId,
                                          String businessType,
                                          String businessFlag,
                                          List<String> businessIds)
                                   throws com.bimface.exception.BimfaceException

删除构件关联的业务挂接

参数:: integrateId -; elementId -; businessType -; businessFlag -; businessIds -
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteAssociationsByBusinessId

public void deleteAssociationsByBusinessId(String integrateId,
                                           String businessType,
                                           String businessId)
                                    throws com.bimface.exception.BimfaceException

删除业务ID关联的业务挂接

参数:: integrateId -; businessType -; businessId -
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteAssociationsByElements

public void deleteAssociationsByElements(String integrateId,
                                         String businessType,
                                         String businessFlag,
                                         List<String> elementIds)
                                  throws com.bimface.exception.BimfaceException

删除业务挂接

参数:: integrateId -; businessType -; businessFlag -; elementIds -
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteAssociationsByBizIds

public void deleteAssociationsByBizIds(String integrateId,
                                       String businessType,
                                       String businessFlag,
                                       List<String> businessIds)
                                throws com.bimface.exception.BimfaceException

删除业务挂接

参数:: integrateId -; businessType -; businessFlag -; businessIds -
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getModelCompareElementChange

public com.bimface.data.bean.ModelCompareChange getModelCompareElementChange(Long comparisonId,
                                                                             Long previousFileId,
                                                                             String previousElementId,
                                                                             Long followingFileId,
                                                                             String followingElementId)
                                                                      throws com.bimface.exception.BimfaceException

获取模型构件对比差异, v2

参数:: comparisonId -; previousFileId -; previousElementId -; followingFileId -; followingElementId -
返回:: ModelCompareChange
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getModelCompareTree

public com.bimface.data.bean.Tree getModelCompareTree(Long comparisonId)
                                               throws com.bimface.exception.BimfaceException

获取模型对比构件分类树, v2

参数:: comparisonId -
返回:: Tree
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getModelCompareResult

public com.bimface.data.bean.Pagination<com.bimface.data.bean.ModelCompareDiff> getModelCompareResult(Long comparisonId,
                                                                                                      String family,
                                                                                                      String elementName,
                                                                                                      Integer page,
                                                                                                      Integer pageSize)
                                                                                               throws com.bimface.exception.BimfaceException

分页获取模型对比结果, v2

参数:: comparisonId -; family -; elementName -; page -; pageSize -
返回:: Pagination <ModelCompareDiff>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getMaterialOverrideSet

public com.bimface.data.bean.MaterialOverrideSetVO getMaterialOverrideSet(Long id)
                                                                   throws com.bimface.exception.BimfaceException

获取材质配置方案, v2

参数:: id -
返回:: MaterialOverrideSetVO
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getRfaFamilyPropertyNames
```
public List<String> getRfaFamilyPropertyNames(Long rfaFileId)
                                       throws com.bimface.exception.BimfaceException
```
获取rfa文件族属性key列表, v2

参数:

rfaFileId -

返回:

List <String>

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getRfaFamilyTypes

public List<com.bimface.data.bean.RfaFamilyType> getRfaFamilyTypes(Long rfaFileId)
                                                            throws com.bimface.exception.BimfaceException

rfa文件族类型列表, v2

参数:: rfaFileId -
返回:: List <RfaFamilyType>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getRfaFamilyTypeProperty

public com.bimface.data.bean.RfaFamilyTypeProperty getRfaFamilyTypeProperty(Long rfaFileId,
                                                                            String familyTypeGuid)
                                                                     throws com.bimface.exception.BimfaceException

获取rfa文件族类型属性列表, v2

参数:: rfaFileId -; familyTypeGuid -
返回:: RfaFamilyTypeProperty
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getElements

public List<com.bimface.data.bean.SearchElementIdsResp> getElements(String requestBody)
                                                             throws com.bimface.exception.BimfaceException

查询符合条件的构件ID列表

参数:: requestBody -
返回:: List <SearchElementIdsResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getElements

public List<com.bimface.data.bean.SearchElementIdsResp> getElements(String requestBody,
                                                                    Boolean includeOverrides)
                                                             throws com.bimface.exception.BimfaceException

查询符合条件的构件ID列表支持查询模型属性重写后符合条件的构件ID列表，需要设置请求参数includeOverrides的值为true

参数:: requestBody -; includeOverrides - 是否查询修改的属性
返回:: List <SearchElementIdsResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getRooms

public List<com.bimface.data.bean.SearchRoomIdsResp> getRooms(String requestBody)
                                                       throws com.bimface.exception.BimfaceException

查询roomId

参数:: requestBody - body
返回:: List <SearchRoomIdsResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getAreas

public List<com.bimface.data.bean.SearchAreaIdsResp> getAreas(String requestBody)
                                                       throws com.bimface.exception.BimfaceException

查询areaId

参数:: requestBody -
返回:: List <SearchAreaIdsResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getPropertyValues

public List<com.bimface.data.bean.PropertyValuesResp> getPropertyValues(List<String> targetIds,
                                                                        String targetType,
                                                                        List<String> properties)
                                                                 throws com.bimface.exception.BimfaceException

查询指定模型构件属性的所有可能值仅支持查询单模型，即targetType可填：file

参数:: targetIds - 目标ID; targetType - 目标类型; properties - 需要查询的属性列表
返回:: List <PropertyValuesResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getPropertyValues

public List<com.bimface.data.bean.PropertyValuesResp> getPropertyValues(List<String> targetIds,
                                                                        String targetType,
                                                                        List<String> properties,
                                                                        Boolean includeOverrides)
                                                                 throws com.bimface.exception.BimfaceException

查询指定模型构件属性的所有可能值仅支持查询单模型，即targetType可填：file 支持查询模型属性重写后构件的属性的所有可能值，需要设置请求参数includeOverrides的值为true

参数:: targetIds - 目标ID; targetType - 目标类型; properties - 需要查询的属性列表; includeOverrides - 是否查询修改的属性
返回:: List <PropertyValuesResp>
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getPaginationContextId
```
public String getPaginationContextId()
                              throws com.bimface.exception.BimfaceException
```
生成分页查询的ContextId

返回:

分页查询的ContextId

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getFileThumbnailUrl

public String getFileThumbnailUrl(Long fileId,
                                  Integer size)
                           throws com.bimface.exception.BimfaceException

获取缩略图url

参数:: fileId -; size -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getDwgPdfUrl
```
public String getDwgPdfUrl(Long dwgFileId)
                    throws com.bimface.exception.BimfaceException
```
获取DWG文件转换生成的pdf文件的url

参数:

dwgFileId -

返回:

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getDwgPreviewImageUrl

public String getDwgPreviewImageUrl(Long dwgFileId,
                                    String layoutName)
                             throws com.bimface.exception.BimfaceException

获取DWG文件转换生成的预览图片的url

参数:: dwgFileId -; layoutName -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileDataBagRootUrl
```
public String getFileDataBagRootUrl(Long fileId)
                             throws com.bimface.exception.BimfaceException
```
获取文件的数据包根URL

参数:

fileId -

返回:

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getIntegrateDatabagRootUrl

public String getIntegrateDatabagRootUrl(Long integrateId)
                                  throws com.bimface.exception.BimfaceException

获取集成数据包的根Url

参数:: integrateId -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileDatabagContent

public InputStream getFileDatabagContent(Long fileId)
                                  throws com.bimface.exception.BimfaceException

获取数据包下载流

参数:: fileId -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getFileDatabagSize

public Long getFileDatabagSize(Long fileId)
                        throws com.bimface.exception.BimfaceException

获取数据包大小

参数:: fileId -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getViewTokenBySceneId
```
public String getViewTokenBySceneId(Long sceneId)
                             throws com.bimface.exception.BimfaceException
```
获取viewToken，用于场景预览

参数:

sceneId - 场景id

返回:

String viewToken 预览凭证

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createSceneShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createSceneShare(Long sceneId)
                                                                        throws com.bimface.exception.BimfaceException

参数:: sceneId - 场景id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createSceneShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createSceneShare(Long sceneId,
                                                                               Integer activeHours)
                                                                        throws com.bimface.exception.BimfaceException

参数:: sceneId - 场景id
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

createSceneShare

public com.bimface.api.bean.compatible.response.ShareLinkBean createSceneShare(Long sceneId,
                                                                               String expireDate,
                                                                               Boolean needPassword)
                                                                        throws com.bimface.exception.BimfaceException

创建场景分享链接，带分享密码

参数:: sceneId - 场景id; expireDate - 过期日期; needPassword - 是否需要密码
返回:: ShareLinkBean
抛出:: com.bimface.exception.BimfaceException - BimfaceException

deleteSceneShare
```
public void deleteSceneShare(Long sceneId)
                      throws com.bimface.exception.BimfaceException
```
取消场景分享

参数:

sceneId - 场景id

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createScene

public com.bimface.scene.bean.CreateSceneResp createScene(com.bimface.scene.bean.CreateSceneRequest sceneInfo)
                                                   throws com.bimface.exception.BimfaceException

创建场景

参数:: sceneInfo - 场景信息
返回:: CreateSceneResp
抛出:: com.bimface.exception.BimfaceException - BimfaceException

updateScene

public String updateScene(Long sceneId,
                          com.bimface.scene.bean.CreateSceneRequest sceneInfo)
                   throws com.bimface.exception.BimfaceException

更新场景

参数:: sceneId - 场景id; sceneInfo - 场景信息
返回:: 更新结果
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getScene

public com.bimface.scene.bean.response.SceneInfoResponse getScene(Long sceneId)
                                                           throws com.bimface.exception.BimfaceException

获取场景

参数:: sceneId - 场景id
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getViewTokenByClashDetectiveId
```
public String getViewTokenByClashDetectiveId(Long clashDetectiveId)
                                      throws com.bimface.exception.BimfaceException
```
获取viewToken, 用于碰撞检测

参数:

clashDetectiveId - 碰撞id

返回:

抛出:

com.bimface.exception.BimfaceException - BimfaceException

createClashDetective

public com.bimface.api.bean.response.clashDetective.ClashDetectiveResponse createClashDetective(com.bimface.api.bean.request.clashDetective.ClashDetectiveRequest request)
                                                                                         throws com.bimface.exception.BimfaceException

发起碰撞检测

参数:: request -
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryClashDetective

public com.bimface.api.bean.response.clashDetective.ClashDetectiveResponse queryClashDetective(Long clashDetectiveId)
                                                                                        throws com.bimface.exception.BimfaceException

获取碰撞检测状态

参数:: clashDetectiveId - 碰撞检测id
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

queryClashDetectiveByModelId

public com.bimface.api.bean.response.clashDetective.ClashDetectiveList queryClashDetectiveByModelId(Long fileId,
                                                                                                    Long integrateId)
                                                                                             throws com.bimface.exception.BimfaceException

根据模型ID查询碰撞检测ID列表

参数:: fileId - 文件id; integrateId - 集成id
返回:
抛出:: com.bimface.exception.BimfaceException - BimfaceException

getClashDetectiveResult
```
public Object getClashDetectiveResult(Long clashDetectiveId)
                               throws com.bimface.exception.BimfaceException
```
获取碰撞检测的结果

参数:

clashDetectiveId - 碰撞检测id

返回:

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getCredential
```
public Credential getCredential()
```

getEndpoint
```
public Endpoint getEndpoint()
```

getAccessTokenService

public AccessTokenService getAccessTokenService()

getFileService
```
public FileService getFileService()
```

getTranslateService

public TranslateService getTranslateService()

getViewTokenService

public ViewTokenService getViewTokenService()

getShareLinkService

public ShareLinkService getShareLinkService()

getPropertyService

public PropertyService getPropertyService()

getSignatureService

public SignatureService getSignatureService()

getDownloadService

public DownloadService getDownloadService()

getElementService

public ElementService getElementService()

getCategoryService

public CategoryTreeService getCategoryService()

getOfflineDatabagService

public OfflineDatabagService getOfflineDatabagService()

getBakeService
```
public BakeService getBakeService()
```

getDrawingSplitService

public DrawingSplitService getDrawingSplitService()

类 BimfaceClient

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

BimfaceClient

BimfaceClient

BimfaceClient

BimfaceClient

BimfaceClient

方法详细资料

getSupport

upload

upload

upload

upload

upload

getFileMetadata

getFile

getFiles

getFileUploadStatus

deleteFile

getPolicy

getPolicy

uploadByPolicy

uploadByPolicy

getDownloadUrl

getDownloadUrl

download

getHubList

getHubMeta

createProject

getProjectList

getProjectMeta

deleteProject

updateProject

getProjectRootFolderInfo

createFolder

getFolder

getChildrenFileItems

getFolderPathById

getParent

updateFolder

deleteFolder

uploadFileItem

uploadByUrl

createAppendFile

getAppendFile

appendUpload

copyFile

getFileItemPolicy

getFileItemMeta

getFileItemStatus

getDownloadURl

getFileItemPathById

downloadFiles

moveFile

fileRename

batchDeleteFileItems

initMultipartUpload

getMultipartSignedUrl

completeMultiPartUpload

abortMultiPartUpload

getAllVersions

createVersion

getFilePolicy

getVersion

getVersionSignedUrl

deleteVersion

getElements

getElements

getIntegrateElements

translate

translate

translate

getTranslate

getTranslates

translate2Bimtiles

fileTranslateList

compare