Schema

Key: ID

An element that represents a single annotation.

An annotation applies a term to a model element and defines how to calculate a value for the term application.

Since: 10.2.2.0

Properties

ID

The ID of the annotation.

Type: Edm.String

Nullable: false

Text

The text of the annotation.

Type: Edm.String

Creator

The creator of the annotation.

Type: Edm.String

Created

The date that the annotation was created.

Type: Edm.DateTimeOffset

LastUpdatedBy

The ID of the element that updated the annotation.

Type: Edm.String

LastUpdated

The date and time value of the last update of this annotation, with a time zone offset.

Type: Edm.DateTimeOffset

Navigation properties

ApplicationContext

An interface to the collection of configuration information for the annotation.

Type: Collection(ibm.tm1.api.v1.ApplicationContextFacetValue)

DimensionalContext

An interface to the collection of dimensions for the annotation.

Type: Collection(ibm.tm1.api.v1.Member)

Attachments

Attached documents that provide details and background.

Type: Collection(ibm.tm1.api.v1.Attachment)

ContainsTarget: true

Key: Name

The facet of the application context.

Since: 10.2.2.0

Properties

Name

The name of the application context facet.

Type: Edm.String

Nullable: false

Navigation properties

Values

The value of the application context facet, see ApplicationContextFacetValue.

Type: Collection(ibm.tm1.api.v1.ApplicationContextFacetValue)

ContainsTarget: true

Key: Value

A value for a facet of the application context.

Since: 10.2.2.0

Properties

Value

The application context facet value.

Type: Edm.String

Nullable: false

Navigation properties

Facet

The description of the application context facet value, see also ApplicationContextFacet.

Type: ibm.tm1.api.v1.ApplicationContextFacet

Partner: Values

Key: Name

An attached document that provides details and background.

Since: 10.2.2.0

HasStream: true

Properties

Name

The name of the attachment.

Type: Edm.String

Nullable: false

Description

A description of the attachment.

Type: Edm.String

ContentType

The type of content in the attachment.

Type: Edm.String

Size

The size of the attachment.

Type: Edm.Int64

Key: Name

An interface to describe an attribute.

Since: 10.2.2.1

Properties

Name

The name of the attribute.

Type: Edm.String

Nullable: false

Type

The type of the attribute.

Type: ibm.tm1.api.v1.AttributeType

Nullable: false

Key: ID

The result of an execution of a view or an MDX expression.

A cellset represents a snapshot of your data at a certain point in time. You can use the cellset ID within a session instead of running a view or MDX multiple times. Running a view or MDX expression multiple times can yield different results each time and can have an impact on memory resources. When operations on a cellset have completed, you should delete the cellset if you are not ending the session. When a session ends, the cellset is deleted automatically.

Since: 10.2.2.0

Properties

ID

Read-only property that provides a unique identifier for the cellset for the current session.

The ID does not persist outside of a session because a cellset is transient. You cannot depend on the ID being consistent. If you try to access a cellset by using a previous ID value after the session has ended or when the cellset has been deleted, an error is received.

Type: Edm.String

Nullable: false

Navigation properties

Cube

The contents of the cellset.

Type: ibm.tm1.api.v1.Cube

Axes

A collection of axes for the cellset.

Type: Collection(ibm.tm1.api.v1.CellsetAxis)

ContainsTarget: true

Cells

Individual cell value that makes up part of the cellset.

Type: Collection(ibm.tm1.api.v1.CellsetCell)

ContainsTarget: true

Key: Ordinal

Since: 10.2.2.0

Properties

Ordinal

A number that identifies an entity's position in a series.

Type: Edm.Int32

Nullable: false

Cardinality

The cardinality of the cellset axis.

Type: Edm.Int32

Navigation properties

Hierarchies

A collection of hierarchies for this cellset axis.

Type: Collection(ibm.tm1.api.v1.Hierarchy)

Tuples

A collection of tuples for this cellset axis.

Type: Collection(ibm.tm1.api.v1.CellsetAxisTuple)

ContainsTarget: true

Key: Ordinal

Since: 10.2.2.0

Properties

Ordinal

A number that identifies an entity's position in a series.

Type: Edm.Int32

Nullable: false

Navigation properties

Members

A collection of members that make up this cellset axis.

Type: Collection(ibm.tm1.api.v1.Member)

Key: Ordinal

A cell in a cellset.

Since: 10.2.2.0

Properties

Ordinal

A number that identifies an entity's position in a series.

Type: Edm.Int64

Nullable: false

Status

The status of the cell, that is, NULL, DATA, or ERROR.

Type: ibm.tm1.api.v1.CellStatus

Nullable: false

Value

The value of the cell in the cellset.

Type: Edm.PrimitiveType

FormatString

The format of the cell in the cellset.

Type: Edm.String

FormattedValue

The formatted value of the cell in the cellset.

Type: Edm.String

Updateable

A value that indicates whether the cell is updateable.

Type: Edm.Int32

RuleDerived

A Boolean that indicates whether the cell is rule derived.

Type: Edm.Boolean

Annotated

A Boolean that indicates whether the cell is annotated.

Type: Edm.Boolean

Consolidated

A Boolean that indicates whether the cell is consolidated.

Type: Edm.Boolean

Language

The language of the value of the cell.

Type: Edm.Int32

HasPicklist

A Boolean that indicates whether the value of the cell can be selected from a drop-down list.

Since: 10.2.2.1

Type: Edm.Boolean

PicklistValues

The collection of available values that can be selected from the drop-down list.

Type: Collection(Edm.String)

Nullable: false

HasDrillthrough

A Boolean that indicates whether drill-through scripts are defined on the cell.

Since: 10.2.2.6

Type: Edm.Boolean

Navigation properties

DrillthroughScripts

The collection of drill throughs.

Since: 10.2.2.6

Type: Collection(ibm.tm1.api.v1.Drillthrough)

Key: Name

Objects that execute one or more processes of TM1 at a user-defined frequency.

Since: 10.2.2.1

Properties

Name

The name of the chore.

Type: Edm.String

Nullable: false

StartTime

The start time of the chore.

Type: Edm.DateTimeOffset

Nullable: false

DSTSensitive

A Boolean that indicates whether the chore start time is sensitive to daily savings time.

Type: Edm.Boolean

Nullable: false

Active

A Boolean that indicates whether the chore is active.

Type: Edm.Boolean

Nullable: false

ExecutionMode

The execution mode of the chore, that is, single or multiple commit.

Type: ibm.tm1.api.v1.ChoreExecutionMode

Nullable: false

Frequency

The frequency of the chore.

Type: Edm.Duration

Attributes

The attributes of the chore.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

LocalizedAttributes

Translated string values for properties of the chore.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Tasks

A collection of tasks that make up the chore.

Type: Collection(ibm.tm1.api.v1.ChoreTask)

Partner: Chore

ContainsTarget: true

Key:

A reference to a chore.

Since: 10.2.2.1

Navigation properties

Chore

The chore that is referenced.

Type: ibm.tm1.api.v1.Chore

Key: Step

A task to be completed as part of a Chore.

Since: 10.2.2.1

Properties

Step

A step in a task.

Type: Edm.Int64

Nullable: false

Parameters

A collection of parameters for the task.

Type: Collection(ibm.tm1.api.v1.ChoreTaskParameter)

Nullable: false

Navigation properties

Process

The process completed in the task.

Type: ibm.tm1.api.v1.Process

Chore

The Chore that the task belongs to.

Type: ibm.tm1.api.v1.Chore

Partner: Tasks

Key: ServerName

Specifies configuration parameters as defined in the Tm1s.cfg file for an IBM Cognos TM1 server.

For details about all of the parameters, refer to the comments in the Tm1s.cfg file and the Operations Guide.

Since: 10.2.2.0

Properties

ServerName

The name of the server.

Type: Edm.String

Nullable: false

AdminHost

The location where TM1 Admin Server is running.

Type: Edm.String

ProductVersion

The product version of the TM1 server.

Type: Edm.String

PortNumber

The port number of the TM1 server, which is used to distinguish between multiple servers running on the same computer.

Type: Edm.Int32

ClientMessagePortNumber

A secondary port used to accept client messages concerning the progress and ultimate cancellation of a lengthy operation without tying up thread reserves.

Type: Edm.Int32

HTTPPortNumber

The port number on which the TM1 server listens for incoming HTTP(S) requests.

Type: Edm.Int32

IntegratedSecurityMode

A Boolean that indicates whether the TM1 server uses integrated security modes.

Type: Edm.Boolean

SecurityMode

The user authentication mode to be used by TM1 server.

Type: Edm.String

PrincipalName

The service principal name (SPN) when using Integrated Login with TM1 Web and constrained delegation.

Type: Edm.String

SecurityPackageName

If you configure the TM1 server to use Integrated Login, the SecurityPackageName parameter defines the security package that authenticates your user name and password in Microsoft Windows.

Type: Edm.String

ClientCAMURIs

A collection of URIs used to authenticate TM1 clients.

Type: Collection(Edm.String)

Nullable: false

WebCAMURI

The URI used to authenticate TM1 Web clients.

Type: Edm.String

ClientPingCAMPassport

Indicates the interval, in seconds, that a client should ping the CAM server to keep their passport alive.

Type: Edm.Int32

ServerCAMURI

Specifies the URI for the internal dispatcher that the TM1 server should use to connect to Cognos Authentication Manager (CAM).

Type: Edm.String

AllowSeparateNandCRules

Lets you specify rule expressions for N: and C: levels on separate lines using identical AREA definitions.

Type: Edm.Boolean

DistributedOutputDir

Defines the directory to which TUnits are written when a Cognos Insight distributed application is deployed.

Type: Edm.String

DisableSandboxing

A Boolean that indicates whether users have the ability to use sandboxes across the server.

Type: Edm.Boolean

JobQueuing

A Boolean that indicates whether users have the ability to use sandboxes across the server.

Type: Edm.Boolean

ForceReevaluationOfFeedersForFedCellsOnDataChange

When this parameter is set, a feeder statement is forced to be re-evaluated when data changes.

Type: Edm.Boolean

DataBaseDirectory

Specifies the data directory from which the server loads cubes, dimensions, and other objects.

Type: Edm.String

UnicodeUpperLowerCase

Instructs the TM1 server to identify and handle Unicode object names, preventing the creation of identical Unicode object names that vary only in case.

Type: Edm.Boolean

Key: Name

Represents a single cube on a TM1 server.

Since: 10.2.2.0

Properties

Name

Name of the cube as it is registered on the server.

Type: Edm.String

Nullable: false

Rules

Cube rules expand the standard hierarchical consolidation operations that you may define within a dimension.

Type: Edm.String

DrillthroughRules

Rules associating drill-through scripts with regions of cells in the cube.

Drill-through processes can return query results against either cubes or relational tables.

Since: 10.2.2.6

Type: Edm.String

LastSchemaUpdate

Last schema update date of the cube.

Type: Edm.DateTimeOffset

LastDataUpdate

Last data update date of the cube.

Type: Edm.DateTimeOffset

Attributes

Captions and resource attributes of the cube.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Dimensions

Represents dimensions that perform calculations, control labels, and format data entry.

Type: Collection(ibm.tm1.api.v1.Dimension)

Views

Represents a View object on the TM1 Server.

A View is a child object of a Cube. You can retrieve a list of available Views, or find a specific View using the appropriate methods in the Cube class. View objects can be queried for information (such as name or subsets) or changed. Executing a View results in a Cellset object, which can be used to read the actual cell data.

Type: Collection(ibm.tm1.api.v1.View)

Partner: Cube

ContainsTarget: true

ViewAttributes

Specific attributes for each View object of the cube.

Type: Collection(ibm.tm1.api.v1.AttributeDefinition)

ContainsTarget: true

PrivateViews

Private views are accessible only by the user who registered them.

A private registered view is a named object. It persists after the termination of a client session.

Type: Collection(ibm.tm1.api.v1.View)

Partner: Cube

ContainsTarget: true

Annotations

Comments that provide additional information about the cube.

Type: Collection(ibm.tm1.api.v1.Annotation)

LocalizedAttributes

Translated string values for properties of the cube.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key:

A drill through that drills to a view of a cube.

Since: 10.2.2.6

Key:

A reference to a cube.

Since: 10.2.2.1

Navigation properties

Cube

The cube that is referenced.

Type: ibm.tm1.api.v1.Cube

Key: Name

Represents a single dimension on a TM1 server.

A dimension is a broad grouping of descriptive data about a major aspect of a business, such as products, dates, or locations. Each dimension includes different levels of members in one or more hierarchies and an optional set of calculated members or special categories.

Since: 10.2.2.0

Properties

Name

The name of the dimension.

Type: Edm.String

Nullable: false

UniqueName

The caption for the dimension.

Type: Edm.String

Attributes

A property of the dimension.

Attributes have a finite domain within the context of the dimension that they belong to. For example, a dimension for a customer may have attributes that describe the city, region, and country that the customer belongs to.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Hierarchies

More specific groupings within a dimension.

For example, for the Years dimension, data can be organized into smaller groups, such as Years, Current Month, and All Dates.

Type: Collection(ibm.tm1.api.v1.Hierarchy)

Partner: Dimension

ContainsTarget: true

DefaultHierarchy

The default hierarchy of the dimension.

Since: 10.2.2.5

Type: ibm.tm1.api.v1.Hierarchy

HierarchyAttributes

Attributes of a hierarchy.

Type: Collection(ibm.tm1.api.v1.AttributeDefinition)

ContainsTarget: true

LocalizedAttributes

Translated string values for properties of the dimensions.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key:

A reference to a dimension.

Since: 10.2.2.1

Navigation properties

Dimension

The dimension that is referenced.

Type: ibm.tm1.api.v1.Dimension

Key:

An attached document.

Since: 10.2.2.1

Properties

Size

The size of the document.

Type: Edm.Int64

Content

The contents of the document.

Type: Edm.Stream

Key:

A reference to a document.

Since: 10.2.2.1

Navigation properties

Document

The document that is referenced.

Type: ibm.tm1.api.v1.Document

Key: Name

The definition of a drill through on the current cell.

Since: 10.2.2.6

Properties

Name

The name of the drill through.

Type: Edm.String

Nullable: false

Key: ParentName, ComponentName

Represents the relationship between two or more hierarchies and their weight.

Since: 10.2.2.0

Properties

ParentName

The name of the parent of the component in the hierarchy.

Type: Edm.String

Nullable: false

ComponentName

The name of the component in the hierarchy.

Type: Edm.String

Nullable: false

Weight

The weight of the component in the edge.

Type: Edm.Double

Navigation properties

Hierarchy

The hierarchy of the component in the edge.

Type: ibm.tm1.api.v1.Hierarchy

Partner: Edges

Parent

The parent of the component.

Type: ibm.tm1.api.v1.Element

Component

The component.

Type: ibm.tm1.api.v1.Element

Key: Name

An element in a dimension that identifies the location of a cell in a cube.

Since: 10.2.2.0

Properties

Name

The name of the element.

Type: Edm.String

Nullable: false

UniqueName

The element's invariant name.

Type: Edm.String

Type

The type of the element, one of Numeric, String, or Consolidated.

Type: ibm.tm1.api.v1.ElementType

Level

The level to which the element belongs within the dimension hierarchy.

Level 0 identifies leaf elements. Each level of consolidation within the dimension hierarchy is incremented by 1.

Type: Edm.Int32

Index

A value that corresponds to the position of the element within a dimension.

The first element within a dimension has an index value of 1, the second element has an index value of 2, and so on.

Type: Edm.Int32

Attributes

The attributes of the element.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Hierarchy

The hierarchy of the element in the dimension.

Type: ibm.tm1.api.v1.Hierarchy

Partner: Elements

Parents

The parent element of the element in the hierarchy.

Type: Collection(ibm.tm1.api.v1.Element)

Components

The collection of elements in the dimension.

Type: Collection(ibm.tm1.api.v1.Element)

Edges

The collection of edges in the dimension.

Type: Collection(ibm.tm1.api.v1.Edge)

LocalizedAttributes

Translated string values for properties of the element.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key: ID

An entry.

Since: 10.2.2.1

Properties

ID

The ID of the entry.

Type: Edm.String

Nullable: false

Name

The name of the entry.

Type: Edm.String

Nullable: false

Attributes

The attributes of the entry.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

ContainedBy

The folder that contains the entries.

Type: ibm.tm1.api.v1.Folder

LocalizedAttributes

Translated string values for properties of the entry.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key:

A container for related TM1 objects.

Since: 10.2.2.1

Navigation properties

Contents

A collection of entries that are in the folder.

Type: Collection(ibm.tm1.api.v1.Entry)

ContainsTarget: true

PrivateContents

A collection of private entries that are in the folder.

Type: Collection(ibm.tm1.api.v1.Entry)

ContainsTarget: true

Key: Name

A user group on a TM1 server.

Since: 10.2.2.0

Properties

Name

The name of a user group on the TM1 server.

There are three predefined groups on each server: Admin, DataAdmin, and SecurityAdmin. Other user groups can be created by an administrator as required.

Type: Edm.String

Nullable: false

Navigation properties

Users

The names of users in a given group.

Type: Collection(ibm.tm1.api.v1.User)

Partner: Groups

Key: Name

A hierarchy organizes dimensions into a hierarchical structure, with each dimension representing a different level of the hierarchy.

For example, you have separate dimensions for days, months, and quarters. You group them into a dimension called year.

Since: 10.2.2.0

Properties

Name

The name of the hierarchy.

Type: Edm.String

Nullable: false

UniqueName

The caption of the hierarchy.

Type: Edm.String

Cardinality

The cardinality of a relationship is the number of related rows for each of the two query subjects.

Relationships exist between two query subjects. The cardinality of a relationship is the number of related rows for each of the two query subjects. The rows are related by the expression of the relationship. This expression usually refers to the primary and foreign keys of the underlying tables.

Type: Edm.Int32

Structure

Specifies whether the hierarchy is balanced or unbalanced.

A value of 0 indicates a balanced structure and a value of 2 indicates an unbalanced structure.

Type: Edm.Int32

Attributes

The attributes of the hierarchy.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Dimension

A dimension that is part of the hierarchy.

Type: ibm.tm1.api.v1.Dimension

Partner: Hierarchies

Elements

The elements of the hierarchy.

Type: Collection(ibm.tm1.api.v1.Element)

Partner: Hierarchy

ContainsTarget: true

Edges

The edges of the hierarchy.

Type: Collection(ibm.tm1.api.v1.Edge)

Partner: Hierarchy

ContainsTarget: true

Subsets

The subsets of the hierarchy.

Type: Collection(ibm.tm1.api.v1.Subset)

Partner: Hierarchy

ContainsTarget: true

PrivateSubsets

The private subsets of the hierarchy.

Type: Collection(ibm.tm1.api.v1.Subset)

Partner: Hierarchy

ContainsTarget: true

SessionSubsets

Type: Collection(ibm.tm1.api.v1.Subset)

Partner: Hierarchy

ContainsTarget: true

Members

The members of the hierarchy.

Type: Collection(ibm.tm1.api.v1.Member)

Partner: Hierarchy

ContainsTarget: true

AllMember

An aggregation of all of the members of the hierarchy.

Type: ibm.tm1.api.v1.Member

Partner: Hierarchy

DefaultMember

The default member of the hierarchy.

Type: ibm.tm1.api.v1.Member

Partner: Hierarchy

Levels

A collection of levels in the hierarchy.

Type: Collection(ibm.tm1.api.v1.Level)

Partner: Hierarchy

ContainsTarget: true

LocalizedAttributes

Translated string values for properties of the hierarchy.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

ElementAttributes

The attributes of the elements of the hierarchy.

Since: 10.2.2.1

Type: Collection(ibm.tm1.api.v1.AttributeDefinition)

ContainsTarget: true

SubsetAttributes

The attributes of the subsets of the hierarchy.

Type: Collection(ibm.tm1.api.v1.AttributeDefinition)

ContainsTarget: true

Key: Number

A level in the hierarchy of a set of cubes.

Since: 10.2.2.0

Properties

Number

The level number.

Type: Edm.Int32

Nullable: false

Name

The name of the level.

Type: Edm.String

Nullable: false

UniqueName

The unique name of the level.

Type: Edm.String

Cardinality

The cardinality of the level, that is, the number of elements in the level.

Type: Edm.Int32

Type

The type of the level.

Type: Edm.Int32

Navigation properties

Hierarchy

The hierarchy of the level.

Type: ibm.tm1.api.v1.Hierarchy

Partner: Levels

Members

The members of the level.

Type: Collection(ibm.tm1.api.v1.Member)

Partner: Level

Key:

A link to another website or resource.

Since: 10.2.2.1

Properties

URL

The URL of the link.

Type: Edm.String

Nullable: false

Key: LocaleID

A combination of international language codes defined by ISO 639-1 to identify major languages and IETF language tags to identify specific locales.

For example, "fr" identifies French and "fr-CA" identifies Canadian French.

Since: 10.2.2.0

Properties

LocaleID

The ID of the locale. To use the default locale, specify 'Default'.

Type: Edm.String

Nullable: false

Attributes

A set of attributes for the locale.

Type: ibm.tm1.api.v1.Attributes

Key: Name

A logger to be configured for a TM1 server.

Since: 10.2.2.6

Properties

Name

The name of the logger.

Type: Edm.String

Nullable: false

Level

The level of the logger, that is, Fatal, Error, Warning, Info, Debug, Unknown, or Off.

Type: ibm.tm1.api.v1.LogLevel

Nullable: false

Key:

A view of a cube that is defined by an MDX expression.

Since: 10.2.2.0

Properties

MDX

An MDX expression that defines a cube view.

Type: Edm.String

Nullable: false

Key: Name

A set of elements that are members of the consolidation.

Since: 10.2.2.0

Properties

Name

The name of the member.

Type: Edm.String

Nullable: false

UniqueName

The name of the member, preceded by the name of the parent, for example, [dimension_name]:[member_name].

Type: Edm.String

Type

The type of the member.

Type: ibm.tm1.api.v1.MemberType

Ordinal

A number that identifies an entity's position in a series.

Type: Edm.Int32

IsPlaceholder

A Boolean that indicates whether this member is a placeholder.

Type: Edm.Boolean

Weight

The weight of the member within a consolidation.

Weight is a factor applied to an individual member when summing the members of a consolidation.

Type: Edm.Double

Attributes

The attributes of the member.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Hierarchy

The hierarchy of the member.

Type: ibm.tm1.api.v1.Hierarchy

Partner: Members

Level

The level within the hierarchy on which this member resides.

Since: 10.2.2.5

Type: ibm.tm1.api.v1.Level

Partner: Members

Element

The member element.

Type: ibm.tm1.api.v1.Element

Parent

The parent of the member in the consolidation.

Type: ibm.tm1.api.v1.Member

Partner: Children

Children

The children of the member in the consolidation.

Type: Collection(ibm.tm1.api.v1.Member)

Partner: Parent

LocalizedAttributes

Translated string values for properties of the member.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key: ID

An entry in the message log.

The message log displays status messages on the activity of the TM1 server in a log file. These messages contain details on activity such as executed processes, chores, loaded cubes and dimensions, and synchronized replication.

Since: 10.2.2.1

Properties

ID

The ID of the message log entry.

Type: Edm.Int64

Nullable: false

ThreadID

The thread ID of the message log entry.

Type: Edm.Int64

SessionID

The session ID of the message log entry.

Type: Edm.Int64

Level

The level of the message log entry, that is, Fatal, Error, Warning, Info, Debug, Unknown, Off.

Type: ibm.tm1.api.v1.LogLevel

Nullable: false

TimeStamp

The date and time of the message log entry.

Type: Edm.DateTimeOffset

Logger

The logger of the message log entry.

Type: Edm.String

Nullable: false

Message

The message in the message log entry.

Type: Edm.String

Nullable: false

Key:

A native view of a cube.

Since: 10.2.2.0

Properties

Columns

The dimension elements that exist on the column axis of a view.

Type: Collection(ibm.tm1.api.v1.ViewAxisSelection)

Nullable: false

Rows

The dimension elements that exist on the row axis of a view.

Type: Collection(ibm.tm1.api.v1.ViewAxisSelection)

Nullable: false

Titles

The dimension elements that exist as title (context) elements of a view.

Type: Collection(ibm.tm1.api.v1.ViewTitle)

Nullable: false

SuppressEmptyColumns

A Boolean that suppresses any columns that contain only zero values.

Type: Edm.Boolean

SuppressEmptyRows

A Boolean that suppresses any rows that contain only zero values.

Type: Edm.Boolean

FormatString

The format of the elements in the view.

Type: Edm.String

Nullable: false

Key: Name

A TurboIntegrator process that can be used to manipulate TM1 data and metadata.

Since: 10.2.2.0

Properties

Name

The name of a TurboIntegrator process.

Type: Edm.String

Nullable: false

HasSecurityAccess

A Boolean that indicates whether the user security access to run this process.

Type: Edm.Boolean

PrologProcedure

The code that is executed during the Prolog stage of the process.

Type: Edm.String

MetadataProcedure

The code that is executed during the Metadata stage of the process.

Type: Edm.String

DataProcedure

The code that is executed during the Data stage of the process.

Type: Edm.String

EpilogProcedure

The code that is executed during the Epilog stage of the process.

Type: Edm.String

DataSource

The source of the data for the process.

Type: ibm.tm1.api.v1.ProcessDataSource

Parameters

Parameters used by the process.

Type: Collection(ibm.tm1.api.v1.ProcessParameter)

Nullable: false

Variables

Variables used by the process.

Type: Collection(ibm.tm1.api.v1.ProcessVariable)

Nullable: false

Attributes

The attributes of the process.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

LocalizedAttributes

Translated string values for properties of the process.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

ErrorLogs

A collection of error logs for the process.

Since: 10.2.2.2

Type: Collection(ibm.tm1.api.v1.ProcessErrorLog)

ContainsTarget: true

Key: Timestamp

A process error log entry.

Since: 10.2.2.2

Properties

Timestamp

The date and time of the process error.

Type: Edm.DateTimeOffset

Nullable: false

Content

The content of the process error.

Type: Edm.Stream

Key:

A reference to a process.

Since: 10.2.2.1

Navigation properties

Process

The process that is referenced.

Type: ibm.tm1.api.v1.Process

Key:

A drill through that drills to an Open Database Connectivity (ODBC) table.

Since: 10.2.2.6

Key: Name

A sandbox that allows you to work with your data without affecting your base.

Sandboxes allow you to work with your data in different versions, allowing you to add or modify it to see the results without affecting your base. Changes that you make in a sandbox are not made public until you commit the changes. You can continue to work with your data until you are satisfied with the result.

Since: 10.2.2.0

Properties

Name

The name of a sandbox.

Type: Edm.String

Nullable: false

IsLoaded

A Boolean that specifies whether the sandbox is loaded into memory. Read-only.

Type: Edm.Boolean

IsActive

A Boolean that indicates whether the current context is an active sandbox.

Used when the !sandbox parameter is used as a query option.

Type: Edm.Boolean

IsQueued

A Boolean that indicates whether the current context is queued and therefore read-only.

Type: Edm.Boolean

Key: ID

Since: 10.2.2.5

Properties

ID

The ID uniquely identifying the session.

Type: Edm.Int64

Navigation properties

User

The user that is associated to this session.

Type: ibm.tm1.api.v1.User

Partner: Sessions

Threads

The names of users in a given group.

Type: Collection(ibm.tm1.api.v1.Thread)

Partner: Session

Key: Name

Since: 10.2.2.0

Properties

Name

The name of the subset.

Type: Edm.String

Nullable: false

UniqueName

The name of the subset, preceded by the parent dimension and separated by a colon, for example, [dimension_name]:[subset_name].

Type: Edm.String

Expression

An MDX expression that defines the subset.

Type: Edm.String

Attributes

The attributes of the subset.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Hierarchy

The hierarchies that are included in the subset.

Type: ibm.tm1.api.v1.Hierarchy

Partner: Subsets

Elements

The elements that are included in the subset.

Type: Collection(ibm.tm1.api.v1.Element)

LocalizedAttributes

Translated string values for properties of the subset.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key:

A reference to a subset.

Since: 10.2.2.1

Navigation properties

Subset

The subset that is referenced.

Type: ibm.tm1.api.v1.Subset

Key: ID

A thread that can run queries concurrently on the TM1 server.

Since: 10.2.2.1

Properties

ID

Since: 10.2.2.5

Type: Edm.Int64

Nullable: false

Type

The type of thread, that is, user, worker, chore, system.

Type: ibm.tm1.api.v1.ThreadType

Nullable: false

Name

The name of the thread.

Type: Edm.String

Nullable: false

Context

The context of the thread.

Type: Edm.String

Nullable: false

State

The state of the thread.

Type: Edm.String

Nullable: false

Function

The function of the thread.

Type: Edm.String

Nullable: false

ObjectType

The object type of the thread.

Type: Edm.String

Nullable: false

ObjectName

The name of the object that the thread acts on.

Type: Edm.String

Nullable: false

RLocks

A shared lock that allows many threads to read from an object at the same time, but does not allow another thread to modify or write to this object until all R-locks have been released.

Type: Edm.Int32

IXLocks

A lock that reserves the right for a thread to obtain a W-lock on an object when all R-locks have been released.

Type: Edm.Int32

WLocks

An exclusive lock that allows only one thread at a time to access and write changes to an object.

Type: Edm.Int32

ElapsedTime

The elapsed time of a thread in seconds.

Type: Edm.Duration

WaitTime

The wait time (delay) before a thread should start the process.

Type: Edm.Duration

Info

The info of the thread.

Type: Edm.String

Nullable: false

Navigation properties

Session

The Session that this thread is currently servicing.

Type: ibm.tm1.api.v1.Session

Partner: Threads

Key: ID

An entry in the transaction log.

The transaction log displays the transactions recorded in the Tm1s.log file when a TM1 client changes a cube value.

Since: 10.2.2.1

Properties

ID

The ID of the transaction log entry.

Type: Edm.Int64

Nullable: false

ChangeSetID

The ID of the changeset in the transaction log entry.

Type: Edm.String

TimeStamp

The date and time of the transaction log entry.

Type: Edm.DateTimeOffset

ReplicationTime

The replication time of the TM1 server for the transaction log entry.

Type: Edm.DateTimeOffset

User

The user who completed the changeset in the transaction.

Type: Edm.String

Cube

The cube that was acted on in the transaction.

Type: Edm.String

Tuple

A collection of tuples that were acted on in the transaction.

Type: Collection(Edm.String)

Nullable: false

OldValue

The previous value of the changed tuple in the transaction.

Type: Edm.PrimitiveType

NewValue

The new value of the changed tuple in the transaction.

Type: Edm.PrimitiveType

StatusMessage

The status message of the transaction.

Type: Edm.String

Key: Name

A user on a TM1 server.

Since: 10.2.2.0

Properties

Name

The unique name of the user.

Type: Edm.String

Nullable: false

FriendlyName

The friendly name, also known as the display name, of the user.

Since: 10.2.2.5

Type: Edm.String

Nullable: false

Password

The password for the user.

Type: Edm.String

Type

The type of the user.

Since: 10.2.2.4

Type: ibm.tm1.api.v1.UserType

Nullable: false

IsActive

A Boolean that indicates whether the user is currently logged in to the TM1 server.

Type: Edm.Boolean

Nullable: false

Navigation properties

Groups

The defined groups that the user belongs to. A user can belong to multiple groups.

Type: Collection(ibm.tm1.api.v1.Group)

Partner: Users

Sessions

The set of currently active sessions of this user.

Since: 10.2.2.5

Type: Collection(ibm.tm1.api.v1.Session)

Partner: User

Key: Name

A view of data in a cube.

Since: 10.2.2.0

Properties

Name

The name of the view.

Type: Edm.String

Nullable: false

Attributes

The attributes of the view.

Type: ibm.tm1.api.v1.Attributes

Navigation properties

Cube

The parent cube of the view.

Type: ibm.tm1.api.v1.Cube

Partner: Views

LocalizedAttributes

Translated string values for properties of the view.

Type: Collection(ibm.tm1.api.v1.LocalizedAttributes)

ContainsTarget: true

Key:

A reference to a view.

Since: 10.2.2.1

Navigation properties

View

The view that is referenced.

Type: ibm.tm1.api.v1.View

Since: 10.2.2.0

Properties

Caption

Type: Edm.String

Since: 10.2.2.1

Properties

Tuple

Type: Collection(ibm.tm1.api.v1.Element)

Nullable: false

Since: 10.2.2.1

Properties

Name

Type: Edm.String

Nullable: false

Value

Type: Edm.PrimitiveType

Since: 10.2.2.6

Since: 10.2.2.0

Properties

Name

Type: Edm.String

Nullable: false

Value

Type: Edm.PrimitiveType

Since: 10.2.2.0

Properties

Type

Type: Edm.String

Nullable: false

Since: 10.2.2.0

Properties

Name

Type: Edm.String

Nullable: false

Prompt

Type: Edm.String

Value

Type: Edm.PrimitiveType

Since: 10.2.2.0

Properties

Name

Type: Edm.String

Nullable: false

Type

Type: ibm.tm1.api.v1.ProcessVariableType

Nullable: false

Position

Type: Edm.Int32

StartByte

Type: Edm.Int32

EndByte

Type: Edm.Int32

Since: 10.2.2.0

Properties

Subset

Type: ibm.tm1.api.v1.Subset

Since: 10.2.2.0

Properties

Subset

Type: ibm.tm1.api.v1.Subset

Selected

Type: ibm.tm1.api.v1.Element

Since: 10.2.2.1

Members:

• Numeric
• String
• Alias

Since: 10.2.2.0

Members:

• Null
• Data
• Error

Since: 10.2.2.1

Members:

• SingleCommit : 0
• MultipleCommit : 1

Since: 10.2.2.0

Members:

• UsingSource
• UsingTarget
• Individually

Since: 10.2.2.0

Members:

• Numeric : 1
• String : 2
• Consolidated : 3

Since: 10.2.2.1

Members:

• Fatal
• Error
• Warning
• Info
• Debug
• Unknown
• Off

Since: 10.2.2.0

Members:

• Unknown : 0
• Regular : 1
• All : 2
• Measure : 3
• Formula : 4

Since: 10.2.2.0

Members:

• String : 1
• Numeric : 2

Since: 10.2.2.1

Members:

• User
• Worker
• Chore
• System

Since: 10.2.2.4

IsFlags: true

Members:

• User : 0
• SecurityAdmin : 1
• DataAdmin : 2
• Admin : 3

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.

Since: 10.2.2.0

IsBound: false

ReturnType: Collection(ibm.tm1.api.v1.Cube)

Return only control dimensions.

Since: 10.2.2.0

IsBound: false

ReturnType: Collection(ibm.tm1.api.v1.Dimension)

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.

Since: 10.2.2.3

IsBound: true

Parameters

Cellset

The collection of cells.

Type: ibm.tm1.api.v1.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

ReturnType: Collection(ibm.tm1.api.v1.CellsetCell)

Returns a collection of message log entries.

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

Since: 10.2.2.1

IsBound: false

Parameters

Reverse

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

Type: Edm.Boolean

ReturnType: Collection(ibm.tm1.api.v1.MessageLogEntry)

Returns only non-control cubes in the model.

Since: 10.2.2.0

IsBound: false

ReturnType: Collection(ibm.tm1.api.v1.Cube)

Returns only model dimensions.

Since: 10.2.2.0

IsBound: false

ReturnType: Collection(ibm.tm1.api.v1.Dimension)

Returns a collection of transaction log entries.

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

Since: 10.2.2.1

IsBound: false

Parameters

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

ReturnType: Collection(ibm.tm1.api.v1.TransactionLogEntry)

Activates a chore.

Since: 10.2.2.1

IsBound: true

Parameters

Chore

The chore to activate.

Type: ibm.tm1.api.v1.Chore

Nullable: false

Begins a change set.

Since: 10.2.2.6

IsBound: false

ReturnType: Edm.String

Cancels an operation.

Since: 10.2.2.1

IsBound: true

Parameters

Thread

The thread where the action should be canceled.

Type: ibm.tm1.api.v1.Thread

Nullable: false

Closes the session.

Since: 10.2.2.5

IsBound: true

Parameters

Session

The session being closed.

Type: ibm.tm1.api.v1.Session

Nullable: false

Deactivates a chore.

Since: 10.2.2.1

IsBound: true

Parameters

Chore

The chore to deactivate.

Type: ibm.tm1.api.v1.Chore

Nullable: false

Removes all annotation-related control cubes and all things related to annotations for the entire model including context facets, comments, attachments, and so on. Use this action with caution because it cannot be undone.

Since: 10.2.2.0

IsBound: false

Resets the values in the sandbox back to the base.

Since: 10.2.2.0

IsBound: true

Parameters

Sandbox

The sandbox to be reset.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

Disconnects a user but lets threads that are active continue to run until they are done.

Since: 10.2.2.6

IsBound: true

Parameters

User

The user to disconnect.

Type: ibm.tm1.api.v1.User

Nullable: false

Ends a change set.

Since: 10.2.2.6

IsBound: false

Parameters

ChangeSetID

The ID of the change set to end.

Type: Edm.String

Nullable: false

ReturnType: Edm.Int64

Runs a view against the model.

Since: 10.2.2.0

IsBound: true

Parameters

View

The view to be executed, specified in the resource path of the URL.

Type: ibm.tm1.api.v1.View

Nullable: false

Titles

The values of the titles in the title axis that you are slicing the view against.

You must specify all titles, even though you may only want change one.

Type: Collection(ibm.tm1.api.v1.Element)

SuppressEmptyColumns

Columns without a value are not returned in the result set.

Type: Edm.Boolean

SuppressEmptyRows

Rows without a value are not returned in the result set.

Type: Edm.Boolean

ReturnType: ibm.tm1.api.v1.Cellset

Runs a process defined in Turbo Integrator.

Since: 10.2.2.0

IsBound: true

Parameters

Process

Specifies the process.

This value is not specified because it is obtained by the first parameter in the resource path specified in the URL of a POST operation.

Type: ibm.tm1.api.v1.Process

Nullable: false

Parameters

Override default values (numeric or string) defined in the model.

Type: Collection(ibm.tm1.api.v1.NameValuePair)

Drill into a cell.

Since: 10.2.2.6

IsBound: true

Parameters

Drillthrough

The drill through to use.

Type: ibm.tm1.api.v1.CubeDrillthrough

Nullable: false

ReturnType: ibm.tm1.api.v1.Cellset

Drill into a cell.

Since: 10.2.2.6

IsBound: true

Parameters

Drillthrough

The drill through to use.

Type: ibm.tm1.api.v1.RelationalDrillthrough

Nullable: false

ReturnType: Collection(ibm.tm1.api.v1.DrillthroughRow)

Executes a chore.

Since: 10.2.2.2

IsBound: true

Parameters

Chore

The chore to execute.

Type: ibm.tm1.api.v1.Chore

Nullable: false

Runs an MDX expression at root level.

Since: 10.2.2.1

IsBound: false

Parameters

MDX

A string value that represents your expression. Included in the POST body of the request.

Type: Edm.String

Nullable: false

ReturnType: ibm.tm1.api.v1.Cellset

Loads the sandbox into memory on the server.

This action sets the IsLoaded property for Sandbox entity.

Since: 10.2.2.0

IsBound: true

Parameters

Sandbox

The sandbox to be loaded.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

Merges the values of one sandbox with another.

Since: 10.2.2.0

IsBound: true

Parameters

Source

The sandbox to be merged with the target sandbox.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

Target

The sandbox target that you want to merge to.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

ConflictResolution

An enumerated value that indicates whether to resolve conflicts using the source, target, or individually.

Type: ibm.tm1.api.v1.ConflictResolution

AllowQueueing

A Boolean that indicates whether to allow queuing.

Type: Edm.Boolean

CleanAfter

A Boolean that indicates whether to clean the sandbox after merging.

Type: Edm.Boolean

Publishes the contents (values) of the sandbox back to base.

The sandbox specified is still available for use and is left unchanged.

Since: 10.2.2.0

IsBound: true

Parameters

Sandbox

Specifies the sandbox to publish.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

ConflictResolution

An enumerated value that indicates whether to resolve conflicts using the source, target, or individually.

Type: ibm.tm1.api.v1.ConflictResolution

AllowQueueing

A Boolean that indicates whether to allow queuing.

Type: Edm.Boolean

CleanAfter

A Boolean that indicates whether to clean the sandbox after merging.

Type: Edm.Boolean

Sets the child element of a particular element, allowing you to specify the relationship to the parent.

Since: 10.2.2.0

IsBound: true

Parameters

Parent

The parent element to set.

Type: ibm.tm1.api.v1.Element

Nullable: false

Element

The element to set as a child of this parent.

Type: ibm.tm1.api.v1.Element

Nullable: false

Before

Specifies the position where the new component should be created.

If NULL is specified, the new component is added to the beginning of the set. A POST operation appends to the end of a collection by default.

Type: ibm.tm1.api.v1.Element

Weight

The weight of the element.

Type: Edm.Double

Inserts an element into a specified position by setting the parent.

Since: 10.2.2.0

IsBound: true

Parameters

Hierarchy

The hierarchy where the element will be inserted.

Type: ibm.tm1.api.v1.Hierarchy

Nullable: false

Element

The element to insert.

Type: ibm.tm1.api.v1.Element

Nullable: false

Before

If specified, inserts the element before the element specified.

If NULL is specified, the new element is added to the beginning of the set. A POST operation appends to the end of a collection by default.

Type: ibm.tm1.api.v1.Element

Inserts an element into a specified subset at a specified location.

Since: 10.2.2.6

IsBound: true

Parameters

Subset

The subset where the element will be inserted.

Type: ibm.tm1.api.v1.Subset

Nullable: false

Element

The element to insert.

Type: ibm.tm1.api.v1.Element

Nullable: false

Before

If specified, inserts the element before the element specified.

If NULL is specified, the new element is added to the beginning of the set. A POST operation appends to the end of a collection by default.

Type: ibm.tm1.api.v1.Element

After

If specified, inserts the element after the element specified.

If NULL is specified, the new element is added to the end of the set. A POST operation appends to the end of a collection by default.

Type: ibm.tm1.api.v1.Element

Sets the local start time for a server.

Since: 10.2.2.1

IsBound: true

Parameters

Chore

The chore to set the server start time for.

Type: ibm.tm1.api.v1.Chore

Nullable: false

StartDate

The start date to set for this chore.

Type: Edm.Date

Nullable: false

StartTime

The start time to set for this chore.

Type: Edm.TimeOfDay

Nullable: false

Reverts a change set.

Deleting the change set effectively removes all changes made to-date by the session.

Since: 10.2.2.6

IsBound: false

Parameters

ChangeSetID

The ID of the change set to revert.

Type: Edm.String

Nullable: false

Unloads the sandbox from memory on the server.

This action is useful for freeing up resources when they are no longer needed.

Since: 10.2.2.0

IsBound: true

Parameters

Sandbox

The sandbox to be unloaded.

Type: ibm.tm1.api.v1.Sandbox

Nullable: false

Applies updates to a cell, or a range of cells, depending on the value of the parameters provided.

Since: 10.2.2.0

IsBound: true

Parameters

Cellset

The cellset targeted by the update, specified in the resource path of the URL.

Type: ibm.tm1.api.v1.Cellset

Nullable: false

BeginOrdinal

Specifies the cell to update if updating a single cell, or the beginning of the range if updating more than one cell.

Type: Edm.Int64

Nullable: false

EndOrdinal

The last cell position when updating a range of cells.

Type: Edm.Int64

ReferenceCube

The cube from which the data for the ReferenceCell is sourced.

Type: ibm.tm1.api.v1.Cube

ReferenceCell

The cell, or slice, containing the source data required by the spreading command.

Type: Collection(ibm.tm1.api.v1.Element)

Value

The actual value, typically a spreading command, with which the cell is updated.

Type: Edm.String

Nullable: false

Applies updates to a cube, a slice of a cube, or cells of a cube, depending on the value of the parameters provided.

Since: 10.2.2.1

IsBound: true

Parameters

Cube

The cube targeted by the update, specified in the resource path of the URL.

Type: ibm.tm1.api.v1.Cube

Nullable: false

Slice

The slice of the cube targeted by the update.

Type: Collection(ibm.tm1.api.v1.Element)

Cells

The cells of the cube targeted by the update.

Type: Collection(ibm.tm1.api.v1.CellDescriptor)

ReferenceCube

The cube containing the source data required by the spreading command.

Type: ibm.tm1.api.v1.Cube

ReferenceCell

The cell containing the source data required by the spreading command.

Type: Collection(ibm.tm1.api.v1.Element)

Value

The actual value, typically a spreading command, with which the cell is updated.

Type: Edm.String

Nullable: false

Applies updates to a cube, a slice of a cube, or cells of a cube, depending on the value of the parameters provided.

Since: 10.2.2.4

IsBound: false

Parameters

Cube

The cube targeted by the update, specified in the resource path of the URL.

Type: ibm.tm1.api.v1.Cube

Nullable: false

Slice

The slice of the cube targeted by the update.

Type: Collection(ibm.tm1.api.v1.Element)

Cells

The cells of the cube targeted by the update.

Type: Collection(ibm.tm1.api.v1.CellDescriptor)

ReferenceCube

The cube containing the source data required by the spreading command.

Type: ibm.tm1.api.v1.Cube

ReferenceCell

The cell containing the source data required by the spreading command.

Type: Collection(ibm.tm1.api.v1.Element)

Value

The actual value, typically a spreading command, with which the cell is updated.

Type: Edm.String

Nullable: false