Functions

Functions in an entity model can have zero or more parameters, and must specify a return type.

ControlCubes

Returns only control cubes in the model.

Control cubes are used for "system use" (for example, localized attribute values) to TM1 (identified with '}'). Control cubes don't contain your actual data.

IsBound: false

Table 1. ControlCubes return types
Type Details
Collection(tm1.Cube)

A collection of control cubes.

Nullable: false

ControlDimensions

Return only control dimensions.

IsBound: false

Table 2. ControlDimensions return types
Type Details
Collection(tm1.Dimension)

A collection of control dimensions.

Nullable: false

Cube.DimensionsStorageOrder

Gets a Cube's Dimensions in current storage order.

Added: 11.4.0

IsBound: true

Table 3. DimensionsStorageOrder parameters
Name Details

Cube

The Cube from which to get the Dimensions in storage order.

Type: tm1.Cube

Nullable: false
Table 4. DimensionsStorageOrder return types
Type Details
Collection(tm1.Dimension)

The Cube's Dimensions in current storage order..

Nullable: false

GetOIDCKeys

Returns OIDC keys. Must be performed by a full admin.

IsBound: false

Table 5. GetOIDCKeys return types
Type Details
Collection(Edm.String)

A collection of OIDC key ids.

Nullable: false

Cellset.GetPartition

Retrieves the cells of a cellset in multiple partitions.

This allows the application to manage processing of the area of the partition based on a defined boundary.

Added: 10.2.2.3

IsBound: true

Table 6. GetPartition parameters
Name Details

Cellset

The collection of cells.

Type: tm1.Cellset

Nullable: false

Begin

Defines the cell ordinal of the left or right corner of the closest rectangular area of your cellset.

Type: Edm.Int64

End

Defines the cell ordinal of the other edge of the closest rectangular area of your cellset.

Type: Edm.Int64
Table 7. GetPartition return types
Type Details
Collection(tm1.CellsetCell)

A collection of cellset cells.

Nullable: false

MessageLog

Returns a collection of message log entries.

By default, the most recent message log entry is returned first.

Added: 10.2.2.1

IsBound: false

Table 8. MessageLog parameters
Name Details

Reverse

A Boolean that indicates whether to order message log entries chronologically as they occurred in time.

Type: Edm.Boolean
Table 9. MessageLog return types
Type Details
Collection(tm1.MessageLogEntry)

A collection of message log entries.

Nullable: false

ModelCubes

Returns only non-control cubes in the model.

IsBound: false

Table 10. ModelCubes return types
Type Details
Collection(tm1.Cube)

A collection of non-control cubes.

If you want all of the cubes (including control), you can use /api/vi/Cubes as a resource identifier.

Nullable: false

ModelDimensions

Returns only model dimensions.

IsBound: false

Table 11. ModelDimensions return types
Type Details
Collection(tm1.Dimension)

A collection of model dimensions.

Nullable: false

Hierarchy.RootMembers

Returns the root members of a hierarchy.

Added: 11.4.7

IsBound: true

Table 12. RootMembers parameters
Name Details

Hierarchy

The hierarchy that the root members belong to.

Type: tm1.Hierarchy

Nullable: false
Table 13. RootMembers return types
Type Details
Collection(tm1.Member)

The collection of the root members.

Nullable: false

TailAuditLog

Initiates change tracking on the audit log.

Initiates change tracking on the audit log and returns a delta link referencing the timestamp end of the audit log.

Added: 11.6.0

IsBound: false

Table 14. TailAuditLog return types
Type Details
Edm.String

Delta link referencing the end of the audit log.

Nullable: false

TailMessageLog

Initiates change tracking on the message log.

Initiates change tracking on the message log and returns a delta link referencing the end of the message log as-is.

Added: 11.3.0

IsBound: false

Table 15. TailMessageLog return types
Type Details
Edm.String

Delta link referencing the end of the message log.

Nullable: false

TailTransactionLog

Initiates change tracking on the transaction log.

Initiates change tracking on the transaction log and returns a delta link referencing the end of the transaction log as-is.

Added: 11.3.0

IsBound: false

Table 16. TailTransactionLog return types
Type Details
Edm.String

Delta link referencing the end of the transaction log.

Nullable: false

TransactionLog

Returns a collection of transaction log entries.

By default, the most recent transaction log entry is returned first.

Added: 10.2.2.1

IsBound: false

Table 17. TransactionLog parameters
Name Details

Reverse

A Boolean that indicates whether to order transaction log entries chronologically as they occurred in time.

Type: Edm.Boolean

IgnoreStatusMessages

A Boolean that indicates whether to include or not include status messages in the translation log.

Type: Edm.Boolean
Table 18. TransactionLog return types
Type Details
Collection(tm1.TransactionLogEntry)

A collection of transaction log entries.

Nullable: false