函数

实体模型中的函数可以具有零个或多个参数,并且必须指定返回类型。

ControlCubes

仅返回模型中的控制多维数据集。

控制多维数据集用于 "系统使用" (例如,本地化属性值) 到 TM1 (使用 "}" 标识)。 控制多维数据集不包含实际数据。

IsBound:false

表 1. ControlCubes 返回类型
类型 详细信息
集合 (tm1.Cube)

控制多维数据集的集合。

可空 :false

ControlDimensions

仅返回控制维度。

IsBound:false

表 2。 ControlDimensions 返回类型
类型 详细信息
集合 (tm1.Dimension)

控制维度的集合。

可空 :false

Cube.DimensionsStorageOrder

按当前存储顺序获取多维数据集的维度。

新增: 11.4.0

IsBound:true

表 3。 DimensionsStorage订单参数
名称 详细信息

多维数据集

要从其中按存储顺序获取维度的多维数据集。

类型: tm1.Cube

可空 :false

表 4。 DimensionsStorage订单退货类型
类型 详细信息
集合 (tm1.Dimension)

多维数据集的维度 (按当前存储顺序)。

可空 :false

GetOIDCKeys

返回 OIDC 密钥。 必须由完全管理员执行。

IsBound:false

表 5。 GetOIDCKeys 返回类型
类型 详细信息
集合 (Edm.String)

OIDC 密钥标识的集合。

可空 :false

Cellset.GetPartition

检索多个分区中的单元格集的单元格。

这允许应用程序根据定义的边界来管理分区区域的处理。

新增: 10.2.2.3

IsBound:true

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

单元格集

单元格的集合。

类型: tm1.Cellset

可空 :false

开始

定义单元格集最接近的矩形区域的左角或右角的单元格序数。

类型: Edm.Int64

结束

定义单元格集最接近的矩形区域的另一边缘的单元格序数。

类型: Edm.Int64

表 7。 GetPartition 返回类型
类型 详细信息
集合 (tm1.CellsetCell)

单元格的集合。

可空 :false

MessageLog

返回消息日志条目的集合。

缺省情况下,将首先返回最新的消息日志条目。

新增: 10.2.2.1

IsBound:false

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

逆向

指示是否按时间顺序对消息日志条目进行排序的布尔值。

类型: Edm.Boolean

表 9。 MessageLog 返回类型
类型 详细信息
集合 (tm1.MessageLogEntry)

消息日志条目的集合。

可空 :false

ModelCubes

仅返回模型中的非控制多维数据集。

IsBound:false

表 10. ModelCubes 返回类型
类型 详细信息
集合 (tm1.Cube)

非控制多维数据集的集合。

如果需要所有多维数据集 (包括控件) ,那么可以使用 /api/vi/多维数据集作为资源标识。

可空 :false

ModelDimensions

仅返回模型维度。

IsBound:false

表 11. ModelDimensions 返回类型
类型 详细信息
集合 (tm1.Dimension)

模型维度的集合。

可空 :false

Hierarchy.RootMembers

返回层级的根成员。

新增: 11.4.7

IsBound:true

表 12. RootMembers 参数
名称 详细信息

层次结构

根成员所属的层次结构。

类型: tm1.Hierarchy

可空 :false

表 13. RootMembers 返回类型
类型 详细信息
集合 (tm1.Member)

根成员的集合。

可空 :false

TailAudit日志

在审计日志上启动更改跟踪。

在审计日志上启动更改跟踪,并返回引用审计日志的时间戳记结尾的增量链接。

新增: 11.6.0

IsBound:false

表 14. TailAudit日志返回类型
类型 详细信息
Edm.String

引用审计日志末尾的增量链接。

可空 :false

TailMessage日志

在消息日志上启动更改跟踪。

在消息日志上启动更改跟踪,并按原样返回引用消息日志末尾的增量链接。

已添加: 11.3.0

IsBound:false

表 15. TailMessage日志返回类型
类型 详细信息
Edm.String

引用消息日志末尾的增量链接。

可空 :false

TailTransaction日志

在事务日志上启动更改跟踪。

在事务日志上启动更改跟踪,并按原样返回引用事务日志末尾的增量链接。

已添加: 11.3.0

IsBound:false

表 16. TailTransaction日志返回类型
类型 详细信息
Edm.String

引用事务日志末尾的增量链接。

可空 :false

TransactionLog

返回事务日志条目的集合。

缺省情况下,将首先返回最新的事务日志条目。

新增: 10.2.2.1

IsBound:false

表 17. TransactionLog 参数
名称 详细信息

逆向

指示是否按时间顺序对事务日志条目进行排序的布尔值。

类型: Edm.Boolean

IgnoreStatus消息

指示是否在转换日志中包含状态消息的布尔值。

类型: Edm.Boolean

表 18. TransactionLog 返回类型
类型 详细信息
集合 (tm1.TransactionLogEntry)

事务日志条目的集合。

可空 :false