操作

实体模型中的操作可以具有零个或多个参数，并且可以指定返回类型。

Chore.Activate

激活杂项。

新增: 10.2.2.1

IsBound: true

表 1. 激活参数
名称 详细信息

杂项

要激活的杂项。

类型: tm1.Chore

可空 :false

Dimension.AddAllLeavesHierarchy

将所有叶层次结构添加到单个层次结构维度，并隐式地将该维度转换为多层次结构维度。

已添加: 11.0.0

IsBound: true

表 2。 AddAllLeavesHierarchy 参数
名称 详细信息

维度

要转换为多层次结构维度并将所有叶层次结构添加到的维度。

类型: tm1.Dimension

可空 :false

AllLeavesHierarchyName

所有叶层次结构的名称 (缺省值为 "叶")

类型: Edm.String

可见

指示新所有叶层次结构的可视属性是否应设置为 true (缺省值为 false) 的布尔值。

类型: Edm.Boolean
表 3。 AddAllLeavesHierarchy 返回类型
Type 详细信息
tm1.Hierarchy

新创建的所有叶层次结构。

可空 :false

BeginChangeSet

开始变更集。

已添加: 10.2.2.6

IsBound: false

表 4。 BeginChangeSet 返回类型
Type 详细信息
Edm.String

已开始的变更集的标识。

可空 :false

Thread.CancelOperation

取消操作。

新增: 10.2.2.1

IsBound: true

表 5。 CancelOperation 参数
名称 详细信息

线程

应该取消操作的线程。

类型: tm1.Thread

可空 :false

Cube.CheckFeeders

返回未正确填充的合并组件的列表。

已添加: 11.1.0

IsBound: true

表 6。 CheckFeeders 参数
名称 详细信息

多维数据集

包含应检查的单元格的多维数据集。

类型: tm1.Cube

可空 :false

Tuple

应检查的单元格的坐标。

类型: 集合 (tm1.Element)
表 7。 CheckFeeders 返回类型
Type 详细信息
集合 (tm1.FedCellDescriptor)

收集未正确填充的合并组件。

可空 :false

Cube.CheckRules

检查多维数据集规则中是否存在错误。

已添加: 11.1.0

IsBound: true

表 8。 CheckRules 参数
名称 详细信息

多维数据集

包含要检查的规则的多维数据集。

类型: tm1.Cube

可空 :false
表 9。 CheckRules 返回类型
Type 详细信息
集合 (tm1.RuleSyntaxError)

规则中的错误集。 如果未返回任何错误，那么规则是正确的。

可空 :false

Session.Close

关闭会话。

已添加: 10.2.2.5

IsBound: true

表 10. 关闭参数
名称 详细信息

会话

正在关闭的会话。

类型: tm1.Session

可空 :false

Process.Compile

已添加: 11.0.0

IsBound: true

表 11. 编译参数
名称 详细信息

进程

类型: tm1.Process

可空 :false
表 12. 编译返回类型
Type 详细信息
集合 (tm1.ProcessSyntaxError)  

CompileProcess

已添加: 11.0.0

IsBound: false

表 13. CompileProcess 参数
名称 详细信息

进程

类型: tm1.Process

可空 :false
表 14. CompileProcess 返回类型
Type 详细信息
集合 (tm1.ProcessSyntaxError)  

ProcessDebugContext.Continue

继续执行已暂停的进程调试上下文。

IsBound: true

表 15. 继续参数
名称 详细信息

上下文

要继续的调试上下文。

类型: tm1.ProcessDebugContext

可空 :false
表 16. 继续返回类型
Type 详细信息
tm1.ProcessDebugContext  

Entry.Copy

复制条目。

已添加: 11.2.0

IsBound: true

表 17. 复制参数
名称 详细信息

条目

要复制的源条目。

类型: tm1.Entry

目标

目标文件夹。 如果未指定，那么将使用源条目的父代。

类型: tm1.Folder

私有

新条目是否应为私有条目。 如果未指定，那么将使用现有作用域。 如果目标文件夹是私有文件夹，那么不能为 true。

类型: Edm.Boolean

名称

新条目的名称。

类型: Edm.String
表 18. 复制返回类型
Type 详细信息
tm1.Entry

新的条目副本。

可空 :false

Hierarchy.CreateSessionSubset

在层次结构中创建会话范围的子集。

子集将具有生成的名称，并且不会在任何集合中列出。 可以按标识查找子集，使用 PATCH 和 DELETEd 进行编辑。 它们也可以由 MDX 查询中的标识使用，以代替子集名称。 如果存在具有所生成标识的指定子集，那么将改为在查询中使用指定子集 (公用或专用)。 这些子集不会持久存储，并且会在会话到期或注销时自动销毁。 无法从另一个会话中检索，修改或在 MDX 查询中使用这些内容。

IsBound: true

表 19. CreateSessionSubset 参数
名称 详细信息

层次结构

隐式第一个参数 (此操作与层次结构绑定)。

类型: tm1.Hierarchy

可空 :false

子集

可选。 要复制的子集 (如果值与实体引用一起提供) 或要使用的定义 (如果子集定义作为对象提供)。

如果省略此参数，那么将创建空子集。 对于子集定义，将忽略提供的名称，并且将生成标识。

类型: tm1.Subset
表 20. CreateSessionSubset 返回类型
Type 详细信息
tm1.Subset

将由绑定层次结构的 SessionSubsets 集合包含的新创建的会话范围的子集。

可空 :false

Chore.Deactivate

取消激活杂项。

新增: 10.2.2.1

IsBound: true

表 21. 取消激活参数
名称 详细信息

杂项

要取消激活的杂项。

类型: tm1.Chore

可空 :false

Process.Debug

对 Turbo Integrator 中定义的进程启动调试会话。

IsBound: true

表 22. 调试参数
名称 详细信息

进程

要为其启动调试会话的进程。

类型: tm1.Process

可空 :false

参数

覆盖模型中定义的缺省值 (数字或字符串)。

类型: 集合 (tm1.NameValuePair)
表 23. 调试返回类型
Type 详细信息
tm1.ProcessDebugContext  

DecryptDataFile

解密单个文件。 必须由完全管理员执行。

IsBound: false

表 24. DecryptDataFile 参数
名称 详细信息

SourcePath

要解密的文件的路径。

类型: Edm.String

DestinationPath

应该存储解密文件的目录的路径。 如果未指定，那么将解密并替换该文件。

类型: Edm.String

FileType

源文件的文件类型。

类型: tm1.EncryptionFileType

DecryptDataModel

解密数据模型。 必须由完全管理员执行。 将导致服务器关闭。

IsBound: false

表 25. DecryptDataModel 参数
名称 详细信息

TimeUntilShutdown

直到服务器关闭的时间，向上舍入到分钟。

类型: Edm.Duration

DeleteAnnotationArtifacts

除去所有与注释相关的控件多维数据集以及与整个模型的注释相关的所有内容，包括上下文构面，注释，附件等。 请谨慎使用此操作，因为无法将其撤销。

IsBound: false

Sandbox.DiscardChanges

将沙箱中的值重置回基本值。

IsBound: true

表 26. DiscardChanges 参数
名称 详细信息

沙箱

要重置的沙箱。

类型: tm1.Sandbox

可空 :false

User.Disconnect

断开用户连接，但允许处于活动状态的线程继续运行，直到它们完成为止。

已添加: 10.2.2.6

IsBound: true

表 27. 断开连接参数
名称 详细信息

用户

要断开连接的用户。

类型: tm1.User

可空 :false

EncryptDataFile

对单个文件进行加密。 必须由完全管理员执行。

IsBound: false

表 28. EncryptDataFile 参数
名称 详细信息

SourcePath

要加密的文件的路径。

类型: Edm.String

DestinationPath

应存储加密文件的目录的路径。 如果未指定，那么将对文件进行加密和替换。

类型: Edm.String

FileType

源文件的文件类型。

类型: tm1.EncryptionFileType

EncryptDataModel

对数据模型进行加密。 必须由完全管理员执行。 将导致服务器关闭。

IsBound: false

表 29. EncryptDataModel 参数
名称 详细信息

TimeUntilShutdown

直到服务器关闭的时间，向上舍入到分钟。

类型: Edm.Duration

EndChangeSet

结束变更集。

已添加: 10.2.2.6

IsBound: false

表 30. EndChangeSet 参数
名称 详细信息

ChangeSetID

要结束的变更集的标识。

类型: Edm.String

可空 :false
表 31. EndChangeSet 返回类型
Type 详细信息
Edm.Int64

EndChangeSet 操作的返回代码。

可空 :false

MDXView.Execute

针对模型运行视图。

IsBound: true

表 32. execute 参数
名称 详细信息

视图

要执行的视图，在 URL 的资源路径中指定。

类型: tm1.MDXView

可空 :false
表 33. 执行返回类型
Type 详细信息
tm1.Cellset

可空 :false

NativeView。执行

针对模型运行视图。

IsBound: true

表 34. execute 参数
名称 详细信息

视图

要执行的视图，在 URL 的资源路径中指定。

类型: tm1.NativeView

可空 :false

标题

要根据其分割视图的标题轴中的标题值。

只有当您想更改片集中的标题时，才需要编辑该参数。

类型: 集合 (tm1.Element)

SuppressEmptyColumns

没有值的列不会在结果集中返回。

类型: Edm.Boolean

SuppressEmptyRows

没有值的行不会在结果集中返回。

类型: Edm.Boolean
表 35. 执行返回类型
Type 详细信息
tm1.Cellset

可空 :false

NativeView.Execute 示例

下面是 NativeView.Execute 的示例：

POST /api/v1/Cubes('plan_BudgetPlan')/Views('Budget Input Total')/tm1.Execute?$expand=Axes($expand=Hierarchies/$ref,Tuples($expand=Members($select=Name,Attributes/AccountName))),Cells
  {
   "Titles":[
     {"@odata.id": "Dimensions('plan_version')/Hierarchies('plan_version')/Elements('FY 2004 Budget')"}
     ],
   "SuppressEmptyRows": true,
   "SuppressEmptyColumns": true
}

Process.Execute

运行 Turbo Integrator 中定义的进程。

不推荐: 11.3.0

IsBound: true

表 36. execute 参数
名称 详细信息

进程

指定进程。

未指定此值，因为它由 POST 操作的 URL 中指定的资源路径中的第一个参数获取。

类型: tm1.Process

可空 :false

参数

覆盖模型中定义的缺省值 (数字或字符串)。

类型: 集合 (tm1.NameValuePair)

CubeDrillthrough。执行

钻取到单元格。

已添加: 10.2.2.6

IsBound: true

表 37. execute 参数
名称 详细信息

drillThrough

要使用的穿透钻取。

类型: tm1.CubeDrillthrough

可空 :false
表 38. 执行返回类型
Type 详细信息
tm1.Cellset

可空 :false

RelationalDrillthrough。执行

钻取到单元格。

已添加: 10.2.2.6

IsBound: true

表 39. execute 参数
名称 详细信息

drillThrough

要使用的穿透钻取。

类型: tm1.RelationalDrillthrough

可空 :false
表 40. 执行返回类型
Type 详细信息
集合 (tm1.DrillthroughRow)

可空 :false

Chore.Execute

执行杂项。

新增: 10.2.2.2

IsBound: true

表 41. execute 参数
名称 详细信息

杂项

要执行的杂项。

类型: tm1.Chore

可空 :false

GitPullPlan.Execute

执行 Git 拉取计划。

新增: 11.5.0

IsBound: true

表 42. execute 参数
名称 详细信息

GitPlan

要执行的 Git 拉取计划。

类型: tm1.GitPullPlan

可空 :false

GitPushPlan.Execute

执行 Git 推送计划。

新增: 11.5.0

IsBound: true

表 43. execute 参数
名称 详细信息

GitPlan

要执行的 Git 推送计划。

类型: tm1.GitPushPlan

可空 :false

ExecuteChore

运行杂项。

新增: 11.1.1

IsBound: false

表 44. ExecuteChore 参数
名称 详细信息

杂项

指定要执行的杂项。

类型: tm1.Chore

可空 :false

ExecuteCubeDrillthrough

钻取到穿透钻取进程返回的多维数据集视图。

已添加: 11.2.0

IsBound: false

表 45. ExecuteCubeDrillthrough 参数
名称 详细信息

DrillthroughProcess

返回视图句柄的过程。

类型: tm1.Process

可空 :false

参数

进程使用的参数。

类型: 集合 (tm1.ProcessParameter)
表 46. ExecuteCubeDrillthrough 返回类型
Type 详细信息
tm1.Cellset

可空 :false

ExecuteMDX

在根级别运行 MDX 表达式。

新增: 10.2.2.1

IsBound: false

表 47. ExecuteMDX 参数
名称 详细信息

MDX

表示表达式的字符串值。 包含在请求的 POST 主体中。

类型: Edm.String

可空 :false
表 48. ExecuteMDX 返回类型
Type 详细信息
tm1.Cellset

一个单元格。

可空 :false

ExecuteMDXSetExpression

在根级别运行 MDX 集表达式。

已添加: 11.1.0

IsBound: false

表 49. ExecuteMDXSetExpression 参数
名称 详细信息

MDX

表示表达式的字符串值。 包含在请求的 POST 主体中。

类型: Edm.String

可空 :false
表 50. ExecuteMDXSetExpression 返回类型
Type 详细信息
tm1.CellsetAxis

表示表达式所描述的成员集的快照的单元格集轴

可空 :false

ExecuteProcess

运行 Turbo Integrator 中定义的进程。

已添加: 11.0.0

不推荐: 11.3.0

IsBound: false

表 51. ExecuteProcess 参数
名称 详细信息

进程

指定进程。

未指定此值，因为它由 POST 操作的 URL 中指定的资源路径中的第一个参数获取。

类型: tm1.Process

可空 :false

参数

覆盖模型中定义的缺省值 (数字或字符串)。

类型: 集合 (tm1.NameValuePair)

ExecuteProcessWithReturn

运行在 Turbo Integrator 中定义的进程并返回状态。

已添加: 11.3.0

IsBound: false

表 52. ExecuteProcessWithReturn 参数
名称 详细信息

进程

指定进程。

未指定此值，因为它由 POST 操作的 URL 中指定的资源路径中的第一个参数获取。

类型: tm1.Process

可空 :false

参数

覆盖模型中定义的缺省值 (数字或字符串)。

类型: 集合 (tm1.NameValuePair)
表 53. ExecuteProcessWithReturn 返回类型
Type 详细信息
tm1.ProcessExecuteResult

可空 :false

ExecuteRelationalDrillthrough

钻取到关系表。

已添加: 11.2.0

IsBound: false

表 54. ExecuteRelationalDrillthrough 参数
名称 详细信息

DrillthroughProcess

返回 SQL 或 CSV 表的句柄的流程。

类型: tm1.Process

可空 :false

参数

进程使用的参数。

类型: 集合 (tm1.ProcessParameter)
表 55. ExecuteRelationalDrillthrough 返回类型
Type 详细信息
集合 (tm1.DrillthroughRow)

可空 :false

ExecuteRelationalDrillthroughWithRowset

执行关系穿透钻取以获取关系表的行集。

新增: 11.6.0

IsBound: false

表 56. ExecuteRelationalDrillthroughWithRowset 参数
名称 详细信息

DrillthroughProcess

返回 SQL 或 CSV 表的句柄的流程。

类型: tm1.Process

可空 :false

参数

进程使用的参数。

类型: 集合 (tm1.ProcessParameter)
表 57. ExecuteRelationalDrillthroughWithRowset 返回类型
Type 详细信息
tm1.Rowset

可空 :false

Process.ExecuteWithReturn

运行在 Turbo Integrator 中定义的进程并返回状态。

已添加: 11.3.0

IsBound: true

表 58. ExecuteWithReturn 参数
名称 详细信息

进程

指定进程。

未指定此值，因为它由 POST 操作的 URL 中指定的资源路径中的第一个参数获取。

类型: tm1.Process

可空 :false

参数

覆盖模型中定义的缺省值 (数字或字符串)。

类型: 集合 (tm1.NameValuePair)
表 59. ExecuteWithReturn 返回类型
Type 详细信息
tm1.ProcessExecuteResult

可空 :false

RelationalDrillthrough.ExecuteWithRowset

深入到单元格以获取关系表的行集。

新增: 11.6.0

IsBound: true

表 60. ExecuteWithRowset 参数
名称 详细信息

drillThrough

要使用的穿透钻取。

类型: tm1.RelationalDrillthrough

可空 :false
表 61. ExecuteWithRowset 返回类型
Type 详细信息
tm1.Rowset

可空 :false

GitDeploy

使用指定 Git 存储库中的源来部署模型。

新增: 11.5.0

IsBound: false

表 62. GitDeploy 参数
名称 详细信息

URL 链接

远程 Git 存储库的 URL。

类型: Edm.String

可空 :false

用户名

远程 Git 存储库的用户名。

类型: Edm.String

可空 :false

密码

远程 Git 存储库的密码。

类型: Edm.String

可空 :false

Branch

要拉的树枝。

类型: Edm.String

可空 :false

部署

存储库实例的部署。

类型: Edm.String

强制

用于评估前置条件的标志。

类型: Edm.Boolean

可空 :false

GitInit

初始化 TM1 Server 的 Git 环境。

新增: 11.5.0

IsBound: false

表 63. GitInit 参数
名称 详细信息

URL 链接

远程 Git 存储库的 URL。

类型: Edm.String

可空 :false

用户名

远程 Git 存储库的用户名。

类型: Edm.String

密码

远程 Git 存储库的密码。

类型: Edm.String

部署

为当前 Git 操作选择的部署。

类型: Edm.String

强制

重置现有 Git 上下文并初始化。

类型: Edm.Boolean

可空 :false
表 64. GitInit 返回类型
Type 详细信息
tm1.Git

Git 状态。

可空 :false

GitPull

访存远程分支并创建包含将源从分支装入到服务器的操作的计划。

新增: 11.5.0

IsBound: false

表 65. GitPull 参数
名称 详细信息

用户名

远程 Git 存储库的用户名。

类型: Edm.String

可空 :false

密码

远程 Git 存储库的密码。

类型: Edm.String

可空 :false

Branch

要拉的树枝。

类型: Edm.String

可空 :false

ExecutionMode

Git 拉取计划的执行方式，即单个或多个落实。

类型: tm1.GitPlanExecutionMode

强制

用于评估前置条件的标志。

类型: Edm.Boolean

可空 :false
表 66. GitPull 返回类型
Type 详细信息
tm1.GitPlan

创建的 Git 拉取计划。

可空 :false

GitPush

生成源并使用这些文件来创建 Git 落实以推送到远程 Git 存储库。

新增: 11.5.0

IsBound: false

表 67. GitPush 参数
名称 详细信息

用户名

远程 Git 存储库的用户名。

类型: Edm.String

可空 :false

密码

远程 Git 存储库的密码。

类型: Edm.String

可空 :false

Branch

包含要用作要推送的新落实的父落实的落实的分支。

类型: Edm.String

可空 :false

NewBranch

要创建和推送的分支。

类型: Edm.String

消息

落实消息。

类型: Edm.String

可空 :false

编写者

落实作者的名称。

类型: Edm.String

可空 :false

电子邮件

落实作者的电子邮件。

类型: Edm.String

可空 :false

强制

用于评估前置条件的标志。

类型: Edm.Boolean

可空 :false
表 68. GitPush 返回类型
Type 详细信息
tm1.GitPlan

创建的 Git 推送计划。

可空 :false

GitStatus

检查 Git 状态。

新增: 11.5.0

IsBound: false

表 69. GitStatus 参数
名称 详细信息

用户名

远程 Git 存储库的用户名。

类型: Edm.String

密码

远程 Git 存储库的密码。

类型: Edm.String
表 70. GitStatus 返回类型
Type 详细信息
tm1.Git

Git 状态。

可空 :false

GitUninit

清除本地 Git 存储库并重置 Git 上下文。

新增: 11.5.0

IsBound: false

表 71. GitUninit 参数
名称 详细信息

强制

指示是否重置 Git 上下文的布尔值。

类型: Edm.Boolean

可空 :false

Cube.Load

将多维数据集装入到服务器上的内存中。

新增: 11.6.0

IsBound: true

表 72. 装入参数
名称 详细信息

多维数据集

要装入的多维数据集。

类型: tm1.Cube

可空 :false

Sandbox.Load

将沙箱装入到服务器上的内存中。

此操作将为沙箱实体设置 IsLoaded 属性。

IsBound: true

表 73. 装入参数
名称 详细信息

沙箱

要装入的沙箱。

类型: tm1.Sandbox

可空 :false

Cube.Lock

锁定多维数据集，阻止任何用户对其进行修改，直到多维数据集解锁为止。

IsBound: true

表 74. 锁定参数
名称 详细信息

多维数据集

要锁定的多维数据集。

类型: tm1.Cube

Dimension.Lock

锁定维度，阻止任何用户对其进行修改，直到该维度解锁为止。

IsBound: true

表 75. 锁定参数
名称 详细信息

维度

要锁定的维度。

类型: tm1.Dimension

Sandbox.Merge

将一个沙箱的值与另一个沙箱的值合并。

IsBound: true

表 76. 合并参数
名称 详细信息

源

要与目标沙箱合并的沙箱。

类型: tm1.Sandbox

可空 :false

目标

要合并到的沙箱目标。

类型: tm1.Sandbox

可空 :false

ConflictResolution

用于指示是使用源，目标还是单独解决冲突的枚举值。

类型: tm1.ConflictResolution

AllowQueueing

指示是否允许排队的布尔值。

类型: Edm.Boolean

CleanAfter

指示合并后是否清除沙箱的布尔值。

类型: Edm.Boolean

Entry.Move

将条目移动到新的父文件夹，重命名条目，并将其发布或私有化。

已添加: 11.2.0

IsBound: true

表 77. 移动参数
名称 详细信息

条目

要移动的条目。

类型: tm1.Entry

目标

目标文件夹。 如果未指定，那么将使用现有父代。

类型: tm1.Folder

私有

条目是否应为私有条目。 如果未指定，那么将使用现有作用域。 如果目标文件夹是私有文件夹，那么不能为 true。

类型: Edm.Boolean

名称

条目的新名称。

类型: Edm.String
表 78. 移动返回类型
Type 详细信息
tm1.Entry

移动的条目。

可空 :false

Sandbox.Publish

将沙箱的内容 (值) 发布回基本内容。

指定的沙箱仍可供使用，并且保持不变。

IsBound: true

表 79. 发布参数
名称 详细信息

沙箱

指定要发布的沙箱。

类型: tm1.Sandbox

可空 :false

ConflictResolution

用于指示是使用源，目标还是单独解决冲突的枚举值。

类型: tm1.ConflictResolution

AllowQueueing

指示是否允许排队的布尔值。

类型: Edm.Boolean

CleanAfter

指示合并后是否清除沙箱的布尔值。

类型: Edm.Boolean

RemoveOIDCKeyFromCache

从服务器高速缓存中除去 OIDC 密钥。 必须由完全管理员执行。

IsBound: false

表 80. RemoveOIDCKeyFromCache 参数
名称 详细信息

KeyId

可选。 要除去的密钥的集合。 如果省略此参数，那么将除去所有键。

类型: 集合 (Edm.String)

Cube.ReorderDimensions

对多维数据集的维度进行重新排序。

新增: 11.4.0

IsBound: true

表 81. ReorderDimensions 参数
名称 详细信息

多维数据集

应该对其维度进行重新排序的多维数据集。

类型: tm1.Cube

可空 :false

维度

维度的新顺序。

类型: 集合 (tm1.Dimension)
表 82. ReorderDimensions 返回类型
Type 详细信息
Edm.Double

由于新订单，多维数据集的内存使用百分比更改。

可空 :false

RotateDataModelKey

旋转模型键。 必须由完全管理员执行。

IsBound: false

Dimension.SaveAs

保存维度。

已添加: 11.0.0

IsBound: true

表 83. SaveAs 参数
名称 详细信息

维度

要保存的维度。

类型: tm1.Dimension

可空 :false

名称

要将维度另存为的名称。

类型: Edm.String

可空 :false

覆盖

指示是否覆盖已传入的维度 (如果已存在) 的布尔值。

类型: Edm.Boolean

KeepExistingAttributes

一个布尔值，用于指示是否覆盖维度的任何现有属性以及所有包含的对象，我们可能正在将其替换为覆盖。 如果未覆盖保存，并且此值设置为 true ，那么不会为新维度创建任何属性。

已添加: 11.0.0

类型: Edm.Boolean
表 84. SaveAs 返回类型
Type 详细信息
tm1.Dimension

已保存的维度。

可空 :false

Hierarchy.SaveAs

保存层次结构。

已添加: 11.0.0

IsBound: true

表 85. SaveAs 参数
名称 详细信息

层次结构

要保存的层次结构。

类型: tm1.Hierarchy

可空 :false

名称

要将层次结构另存为的名称。

类型: Edm.String

可空 :false

覆盖

一个布尔值，用于指示是否覆盖已传入的层次结构 (如果已存在)。

类型: Edm.Boolean

KeepExistingAttributes

一个布尔值，用于指示是否覆盖层次结构的任何现有属性以及所有包含的对象，我们可能正在将其替换为覆盖。 如果未覆盖保存，并且此值设置为 true ，那么将不会为新层次结构创建任何属性。

已添加: 11.0.0

类型: Edm.Boolean
表 86. SaveAs 返回类型
Type 详细信息
tm1.Hierarchy

已保存的层次结构。

可空 :false

Subset.SaveAs

保存子集。

已添加: 11.0.0

IsBound: true

表 87. SaveAs 参数
名称 详细信息

子集

要保存的子集。

类型: tm1.Subset

可空 :false

名称

要将子集另存为的名称。

类型: Edm.String

可空 :false

MakePrivate

指示是否将此子集另存为私有的布尔值。

类型: Edm.Boolean

MakeStatic

指示是否将此子集另存为静态的布尔值。

类型: Edm.Boolean
表 88. SaveAs 返回类型
Type 详细信息
tm1.Subset

已保存的子集。

可空 :false

Cellset.SaveViewAs

保存视图。

已添加: 11.0.0

IsBound: true

表 89. SaveViewAs 参数
名称 详细信息

单元格集

要保存其底层视图的单元格集。

类型: tm1.Cellset

可空 :false

名称

要将视图另存为的名称。

类型: Edm.String

可空 :false

覆盖

指示是否覆盖已传入的视图 (如果已存在) 的布尔值。

类型: Edm.Boolean

MakePrivate

指示是否将此视图另存为私有视图的布尔值。

类型: Edm.Boolean
表 90. SaveViewAs 返回类型
Type 详细信息
tm1.View

已保存的视图。

可空 :false

Element.SetComponent

设置特定元素的子元素，允许您指定与父元素的关系。

IsBound: true

表 91. SetComponent 参数
名称 详细信息

父代

要设置的父元素。

类型: tm1.Element

可空 :false

元素

要设置为此父代的子代的元素。

类型: tm1.Element

可空 :false

之前

指定应在其中创建新组件的位置。

如果指定 NULL ，那么会将新组件添加到集合的开头。 缺省情况下， POST 操作会附加到集合的末尾。

类型: tm1.Element

权重

元素的权重。

类型: Edm.Double

Hierarchy.SetElement

通过设置父代将元素插入指定位置。

IsBound: true

表 92. SetElement 参数
名称 详细信息

层次结构

将在其中插入元素的层次结构。

类型: tm1.Hierarchy

可空 :false

元素

要插入的元素。

类型: tm1.Element

可空 :false

之前

如果指定，那么在指定的元素之前插入该元素。

如果指定了 NULL ，那么会将新元素添加到集合的开头。 缺省情况下， POST 操作会附加到集合的末尾。

类型: tm1.Element

Subset.SetElement

将元素插入到指定位置的指定子集中。

已添加: 10.2.2.6

IsBound: true

表 93. SetElement 参数
名称 详细信息

子集

将在其中插入元素的子集。

类型: tm1.Subset

可空 :false

元素

要插入的元素。

类型: tm1.Element

可空 :false

之前

如果指定，那么在指定的元素之前插入该元素。

如果指定了 NULL ，那么会将新元素添加到集合的开头。 缺省情况下， POST 操作会附加到集合的末尾。

类型: tm1.Element

之后

如果指定，那么在指定的元素之后插入元素。

如果指定了 NULL ，那么会将新元素添加到集合的末尾。 缺省情况下， POST 操作会附加到集合的末尾。

类型: tm1.Element

Chore.SetServerLocalStartTime

设置服务器的本地启动时间。

新增: 10.2.2.1

IsBound: true

表 94. SetServerLocalStartTime 参数
名称 详细信息

杂项

要为其设置服务器启动时间的杂项。

类型: tm1.Chore

可空 :false

StartDate

要为此杂项设置的开始日期。

类型: Edm.Date

可空 :false

StartTime

要为此杂项设置的开始时间。

类型: Edm.TimeOfDay

可空 :false

ProcessDebugContext.StepIn

从进程运行单个语句。

如果该语句是 ExecuteProcess 函数调用，请在该进程内的第一个语句处暂停。

IsBound: true

表 95. StepIn 参数
名称 详细信息

上下文

调试上下文。

类型: tm1.ProcessDebugContext

可空 :false
表 96. StepIn 返回类型
Type 详细信息
tm1.ProcessDebugContext  

ProcessDebugContext.StepOut

恢复执行并运行，直到当前进程完成为止。

IsBound: true

表 97. StepOut 参数
名称 详细信息

上下文

调试上下文。

类型: tm1.ProcessDebugContext

可空 :false
表 98. StepOut 返回类型
Type 详细信息
tm1.ProcessDebugContext  

ProcessDebugContext.StepOver

从进程运行单个语句。

如果该语句是 ExecuteProcess 函数调用，请不要在函数调用中进行调试。

IsBound: true

表 99. StepOver 参数
名称 详细信息

上下文

调试上下文。

类型: tm1.ProcessDebugContext

可空 :false
表 100. StepOver 返回类型
Type 详细信息
tm1.ProcessDebugContext  

Cube.TraceCellCalculation

跟踪单个单元格的计算。 结果将以递归方式包含计算的任何组成部分。

已添加: 11.1.0

IsBound: true

表 101. TraceCellCalculation 参数
名称 详细信息

多维数据集

包含应跟踪的单元格的多维数据集。

类型: tm1.Cube

可空 :false

Tuple

应跟踪的单元格的坐标。

类型: 集合 (tm1.Element)
表 102. TraceCellCalculation 返回类型
Type 详细信息
tm1.CalculationComponent

表示跟踪的单元格及其计算的组成部分。

可空 :false

Cube.TraceFeeders

获取由指定单元格提供的单元格的列表。

已添加: 11.1.0

IsBound: true

表 103. TraceFeeders 参数
名称 详细信息

多维数据集

包含应跟踪的单元格的多维数据集。

类型: tm1.Cube

可空 :false

Tuple

应跟踪的单元格的坐标。

类型: 集合 (tm1.Element)
表 104. TraceFeeders 返回类型
Type 详细信息
tm1.FeederTrace

使用源单元格的数据加载程序语句以及生成的数据加载单元格的集合。

可空 :false

UndoChangeSet

还原变更集。

删除变更集将有效除去会话迄今为止所做的所有更改。

已添加: 10.2.2.6

IsBound: false

表 105. UndoChangeSet 参数
名称 详细信息

ChangeSetID

要还原的变更集的标识。

类型: Edm.String

可空 :false

Cube.Unload

从服务器上的内存中卸载多维数据集。

新增: 11.6.0

IsBound: true

表 106. 卸载参数
名称 详细信息

多维数据集

要卸载的多维数据集。

类型: tm1.Cube

可空 :false

Sandbox.Unload

从服务器上的内存中卸载沙箱。

此操作对于在不再需要资源时释放这些资源很有用。

IsBound: true

表 107. 卸载参数
名称 详细信息

沙箱

要卸载的沙箱。

类型: tm1.Sandbox

可空 :false

Cube.Unlock

解锁多维数据集，允许修改。

IsBound: true

表 108. 解锁参数
名称 详细信息

多维数据集

要解锁的多维数据集。

类型: tm1.Cube

Dimension.Unlock

解锁维度，允许修改。

IsBound: true

表 109. 解锁参数
名称 详细信息

维度

要解锁的维度。

类型: tm1.Dimension

Cellset.Update

根据提供的参数值，将更新应用于单元或单元范围。

IsBound: true

表 110. 更新参数
名称 详细信息

单元格集

以更新为目标的单元集，在 URL 的资源路径中指定。

类型: tm1.Cellset

可空 :false

BeginOrdinal

指定在更新单个单元格时要更新的单元格，或在更新多个单元格时范围的开始。

类型: Edm.Int64

可空 :false

EndOrdinal

更新单元格范围时的最后一个单元格位置。

类型: Edm.Int64

ReferenceCube

从中获取 ReferenceCell 数据的多维数据集。

类型: tm1.Cube

ReferenceCell

包含传播命令所需的源数据的单元格或片。

类型: 集合 (tm1.Element)

值

用于更新单元格的实际值 (通常是传播命令)。

类型: Edm.String

可空 :false

Cube.Update

根据提供的参数值，将更新应用于多维数据集，多维数据集的片或多维数据集的单元格。

新增: 10.2.2.1

IsBound: true

表 111. 更新参数
名称 详细信息

多维数据集

以更新为目标的多维数据集，在 URL 的资源路径中指定。

类型: tm1.Cube

可空 :false

切片

更新所针对的多维数据集的片。

类型: 集合 (tm1.Element)

单元格

以更新为目标的多维数据集的单元格。

类型: 集合 (tm1.CellDescriptor)

ReferenceCube

包含传播命令所需的源数据的多维数据集。

类型: tm1.Cube

ReferenceCell

包含传播命令所需的源数据的单元格。

类型: 集合 (tm1.Element)

值

用于更新单元格的实际值 (通常是传播命令)。

类型: Edm.String

可空 :false

更新

根据提供的参数值，将更新应用于多维数据集，多维数据集的片或多维数据集的单元格。

新增: 10.2.2.4

IsBound: false

表 112. 更新参数
名称 详细信息

多维数据集

以更新为目标的多维数据集，在 URL 的资源路径中指定。

类型: tm1.Cube

可空 :false

切片

更新所针对的多维数据集的片。

类型: 集合 (tm1.Element)

单元格

以更新为目标的多维数据集的单元格。

类型: 集合 (tm1.CellDescriptor)

ReferenceCube

包含传播命令所需的源数据的多维数据集。

类型: tm1.Cube

ReferenceCell

包含传播命令所需的源数据的单元格。

类型: 集合 (tm1.Element)

值

用于更新单元格的实际值 (通常是传播命令)。

类型: Edm.String

可空 :false

Cellset.UpdateCells

将更新应用于单元格集中的单元格。

已添加: 11.0.0

IsBound: true

表 113. UpdateCells 参数
名称 详细信息

单元格集

以更新为目标的单元集，在 URL 的资源路径中指定。

类型: tm1.Cellset

可空 :false

更新

指定要更新的单元格以及用于更新单元格的值。

类型: 集合 (tm1.CellsetUpdate)

排序

要使用的更新顺序。 指定 0 表示无排序。

传播命令按 "更新" 中提供的顺序在每个单元上执行。 指定 1 以按级别对单元格进行排序。 首先设置叶单元格值，并保留这些叶单元格。 然后，设置他们的父代并将其挂起，以此类推，直到达到最高级别合并为止。

类型: tm1.UpdateOrder

Cube.UpdateCells

将更新应用于多维数据集的单元格。

已添加: 11.0.0

IsBound: true

表 114. UpdateCells 参数
名称 详细信息

多维数据集

以更新为目标的多维数据集，在 URL 的资源路径中指定。

类型: tm1.Cube

可空 :false

更新

以更新为目标的多维数据集的单元格以及用于更新这些单元格的值。

类型: 集合 (tm1.CubeUpdate)

排序

要使用的更新顺序。 指定 0 表示无排序。

传播命令按 "更新" 中提供的顺序在每个单元上执行。 指定 1 以按级别对单元格进行排序。 首先设置叶单元格值，并保留这些叶单元格。 然后，设置他们的父代并将其挂起，以此类推，直到达到最高级别合并为止。

类型: tm1.UpdateOrder