数据建模引擎CLI命令参考

根据唯一键为“是”的基本属性查询实例

hcloud iDMEClassicAPI ShowGetByUniqueKey

当数据模型中存在“唯一键”为“是”的基本属性时，可根据该属性查询实例数据。

去调试

查询实例的基础属性

hcloud iDMEClassicAPI ListUsingPost

本接口用于根据查询条件，分页检索数据模型实例的基础属性与系统级元数据信息。

去调试

查询实例的指定属性

hcloud iDMEClassicAPI ListSelectUsingPost

本接口用于根据查询条件，按需返回数据模型实例的指定属性信息。

去调试

另存实例数据

hcloud iDMEClassicAPI SaveAsUsingPost

本接口用于对指定数据模型的数据实例执行另存为（SaveAs）操作。系统将以指定的源实例为模板，克隆其数据并生成一条全新的实例记录。

去调试

根据唯一键为“是”的属性更新实例数据

hcloud iDMEClassicAPI SaveAllUsingPost

本接口用于根据数据模型中“唯一键”为“是”的属性（业务唯一键），对数据实例执行全量保存或更新操作。

去调试

批量查询实例

hcloud iDMEClassicAPI BatchShowGetUsingPost

本接口用于根据数据实例的系统唯一标识（id）列表，批量查询指定数据模型下多个实例的完整详细信息。

去调试

查询实例详情

hcloud iDMEClassicAPI ShowGetUsingPost

本接口用于根据数据实例的唯一编码（id），查询指定数据模型下单个数据实例的完整详细信息。

去调试

统计指定数据模型的实例总数

hcloud iDMEClassicAPI CountUsingPost

本接口用于根据指定的查询条件，统计指定数据模型中满足条件的实例总数。

去调试

查询指定数据模型的实例统计信息

hcloud iDMEClassicAPI ShowStaticsUsingPost

本接口用于根据指定的聚合函数与分组条件，对指定数据模型的实例数据进行统计计算（如计数、求平均值、求最大/最小值等）。

去调试

根据“列表属性”为“是”的属性查询实例

hcloud iDMEClassicAPI ListQueryUsingPost

当数据模型中存在“列表属性”为“是”的属性时，可通过此接口查询数据模型中的实例数据，且支持分页。

去调试

根据指定条件更新实例

hcloud iDMEClassicAPI UpdateByConditionUsingPost

本接口用于根据指定的过滤条件，批量更新指定数据模型下满足条件的所有数据实例。

去调试

批量更新实例

hcloud iDMEClassicAPI BatchUpdateUsingPost

本接口用于批量更新指定数据模型中的多个实例数据。如果请求列表中某个实例的唯一编码（id）在系统中不存在，系统将跳过该实例，不执行任何更新操作，且不会因此导致整个批量请求失败。

去调试

更新实例

hcloud iDMEClassicAPI UpdateUsingPost

本接口用于更新指定数据模型中的一个实例数据。如果请求中指定的实例唯一编码（id）不存在，接口将不会执行任何更新操作，也不会返回错误。

去调试

根据指定条件软删除实例

hcloud iDMEClassicAPI ShowLogicalDeleteByConditionUsingPost

本接口用于根据指定的过滤条件，批量对指定数据模型下满足条件的所有数据实例执行软删除（逻辑删除）操作。

去调试

根据指定条件删除实例

hcloud iDMEClassicAPI DeleteByConditionUsingPost

本接口用于根据指定的过滤条件，批量删除指定数据模型下满足条件的所有数据实例。

去调试

批量软删除实例

hcloud iDMEClassicAPI BatchDeleteLogicalUsingPost

本接口用于根据数据实例的唯一编码（id）列表，批量对指定数据模型下的多个数据实例执行软删除（逻辑删除）操作。

去调试

软删除实例

hcloud iDMEClassicAPI ShowLogicalDeleteUsingPost

本接口用于根据数据实例的唯一编码（id），对指定数据模型下的单个数据实例执行软删除（逻辑删除）操作。

去调试

批量删除实例

hcloud iDMEClassicAPI BatchDeleteUsingPost

本接口用于根据数据实例的唯一编码（id）列表，批量删除指定数据模型中的多个数据实例。

去调试

删除实例

hcloud iDMEClassicAPI DeleteUsingPost

本接口用于根据数据实例的唯一编码（id），删除指定数据模型中的一个数据实例。

去调试

批量创建实例

hcloud iDMEClassicAPI BatchCreateUsingPost

本接口用于在指定的数据模型（数据实体或关系实体）下，批量创建多个数据实例。调用成功后，将返回所有成功创建的实例信息列表。

去调试

创建实例

hcloud iDMEClassicAPI CreateUsingPost

本接口用于在指定的数据模型（数据实体或关系实体）下创建数据实例。调用成功后，将返回新创建实例的详细信息。

去调试

根据唯一键为“是”的属性更新实例的指定字段

hcloud iDMEClassicAPI SaveUsingPost

本接口用于根据数据模型中“唯一键”为“是”的属性（业务唯一键），对数据实例执行指定字段的保存或更新操作。

去调试

分页查询实例

hcloud iDMEClassicAPI ShowFindUsingPost

本接口用于分页查询指定数据模型中的数据实例列表。

去调试

分页查询数据实例的统计信息

hcloud iDMEClassicAPI ShowStaticsPage

本接口用于根据指定的聚合函数与分组条件，对指定数据模型的实例数据进行统计计算，并支持对分组后的统计结果进行分页返回。

去调试

批量更新并检入M-V模型数据实例

hcloud iDMEClassicAPI BatchUpdateAndCheckin

本接口用于批量更新一个或多个指定的M-V模型数据实例，并在更新成功后自动执行检入（Check-in）操作，将实例从“检出”状态切换为“已检入”状态。

去调试

批量检出并更新M-V模型

hcloud iDMEClassicAPI BatchCheckoutAndUpdate

本接口用于根据主对象ID（masterId）列表，对指定的多个Master-Branch-Version（M-V）模型实例批量执行检出（Check-out）并同步更新（Update）的原子操作。

去调试

更新并检入M-V模型数据实例

hcloud iDMEClassicAPI UpdateAndCheckin

本接口用于更新指定M-V模型实例的数据，并同步完成检入操作，即一步完成“修改-提交”流程。

去调试

检出并更新M-V模型

hcloud iDMEClassicAPI CheckoutAndUpdate

本接口用于根据主对象ID（masterId），对指定的Master-Branch-Version（M-V）模型实例执行检出（Check-out）并同步更新（Update）的原子操作。

去调试

批量软删除最新大版本下的所有小版本

hcloud iDMEClassicAPI BatchDeleteLogicalBranch

本接口用于根据主对象ID（masterIds）列表，批量软删除指定M-V模型实例中最新分支（Branch）下的所有迭代版本（Iteration）。

去调试

批量删除最新大版本下的所有小版本

hcloud iDMEClassicAPI BatchDeleteBranch

本接口用于根据主对象ID（masterIds）列表，批量删除指定M-V模型实例中最新分支（Branch）下的所有迭代版本（Iteration）。

去调试

管理员批量撤销检出M-V模型数据实例

hcloud iDMEClassicAPI BatchCheckoutUndoByAdmin

本接口用于管理员批量撤销Master-Branch-Version（M-V）模型实例的检出状态，将实例数据批量还原至检出前的最后检入版本内容。适用于数据治理中大规模清理长期锁定实例、批量处理离职员工未检入数据、系统维护前统一释放编辑锁等管理场景。

去调试

管理员撤销检出M-V模型数据实例

hcloud iDMEClassicAPI CheckoutUndoByAdmin

本接口用于管理员强制撤销Master-Branch-Version（M-V）模型实例的检出状态，将实例数据还原至检出前的最后检入版本内容。适用于数据治理中因用户离职、会话超时、误操作等导致的实例长期锁定场景。

去调试

对比M-V模型实例

hcloud iDMEClassicAPI CompareBusinessVersion

本接口用于根据主对象ID（id），获取指定Master-Branch-Version（M-V）模型下两个不同版本实例的完整数据快照，以便进行属性与关系的差异对比。

去调试

软删除M-V模型实例下最新分支的所有小版本数据

hcloud iDMEClassicAPI DeleteLogicalBranch

本接口用于根据主对象ID（masterId）和修订版本号（version），软删除指定M-V模型实例中最新分支（Branch）下的所有迭代版本（Iteration）。

去调试

删除最新大版本下的所有小版本

hcloud iDMEClassicAPI DeleteBranch

本接口用于根据主对象ID（masterId）和修订版本号（version），删除指定M-V模型实例中最新分支（Branch）下的所有迭代版本（Iteration）。

去调试

软删除版本对象下最新分支的最新版本实例数据

hcloud iDMEClassicAPI DeleteLogicalLatestVersion

本接口用于根据主对象ID，软删除指定M-V模型实体下最新分支的最新版本数据实例。

去调试

删除版本对象下最新分支的最新版本实例数据

hcloud iDMEClassicAPI DeleteLatestVersion

本接口用于根据主对象ID（masterId），精准删除指定Master-Branch-Version（M-V）模型在特定分支下的最新（末端）版本实例。

去调试

批量修订并更新M-V模型数据实例

hcloud iDMEClassicAPI BatchUpdateAndRevise

根据主对象ID批量修订并更新M-V模型数据实例，即修订后实例的“version.修订版本”更新为新的修订版本，并同时更新该实例的信息。

去调试

修订并更新M-V模型数据实例

hcloud iDMEClassicAPI UpdateAndRevise

本用于修订一个指定的M-V模型数据实例，并在修订生成新版本的同时，更新该新实例的业务数据。

去调试

批量修订M-V模型数据实例

hcloud iDMEClassicAPI BatchExecuteRevise

本接口用于批量修订一个或多个指定的M-V模型数据实例。修订操作会基于当前实例创建一个新的修订版本，并自动将新实例的version字段更新为下一个修订版本号（例如从A升级到B）。修订后的新实例默认处于“已检入”状态。

去调试

修订M-V模型数据实例

hcloud iDMEClassicAPI ExecuteRevise

本接口用于对指定的Master-Branch-Version（M-V）模型实例执行修订（Revise）操作。

去调试

批量检入M-V模型数据实例

hcloud iDMEClassicAPI BatchCheckin

本接口用于根据主对象ID批量检入M-V模型数据实例。已检入的数据实例会生成一个新的迭代版本，并将数据存储至系统中。

去调试

检入M-V模型数据实例

hcloud iDMEClassicAPI Checkin

根据主对象ID检入M-V模型数据实例。已检入的数据实例会生成一个新的迭代版本，并将数据存储至系统中。

去调试

批量撤销检出M-V模型数据实例

hcloud iDMEClassicAPI BatchCheckoutUndo

本接口用于批量撤销指定M-V模型实例的检出，将实例数据批量还原至检出前的内容。

去调试

撤销检出M-V模型数据实例

hcloud iDMEClassicAPI CheckoutUndo

本接口用于撤销指定M-V模型实例的检出状态。

去调试

批量检出M-V模型数据实例

hcloud iDMEClassicAPI BatchCheckout

本接口用于根据主对象ID（masterId）列表，对指定的多个Master-Branch-Version（M-V）模型实例批量执行检出（Check-out）操作。

去调试

检出M-V模型数据实例

hcloud iDMEClassicAPI Checkout

本接口用于根据主对象ID（masterId），对指定的M-V模型数据实例执行检出（Check-out）操作。

去调试

获取指定版本的M-V模型实例数据

hcloud iDMEClassicAPI ShowVersionByMaster

本接口用于根据主对象ID、迭代版本和版本号，查询M-V模型实例的详细版本信息。

去调试

获取指定M-V模型实例的版本列表

hcloud iDMEClassicAPI ListAllVersions

本接口用于根据主对象ID（masterId），分页获取指定Master-Branch-Version（M-V）模型实例的所有版本信息（包含对应版本下的属性信息）。

去调试

批量升级M-V模型实例的版本号

hcloud iDMEClassicAPI BatchUpdateVersion

本接口用于根据数据实例的唯一标识（id），批量更新/升级指定Master-Branch-Version（M-V）模型实例的版本号信息（包括修订版本version和迭代版本iteration）。

去调试

管理员批量更新M-V模型数据实例

hcloud iDMEClassicAPI BatchUpdateByAdmin

本接口用于管理员批量强制更新Master-Branch-Version（M-V）模型数据实例，适用于数据治理中的大规模紧急数据修正、批量版本回滚、全量属性修正等管理场景。对于批量中的每个实例，若其唯一编码不存在，则该实例不做任何更新操作，不影响其他实例的正常更新。

去调试

管理员更新M-V模型数据实例

hcloud iDMEClassicAPI UpdateByAdmin

本接口用于管理员强制更新Master-Branch-Version（M-V）模型数据实例，适用于数据治理中的紧急数据修正、版本回滚、批量属性修正等管理场景。当实例的唯一编码不存在时，系统将不做任何更新操作。

去调试

批量删除版本对象下最新分支的最新版本实例数据

hcloud iDMEClassicAPI BatchDeleteLatestVersion

本接口用于根据多个主对象（Master）ID，批量永久删除指定M-V模型实体下最新分支的最新版本数据实例。此操作为物理删除，执行后数据将无法恢复，请谨慎使用。

去调试

批量软删除版本对象下最新分支的最新版本实例数据

hcloud iDMEClassicAPI BatchDeleteLogicalLatestVersion

本接口用于根据主对象ID（masterIds）列表，批量软删除指定M-V模型实体下最新分支的最新版本数据实例。

去调试

生效模型数据实例

hcloud iDMEClassicAPI EnableDataInstance

本接口用于批量将指定数据模型中处于失效状态的数据实例重新标记为生效状态，并同步返回实际生效成功的实例数量。

去调试

失效模型数据实例

hcloud iDMEClassicAPI DisableDataInstance

本接口用于批量将指定数据模型的数据实例标记为失效状态，并同步返回实际失效成功的实例数量。

去调试

生成新模型业务编码

hcloud iDMEClassicAPI GenerateBusinessCode

本接口用于根据指定数据模型在应用设计态预配置的“业务编码生成器”规则，自动生成符合企业命名规范的业务流水码。

去调试

查询指定数据实例的标签详情

hcloud iDMEClassicAPI ShowTag

本接口用于查询指定模型的数据实例已绑定的所有标签详情，返回标签的完整定义信息及所属标签组信息。

去调试

解绑标签

hcloud iDMEClassicAPI RemoveTag

本接口用于为指定数据模型的数据实例解绑标签，移除实例与标签之间的关联关系。

去调试

绑定标签

hcloud iDMEClassicAPI AddTag

本接口用于为指定数据模型的数据实例绑定预定义的标签。

去调试

设置生命周期的状态

hcloud iDMEClassicAPI UpdateState

本接口用于修改或切换数据实例所绑定的生命周期状态，支持单个或批量实例的状态更新。

去调试

切换生命周期模板

hcloud iDMEClassicAPI SwitchLifecycleTemplate

本接口用于为指定模型的数据实例切换绑定的生命周期模板，并同时指定实例在新模板中的生命周期状态。

去调试

数据实例指定版本对比

hcloud iDMEClassicAPI CompareVersion

本接口用于对比指定数据实例两个版本之间的属性差异和关系差异，返回基础版本对象及差异对比结果。

去调试

分页查询模型历史版本信息

hcloud iDMEClassicAPI ListHistoryData

本接口用于分页查询指定数据实例的历史版本信息。系统以数据实例的最后修改时间作为查询条件，根据您指定的时间范围返回该实例的历史版本变更记录。

去调试

根据时间范围获取模型的历史记录数

hcloud iDMEClassicAPI CollectHistoryData

本接口用于根据指定的时间范围，获取数据模型的历史操作统计记录数，包括创建实例、更新实例、删除实例及软删除实例的数量。

去调试

更新M-V模型数据实例的多维视图属性

hcloud iDMEClassicAPI UpdateView

本接口用于更新指定M-V模型实例的多维视图属性。

去调试

批量创建多维视图

hcloud iDMEClassicAPI BatchCreateView

本接口用于批量为指定的一个或多个M-V模型数据实例创建新的多维视图。多维视图允许用户从不同的预设维度（如设计视图、工艺视图、采购视图等）来观察和管理同一个数据对象。在同一个数据实例下，视图的标识（item）必须是唯一的。

去调试

创建多维视图

hcloud iDMEClassicAPI CreateView

本接口用于为指定的M-V模型数据实例创建一个新的多维视图。多维视图允许用户从不同的预设维度（如设计视图、工艺视图、采购视图等）来观察和管理同一个数据对象，每个视图下的属性或关系可以独立配置和演进。在同一个数据实例下，视图的标识（item）必须是唯一的。

去调试

通过目标模型删除关系实体的数据实例

hcloud iDMEClassicAPI DeleteTarget

本接口用于通过目标模型删除关系实体的数据实例，即解除源模型实例与目标模型实例之间的关联关系。

去调试

通过源模型实例ID查询关联的目标模型实例

hcloud iDMEClassicAPI ListQueryTarget

本接口用于通过源模型的数据实例ID，分页查询并返回与该实例关联的目标模型数据实例信息。返回的实例信息包含目标模板的“列表属性”（即模型中标记为列表展示的属性）。

去调试

查询关系实体的数据实例

hcloud iDMEClassicAPI ListQueryRelationship

本接口用于分页查询关系实体的数据实例。通过指定数据实例ID及对应的关系角色（源/目标），或数据模型的英文名称及对应的关系角色（源类型/目标类型），返回匹配的关系实体数据实例信息。

去调试

批量查询关系实体关联模型的信息

hcloud iDMEClassicAPI ListBatchQueryRelatedObjects

本接口用于批量查询指定关系实体所关联的源模型或目标模型的所有实例信息，返回结果包含实例的具体属性。

去调试

查询关系实体关联模型的信息

hcloud iDMEClassicAPI ListQueryRelatedObjects

本接口用于分页查询指定关系实体所关联的源模型或目标模型的所有实例信息，返回结果包含关联实例的具体属性。

去调试

刷新树形节点

hcloud iDMEClassicAPI Refresh

本接口用于刷新指定数据实例对应的节点全路径。在调用本接口前请确保数据模型具有“树形结构”功能。

去调试

获取根节点

hcloud iDMEClassicAPI ShowGetRoot

本接口用于获取指定数据实例所在树形结构的根节点信息。当需要追溯BOM（物料清单）的顶层装配节点、查找组织架构的顶层部门或定位产品分类的顶级类目时，可调用本接口获取目标节点的根节点。

去调试

获取所有父节点

hcloud iDMEClassicAPI ListGetAllParentList

本接口用于获取指定数据实例的所有父节点列表，同时返回各父节点的列表属性。

去调试

获取父节点

hcloud iDMEClassicAPI ShowGetParent

本接口用于获取指定数据实例的直接父节点，同时返回父节点的列表属性。当需要查询BOM（物料清单）中某个零部件的直接上级装配节点、查看组织架构中某个部门的直接汇报部门或获取产品分类的直接上级类目时，可调用本接口获取直接父节点信息。

去调试

获取子节点

hcloud iDMEClassicAPI ListGetChildList

本接口用于分页获取指定数据实例的直接子节点列表，同时返回各子节点的列表属性。当需要展开BOM（物料清单）的某个装配节点查看下级零部件、浏览组织架构中某个部门的下属团队或查看产品分类的下一级类目时，可调用本接口获取直接子节点信息。

去调试

批量移除实例的子节点

hcloud iDMEClassicAPI BatchRemoveChildNode

本接口用于批量移除指定数据实例的子节点，解除父子节点间的层级关联关系。当BOM（物料清单）结构发生变更需要拆解某个装配节点、组织架构调整需要撤销某个部门的下属团队归属，或产品分类体系重组需要移除下级类目时，可调用本接口批量解除子节点关联。

去调试

批量添加实例的子节点

hcloud iDMEClassicAPI BatchAddChildNode

本接口用于批量为指定数据实例添加子节点，建立父子层级关联关系。当BOM（物料清单）需要新增子装配节点、组织架构需要新增下属团队或产品分类需要新增下级类目时，可调用本接口批量完成节点挂载。

去调试

添加数据分类

hcloud iDMEClassicAPI AddToCategory

本接口用于将数据实例添加到指定分类。当需要对零部件、设备、物料等数据实例进行归类管理（如按功能模块、产品线、工艺类型等维度分类）时，可调用本接口建立实例与分类的关联关系。

去调试

移除数据分类

hcloud iDMEClassicAPI RemoveFromCategory

本接口用于数据实例从指定分类中移除。当零部件变更产品线、设备调整工艺归属或物料重新归类时，可调用本接口解除实例与分类的关联关系。

去调试

获取Token信息

hcloud iDMEClassicAPI ShowGetTokens

本接口用于通过文档ID和认证类型获取结构化文档的访问Token。获取Token后，可在Token有效期内对指定结构化文档进行只读或读写操作。

去调试

创建结构化文档

hcloud iDMEClassicAPI CreateDocument

本接口用于在指定数据模型下创建结构化文档。结构化文档是工业数据管理中用于承载设计说明书、工艺卡片、BOM清单等工业文档的载体，支持目录（directory）、Page文档（pageDocument）、Board文档（boardDocument）、Mind文档（mindDocument）、Draw文档（drawDocument）等多种文档类型。

去调试

更新文档标题

hcloud iDMEClassicAPI UpdateDocument

本接口用于更新结构化文档的标题信息。当文档标题需要随产品版本迭代、工艺变更或项目阶段调整时，可调用本接口修改文档标题。

去调试

查询结构化文档

hcloud iDMEClassicAPI ListQueryDocuments

本接口用于查询指定数据模型下的结构化文档列表。

去调试

批量更新结构化文档

hcloud iDMEClassicAPI BatchUpdateDocument

本接口用于批量更新结构化文档的属性信息。

去调试

批量删除结构化文档

hcloud iDMEClassicAPI BatchDeleteStructuredDocument

本接口用于批量删除指定数据模型下的结构化文档。当产品下线、项目归档或文档批量清理时，可调用本接口一次性删除多个结构化文档，提升数据管理效率。

去调试

批量创建分享结构化文档

hcloud iDMEClassicAPI BatchCreateShareDocs

本接口用于批量创建结构化文档的分享记录，实现文档的跨用户或跨团队协作共享。当需要将产品设计说明书、工艺卡片、BOM清单等结构化文档共享给团队成员、上下游合作伙伴或全体用户时，可调用本接口一次性完成批量分享配置。

去调试

批量删除结构化文档分享权限

hcloud iDMEClassicAPI BatchDeleteShareDocs

本接口用于批量删除结构化文档的分享权限记录，撤销已共享文档的访问权限。当项目结束、人员岗位变动或文档权限需要回收时，可调用本接口一次性撤销多个用户的文档分享权限。

去调试

查询结构化文档分享授权列表

hcloud iDMEClassicAPI ListQueryShareDocs

本接口用于查询指定结构化文档的分享授权列表，获取该文档的所有分享记录信息。当需要审计文档的共享范围、回收过期权限或排查文档访问异常时，可调用本接口获取完整的分享授权信息。

去调试