Actions

Chore.Activate

Activates a chore.

Added: 10.2.2.1

IsBound: true

Table 1. Activate parameters
Name	Details
Chore	The chore to activate. Type: tm1.Chore Nullable: false

Dimension.AddAllLeavesHierarchy

Adds the all leaves hierarchy to a single hierarchy dimension and implicitly converts that dimension into a multi hierarchy dimension.

Added: 11.0.0

IsBound: true

Table 2. AddAllLeavesHierarchy parameters
Name	Details
Dimension	The dimension to convert into a multi hierarchy dimension and add the all leaves hierarchy to. Type: tm1.Dimension Nullable: false
AllLeavesHierarchyName	The name of the all leaves hierarchy (default='Leaves') Type: Edm.String
Visible	A Boolean indicating if the visible property of the new all leaves hierarchy should be set to true (default=false). Type: Edm.Boolean

Table 3. AddAllLeavesHierarchy return types
Type	Details
tm1.Hierarchy	The newly created all leaves hierarchy. Nullable: false

BeginChangeSet

Begins a change set.

Added: 10.2.2.6

IsBound: false

Table 4. BeginChangeSet return types
Type	Details
Edm.String	The ID of the change set that has begun. Nullable: false

Thread.CancelOperation

Cancels an operation.

Added: 10.2.2.1

IsBound: true

Table 5. CancelOperation parameters
Name	Details
Thread	The thread where the action should be canceled. Type: tm1.Thread Nullable: false

Cube.CheckFeeders

Returns a list of components of a consolidation that are not properly fed.

Added: 11.1.0

IsBound: true

Table 6. CheckFeeders parameters
Name	Details
Cube	Cube containing the cell that should be checked. Type: tm1.Cube Nullable: false
Tuple	Coordinates of the cell that should be checked. Type: Collection(tm1.Element)

Table 7. CheckFeeders return types
Type	Details
Collection(tm1.FedCellDescriptor)	The collection of improperly fed components of the consolidation. Nullable: false

Cube.CheckRules

Checks the Cube rules for errors.

Added: 11.1.0

IsBound: true

Table 8. CheckRules parameters
Name	Details
Cube	The Cube containing the rules to be checked. Type: tm1.Cube Nullable: false

Table 9. CheckRules return types
Type	Details
Collection(tm1.RuleSyntaxError)	The set of errors in the rules. If no errors are returned, the rules are correct. Nullable: false

Session.Close

Closes the session.

Added: 10.2.2.5

IsBound: true

Table 10. Close parameters
Name	Details
Session	The session being closed. Type: tm1.Session Nullable: false

Process.Compile

Added: 11.0.0

IsBound: true

Table 11. Compile parameters
Name	Details
Process	Type: tm1.Process Nullable: false

Table 12. Compile return types
Type	Details
Collection(tm1.ProcessSyntaxError)

CompileProcess

Added: 11.0.0

IsBound: false

Table 13. CompileProcess parameters
Name	Details
Process	Type: tm1.Process Nullable: false

Table 14. CompileProcess return types
Type	Details
Collection(tm1.ProcessSyntaxError)

ProcessDebugContext.Continue

Continues execution of a paused process debug context.

IsBound: true

Table 15. Continue parameters
Name	Details
Context	The debug context to continue. Type: tm1.ProcessDebugContext Nullable: false

Table 16. Continue return types
Type	Details
tm1.ProcessDebugContext

Entry.Copy

Copies an Entry.

Added: 11.2.0

IsBound: true

Table 17. Copy parameters
Name	Details
Entry	The source Entry to be copied. Type: tm1.Entry
Target	The destination folder. If not specified, the source Entry's parent is used. Type: tm1.Folder
Private	Whether the new Entry should be private. If not specified, the existing scope is used. Cannot be true if the destination folder is private. Type: Edm.Boolean
Name	The name of the new Entry. Type: Edm.String

Table 18. Copy return types
Type	Details
tm1.Entry	The new Entry copy. Nullable: false

Hierarchy.CreateSessionSubset

Creates a session-scoped subset within the hierarchy.

The subset will have a generated name, and will not be listed on any collection. The subsets can be looked up by ID, edited with PATCH, and DELETEd. They may also be used by ID in MDX queries, in place of the subset name. If a named subset exists with the generated ID, the named subset (public or private) will be used in the query instead. These subsets are not persisted and are automatically destroyed when the session expires or is logged out. They cannot be retrieved, modified, or used in an MDX query from another session.

IsBound: true

Table 19. CreateSessionSubset parameters
Name	Details
Hierarchy	Implicit first parameter (this action is bound to a Hierarchy). Type: tm1.Hierarchy Nullable: false
Subset	Optional. Subset to be copied (if value is supplied with an entity reference) or a definition to be used (if a subset definition is given as an object). If this parameter is omitted, an empty subset is created. In the case of a subset definition, the Name supplied will be ignored, and an ID will be generated. Type: tm1.Subset

Table 20. CreateSessionSubset return types
Type	Details
tm1.Subset	Newly created session-scoped subset that will be contained by the SessionSubsets collection of the bound hierarchy. Nullable: false

Chore.Deactivate

Deactivates a chore.

Added: 10.2.2.1

IsBound: true

Table 21. Deactivate parameters
Name	Details
Chore	The chore to deactivate. Type: tm1.Chore Nullable: false

Process.Debug

Starts a debug session for a process defined in Turbo Integrator.

IsBound: true

Table 22. Debug parameters
Name	Details
Process	The process to start the debug session for. Type: tm1.Process Nullable: false
Parameters	Override default values (numeric or string) defined in the model. Type: Collection(tm1.NameValuePair)

Table 23. Debug return types
Type	Details
tm1.ProcessDebugContext

DecryptDataFile

Decrypts a single file. Must be performed by a full admin.

IsBound: false

Table 24. DecryptDataFile parameters
Name	Details
SourcePath	The path to the file to be decrypted. Type: Edm.String
DestinationPath	The path to the directory where the decrypted file should be stored. If unspecified, the file will be decrypted and replaced. Type: Edm.String
FileType	The file type of the source file. Type: tm1.EncryptionFileType

DecryptDataModel

Decrypts the data model. Must be performed by a full admin. Will result in a server shutdown.

IsBound: false

Table 25. DecryptDataModel parameters
Name	Details
TimeUntilShutdown	The time until the server shuts down, rounded up to the minute. Type: Edm.Duration

DeleteAnnotationArtifacts

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.

IsBound: false

Sandbox.DiscardChanges

Resets the values in the sandbox back to the base.

IsBound: true

Table 26. DiscardChanges parameters
Name	Details
Sandbox	The sandbox to be reset. Type: tm1.Sandbox Nullable: false

User.Disconnect

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

Added: 10.2.2.6

IsBound: true

Table 27. Disconnect parameters
Name	Details
User	The user to disconnect. Type: tm1.User Nullable: false

EncryptDataFile

Encrypts a single file. Must be performed by a full admin.

IsBound: false

Table 28. EncryptDataFile parameters
Name	Details
SourcePath	The path to the file to be encrypted. Type: Edm.String
DestinationPath	The path to the directory where the encrypted file should be stored. If unspecified, the file will be encrypted and replaced. Type: Edm.String
FileType	The file type of the source file. Type: tm1.EncryptionFileType

EncryptDataModel

Encrypts the data model. Must be performed by a full admin. Will result in a server shutdown.

IsBound: false

Table 29. EncryptDataModel parameters
Name	Details
TimeUntilShutdown	The time until the server shuts down, rounded up to the minute. Type: Edm.Duration

EndChangeSet

Ends a change set.

Added: 10.2.2.6

IsBound: false

Table 30. EndChangeSet parameters
Name	Details
ChangeSetID	The ID of the change set to end. Type: Edm.String Nullable: false

Table 31. EndChangeSet return types
Type	Details
Edm.Int64	The return code of the EndChangeSet action. Nullable: false

MDXView.Execute

Runs a view against the model.

IsBound: true

Table 32. Execute parameters
Name	Details
View	The view to be executed, specified in the resource path of the URL. Type: tm1.MDXView Nullable: false

Table 33. Execute return types
Type	Details
tm1.Cellset	Nullable: false

NativeView.Execute

Runs a view against the model.

IsBound: true

Table 34. Execute parameters
Name	Details
View	The view to be executed, specified in the resource path of the URL. Type: tm1.NativeView 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(tm1.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

Table 35. Execute return types
Type	Details
tm1.Cellset	Nullable: false

Process.Execute

Runs a process defined in Turbo Integrator.

Deprecated: 11.3.0

IsBound: true

Table 36. Execute parameters
Name	Details
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: tm1.Process Nullable: false
Parameters	Override default values (numeric or string) defined in the model. Type: Collection(tm1.NameValuePair)

CubeDrillthrough.Execute

Drill into a cell.

Added: 10.2.2.6

IsBound: true

Table 37. Execute parameters
Name	Details
Drillthrough	The drill through to use. Type: tm1.CubeDrillthrough Nullable: false

Table 38. Execute return types
Type	Details
tm1.Cellset	Nullable: false

RelationalDrillthrough.Execute

Drill into a cell.

Added: 10.2.2.6

IsBound: true

Table 39. Execute parameters
Name	Details
Drillthrough	The drill through to use. Type: tm1.RelationalDrillthrough Nullable: false

Table 40. Execute return types
Type	Details
Collection(tm1.DrillthroughRow)	Nullable: false

Chore.Execute

Executes a chore.

Added: 10.2.2.2

IsBound: true

Table 41. Execute parameters
Name	Details
Chore	The chore to execute. Type: tm1.Chore Nullable: false

GitPullPlan.Execute

Execute a Git pull plan.

Added: 11.5.0

IsBound: true

Table 42. Execute parameters
Name	Details
GitPlan	The Git pull plan to be executed. Type: tm1.GitPullPlan Nullable: false

GitPushPlan.Execute

Execute a Git push plan.

Added: 11.5.0

IsBound: true

Table 43. Execute parameters
Name	Details
GitPlan	The Git push plan to be executed. Type: tm1.GitPushPlan Nullable: false

ExecuteChore

Runs a chore.

Added: 11.1.1

IsBound: false

Table 44. ExecuteChore parameters
Name	Details
Chore	Specifies the chore to be executed. Type: tm1.Chore Nullable: false

ExecuteCubeDrillthrough

Drill to the drillthrough process returned cube view.

Added: 11.2.0

IsBound: false

Table 45. ExecuteCubeDrillthrough parameters
Name	Details
DrillthroughProcess	A process that returns a handle of a view. Type: tm1.Process Nullable: false
Parameters	Parameters used by the process. Type: Collection(tm1.ProcessParameter)

Table 46. ExecuteCubeDrillthrough return types
Type	Details
tm1.Cellset	Nullable: false

ExecuteMDX

Runs an MDX expression at root level.

Added: 10.2.2.1

IsBound: false

Table 47. ExecuteMDX parameters
Name	Details
MDX	A string value that represents your expression. Included in the POST body of the request. Type: Edm.String Nullable: false

Table 48. ExecuteMDX return types
Type	Details
tm1.Cellset	A cellset. Nullable: false

ExecuteMDXSetExpression

Runs an MDX set expression at root level.

Added: 11.1.0

IsBound: false

Table 49. ExecuteMDXSetExpression parameters
Name	Details
MDX	A string value that represents your expression. Included in the POST body of the request. Type: Edm.String Nullable: false

Table 50. ExecuteMDXSetExpression return types
Type	Details
tm1.CellsetAxis	A cellset axis representing the snapshot of the member set described by the expression Nullable: false

ExecuteProcess

Runs a process defined in Turbo Integrator.

Added: 11.0.0

Deprecated: 11.3.0

IsBound: false

Table 51. ExecuteProcess parameters
Name	Details
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: tm1.Process Nullable: false
Parameters	Override default values (numeric or string) defined in the model. Type: Collection(tm1.NameValuePair)

ExecuteProcessWithReturn

Runs a process defined in Turbo Integrator and returns back the status.

Added: 11.3.0

IsBound: false

Table 52. ExecuteProcessWithReturn parameters
Name	Details
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: tm1.Process Nullable: false
Parameters	Override default values (numeric or string) defined in the model. Type: Collection(tm1.NameValuePair)

Table 53. ExecuteProcessWithReturn return types
Type	Details
tm1.ProcessExecuteResult	Nullable: false

ExecuteRelationalDrillthrough

Drill to relational tables.

Added: 11.2.0

IsBound: false

Table 54. ExecuteRelationalDrillthrough parameters
Name	Details
DrillthroughProcess	A process that returns a handle of a SQL or CSV table. Type: tm1.Process Nullable: false
Parameters	Parameters used by the process. Type: Collection(tm1.ProcessParameter)

Table 55. ExecuteRelationalDrillthrough return types
Type	Details
Collection(tm1.DrillthroughRow)	Nullable: false

ExecuteRelationalDrillthroughWithRowset

Execute a relational drillthrough to get a rowset of a relational table.

Added: 11.6.0

IsBound: false

Table 56. ExecuteRelationalDrillthroughWithRowset parameters
Name	Details
DrillthroughProcess	A process that returns a handle of a SQL or CSV table. Type: tm1.Process Nullable: false
Parameters	Parameters used by the process. Type: Collection(tm1.ProcessParameter)

Table 57. ExecuteRelationalDrillthroughWithRowset return types
Type	Details
tm1.Rowset	Nullable: false

Process.ExecuteWithReturn

Runs a process defined in Turbo Integrator and returns back the status.

Added: 11.3.0

IsBound: true

Table 58. ExecuteWithReturn parameters
Name	Details
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: tm1.Process Nullable: false
Parameters	Override default values (numeric or string) defined in the model. Type: Collection(tm1.NameValuePair)

Table 59. ExecuteWithReturn return types
Type	Details
tm1.ProcessExecuteResult	Nullable: false

RelationalDrillthrough.ExecuteWithRowset

Drill into a cell to get a rowset of a relational table.

Added: 11.6.0

IsBound: true

Table 60. ExecuteWithRowset parameters
Name	Details
Drillthrough	The drill through to use. Type: tm1.RelationalDrillthrough Nullable: false

Table 61. ExecuteWithRowset return types
Type	Details
tm1.Rowset	Nullable: false

GitDeploy

Deploy a model using the source from the specified Git repository.

Added: 11.5.0

IsBound: false

Table 62. GitDeploy parameters
Name	Details
URL	The URL of the remote Git repository. Type: Edm.String Nullable: false
Username	The username of the remote Git repository. Type: Edm.String Nullable: false
Password	The password of the remote Git repository. Type: Edm.String Nullable: false
Branch	The branch to pull. Type: Edm.String Nullable: false
Deployment	The deployment of the repository instance. Type: Edm.String
Force	A flag which is used to evaluate preconditions. Type: Edm.Boolean Nullable: false

GitInit

Initialize TM1 Server's Git environment.

Added: 11.5.0

IsBound: false

Table 63. GitInit parameters
Name	Details
URL	The URL of the remote Git repository. Type: Edm.String Nullable: false
Username	The username of the remote Git repository. Type: Edm.String
Password	The password of the remote Git repository. Type: Edm.String
Deployment	The deployment chosen for current Git operations. Type: Edm.String
Force	Reset existing Git context and initialize. Type: Edm.Boolean Nullable: false

Table 64. GitInit return types
Type	Details
tm1.Git	Git status. Nullable: false

GitPull

Fetch a remote branch and create a plan which contains the actions of loading the sources from the branch into the server.

Added: 11.5.0

IsBound: false

Table 65. GitPull parameters
Name	Details
Username	The username of the remote Git repository. Type: Edm.String Nullable: false
Password	The password of the remote Git repository. Type: Edm.String Nullable: false
Branch	The branch to pull. Type: Edm.String Nullable: false
ExecutionMode	The execution mode of the Git pull plan, that is, single or multiple commit. Type: tm1.GitPlanExecutionMode
Force	A flag which is used to evaluate preconditions. Type: Edm.Boolean Nullable: false

Table 66. GitPull return types
Type	Details
tm1.GitPlan	The created Git pull plan. Nullable: false

GitPush

Generate sources and use those files to create a Git commit to push to the remote Git repository.

Added: 11.5.0

IsBound: false

Table 67. GitPush parameters
Name	Details
Username	The username of the remote Git repository. Type: Edm.String Nullable: false
Password	The password of the remote Git repository. Type: Edm.String Nullable: false
Branch	The branch which contains the commit to be used as the parent commit of the new commit to push. Type: Edm.String Nullable: false
NewBranch	The branch to create and push on. Type: Edm.String
Message	The commit message. Type: Edm.String Nullable: false
Author	The name of the commit author. Type: Edm.String Nullable: false
Email	The Email of the commit author. Type: Edm.String Nullable: false
Force	A flag which is used to evaluate preconditions. Type: Edm.Boolean Nullable: false

Table 68. GitPush return types
Type	Details
tm1.GitPlan	The created Git push plan. Nullable: false

GitStatus

Check Git status.

Added: 11.5.0

IsBound: false

Table 69. GitStatus parameters
Name	Details
Username	The username of the remote Git repository. Type: Edm.String
Password	The password of the remote Git repository. Type: Edm.String

Table 70. GitStatus return types
Type	Details
tm1.Git	Git status. Nullable: false

GitUninit

Clean up the local Git repository and reset Git context.

Added: 11.5.0

IsBound: false

Table 71. GitUninit parameters
Name	Details
Force	A Boolean that indicates whether to reset the Git context. Type: Edm.Boolean Nullable: false

Cube.Load

Loads the cube into memory on the server.

Added: 11.6.0

IsBound: true

Table 72. Load parameters
Name	Details
Cube	The cube to be loaded. Type: tm1.Cube Nullable: false

Sandbox.Load

Loads the sandbox into memory on the server.

This action sets the IsLoaded property for Sandbox entity.

IsBound: true

Table 73. Load parameters
Name	Details
Sandbox	The sandbox to be loaded. Type: tm1.Sandbox Nullable: false

Cube.Lock

Locks a cube, preventing any users from modifying it until the cube is unlocked.

IsBound: true

Table 74. Lock parameters
Name	Details
Cube	The cube to lock. Type: tm1.Cube

Dimension.Lock

Locks a dimension, preventing any users from modifying it until the dimension is unlocked.

IsBound: true

Table 75. Lock parameters
Name	Details
Dimension	The dimension to lock. Type: tm1.Dimension

Sandbox.Merge

Merges the values of one sandbox with another.

IsBound: true

Table 76. Merge parameters
Name	Details
Source	The sandbox to be merged with the target sandbox. Type: tm1.Sandbox Nullable: false
Target	The sandbox target that you want to merge to. Type: tm1.Sandbox Nullable: false
ConflictResolution	An enumerated value that indicates whether to resolve conflicts using the source, target, or individually. Type: tm1.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

Entry.Move

Moves an Entry to a new parent folder, renames an Entry, and publishes or privatizes it.

Added: 11.2.0

IsBound: true

Table 77. Move parameters
Name	Details
Entry	The Entry to be moved. Type: tm1.Entry
Target	The destination folder. If not specified, the existing parent is used. Type: tm1.Folder
Private	Whether the Entry should be private. If not specified, the existing scope is used. Cannot be true if the destination folder is private. Type: Edm.Boolean
Name	The new name of the Entry. Type: Edm.String

Table 78. Move return types
Type	Details
tm1.Entry	The moved Entry. Nullable: false

Sandbox.Publish

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

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

IsBound: true

Table 79. Publish parameters
Name	Details
Sandbox	Specifies the sandbox to publish. Type: tm1.Sandbox Nullable: false
ConflictResolution	An enumerated value that indicates whether to resolve conflicts using the source, target, or individually. Type: tm1.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

RemoveOIDCKeyFromCache

Removes OIDC key from server cache. Must be performed by a full admin.

IsBound: false

Table 80. RemoveOIDCKeyFromCache parameters
Name	Details
KeyId	Optional. The collection of keys to remove. If this parameter is omitted, all keys are removed. Type: Collection(Edm.String)

Cube.ReorderDimensions

Reorders a Cube's Dimensions.

Added: 11.4.0

IsBound: true

Table 81. ReorderDimensions parameters
Name	Details
Cube	The Cube that should have its dimensions reordered. Type: tm1.Cube Nullable: false
Dimensions	The new order of Dimensions. Type: Collection(tm1.Dimension)

Table 82. ReorderDimensions return types
Type	Details
Edm.Double	The percent change in memory usage of the Cube due to the new order. Nullable: false

RotateDataModelKey

Rotates the model key. Must be performed by a full admin.

IsBound: false

Dimension.SaveAs

Saves a dimension.

Added: 11.0.0

IsBound: true

Table 83. SaveAs parameters
Name	Details
Dimension	The dimension to save. Type: tm1.Dimension Nullable: false
Name	The name to save the dimension as. Type: Edm.String Nullable: false
Overwrite	A Boolean that indicates whether to overwrite the dimension that was passed in if it already exists. Type: Edm.Boolean
KeepExistingAttributes	A Boolean that indicates whether overwrite any existing attributes for the dimension, and all contained objects, we might be replacing with an overwrite. If the save is not overwriting, and this value is set to true, then no attributes will be created for the new dimension. Added: 11.0.0 Type: Edm.Boolean

Table 84. SaveAs return types
Type	Details
tm1.Dimension	The saved dimension. Nullable: false

Hierarchy.SaveAs

Saves a hierarchy.

Added: 11.0.0

IsBound: true

Table 85. SaveAs parameters
Name	Details
Hierarchy	The hierarchy to save. Type: tm1.Hierarchy Nullable: false
Name	The name to save the hierarchy as. Type: Edm.String Nullable: false
Overwrite	A Boolean that indicates whether to overwrite the hierarchy that was passed in if it already exists. Type: Edm.Boolean
KeepExistingAttributes	A Boolean that indicates whether overwrite any existing attributes for the hierarchy, and all contained objects, we might be replacing with an overwrite. If the save is not overwriting, and this value is set to true, then no attributes will be created for the new hierarchy. Added: 11.0.0 Type: Edm.Boolean

Table 86. SaveAs return types
Type	Details
tm1.Hierarchy	The saved hierarchy. Nullable: false

Subset.SaveAs

Saves a subset.

Added: 11.0.0

IsBound: true

Table 87. SaveAs parameters
Name	Details
Subset	The subset to save. Type: tm1.Subset Nullable: false
Name	The name to save the subset as. Type: Edm.String Nullable: false
MakePrivate	A Boolean that indicates whether to save this subset as private. Type: Edm.Boolean
MakeStatic	A Boolean that indicates whether to save this subset as static. Type: Edm.Boolean

Table 88. SaveAs return types
Type	Details
tm1.Subset	The saved subset. Nullable: false

Cellset.SaveViewAs

Saves a view.

Added: 11.0.0

IsBound: true

Table 89. SaveViewAs parameters
Name	Details
Cellset	The cellset whose underlying view is to save. Type: tm1.Cellset Nullable: false
Name	The name to save the view as. Type: Edm.String Nullable: false
Overwrite	A Boolean that indicates whether to overwrite the view that was passed in if it already exists. Type: Edm.Boolean
MakePrivate	A Boolean that indicates whether to save this view as private. Type: Edm.Boolean

Table 90. SaveViewAs return types
Type	Details
tm1.View	The saved view. Nullable: false

Element.SetComponent

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

IsBound: true

Table 91. SetComponent parameters
Name	Details
Parent	The parent element to set. Type: tm1.Element Nullable: false
Element	The element to set as a child of this parent. Type: tm1.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: tm1.Element
Weight	The weight of the element. Type: Edm.Double

Hierarchy.SetElement

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

IsBound: true

Table 92. SetElement parameters
Name	Details
Hierarchy	The hierarchy where the element will be inserted. Type: tm1.Hierarchy Nullable: false
Element	The element to insert. Type: tm1.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: tm1.Element

Subset.SetElement

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

Added: 10.2.2.6

IsBound: true

Table 93. SetElement parameters
Name	Details
Subset	The subset where the element will be inserted. Type: tm1.Subset Nullable: false
Element	The element to insert. Type: tm1.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: tm1.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: tm1.Element

Chore.SetServerLocalStartTime

Sets the local start time for a server.

Added: 10.2.2.1

IsBound: true

Table 94. SetServerLocalStartTime parameters
Name	Details
Chore	The chore to set the server start time for. Type: tm1.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

ProcessDebugContext.StepIn

Runs a single statement from the process.

If that statement is an ExecuteProcess function call, pause at the first statement inside that process.

IsBound: true

Table 95. StepIn parameters
Name	Details
Context	The debug context. Type: tm1.ProcessDebugContext Nullable: false

Table 96. StepIn return types
Type	Details
tm1.ProcessDebugContext

ProcessDebugContext.StepOut

Resumes execution and runs until the current process has finished.

IsBound: true

Table 97. StepOut parameters
Name	Details
Context	The debug context. Type: tm1.ProcessDebugContext Nullable: false

Table 98. StepOut return types
Type	Details
tm1.ProcessDebugContext

ProcessDebugContext.StepOver

Runs a single statement from the process.

If the statement is an ExecuteProcess function call, do not debug inside the function call.

IsBound: true

Table 99. StepOver parameters
Name	Details
Context	The debug context. Type: tm1.ProcessDebugContext Nullable: false

Table 100. StepOver return types
Type	Details
tm1.ProcessDebugContext

Cube.TraceCellCalculation

Traces the calculation of a single cell. The result will contain, recursively, any components of the calculation.

Added: 11.1.0

IsBound: true

Table 101. TraceCellCalculation parameters
Name	Details
Cube	Cube containing the cell that should be traced. Type: tm1.Cube Nullable: false
Tuple	Coordinates of the cell that should be traced. Type: Collection(tm1.Element)

Table 102. TraceCellCalculation return types
Type	Details
tm1.CalculationComponent	Represents the cell that was traced and the components of its calculation. Nullable: false

Cube.TraceFeeders

Get a list of cells that are fed by the specified cell.

Added: 11.1.0

IsBound: true

Table 103. TraceFeeders parameters
Name	Details
Cube	Cube containing the cell that should be traced. Type: tm1.Cube Nullable: false
Tuple	Coordinates of the cell that should be traced. Type: Collection(tm1.Element)

Table 104. TraceFeeders return types
Type	Details
tm1.FeederTrace	The feeder statements that use the source cell and the collection of resulting fed cells. Nullable: false

UndoChangeSet

Reverts a change set.

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

Added: 10.2.2.6

IsBound: false

Table 105. UndoChangeSet parameters
Name	Details
ChangeSetID	The ID of the change set to revert. Type: Edm.String Nullable: false

Cube.Unload

Unloads the cube from memory on the server.

Added: 11.6.0

IsBound: true

Table 106. Unload parameters
Name	Details
Cube	The cube to be unloaded. Type: tm1.Cube Nullable: false

Sandbox.Unload

Unloads the sandbox from memory on the server.

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

IsBound: true

Table 107. Unload parameters
Name	Details
Sandbox	The sandbox to be unloaded. Type: tm1.Sandbox Nullable: false

Cube.Unlock

Unlocks a cube, allowing modifications.

IsBound: true

Table 108. Unlock parameters
Name	Details
Cube	The cube to unlock. Type: tm1.Cube

Dimension.Unlock

Unlocks a dimension, allowing modifications.

IsBound: true

Table 109. Unlock parameters
Name	Details
Dimension	The dimension to unlock. Type: tm1.Dimension

Cellset.Update

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

IsBound: true

Table 110. Update parameters
Name	Details
Cellset	The cellset targeted by the update, specified in the resource path of the URL. Type: tm1.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: tm1.Cube
ReferenceCell	The cell, or slice, containing the source data required by the spreading command. Type: Collection(tm1.Element)
Value	The actual value, typically a spreading command, with which the cell is updated. Type: Edm.String Nullable: false

Cube.Update

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

Added: 10.2.2.1

IsBound: true

Table 111. Update parameters
Name	Details
Cube	The cube targeted by the update, specified in the resource path of the URL. Type: tm1.Cube Nullable: false
Slice	The slice of the cube targeted by the update. Type: Collection(tm1.Element)
Cells	The cells of the cube targeted by the update. Type: Collection(tm1.CellDescriptor)
ReferenceCube	The cube containing the source data required by the spreading command. Type: tm1.Cube
ReferenceCell	The cell containing the source data required by the spreading command. Type: Collection(tm1.Element)
Value	The actual value, typically a spreading command, with which the cell is updated. Type: Edm.String Nullable: false

Update

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

Added: 10.2.2.4

IsBound: false

Table 112. Update parameters
Name	Details
Cube	The cube targeted by the update, specified in the resource path of the URL. Type: tm1.Cube Nullable: false
Slice	The slice of the cube targeted by the update. Type: Collection(tm1.Element)
Cells	The cells of the cube targeted by the update. Type: Collection(tm1.CellDescriptor)
ReferenceCube	The cube containing the source data required by the spreading command. Type: tm1.Cube
ReferenceCell	The cell containing the source data required by the spreading command. Type: Collection(tm1.Element)
Value	The actual value, typically a spreading command, with which the cell is updated. Type: Edm.String Nullable: false

Cellset.UpdateCells

Applies updates to cells in a cellset.

Added: 11.0.0

IsBound: true

Table 113. UpdateCells parameters
Name	Details
Cellset	The cellset targeted by the update, specified in the resource path of the URL. Type: tm1.Cellset Nullable: false
Updates	Specifies the cells to update and the values with which to update the cells. Type: Collection(tm1.CellsetUpdate)
Order	The update order to use. Specify 0 for no ordering. The spreading commands are executed on each cell in the order that they are provided in Updates. Specify 1 to order the cells by level. Leaf cell values are set first and these leaf cells are held. Then, their parents are set and held, and so on, until the highest level consolidations are reached. Type: tm1.UpdateOrder

Cube.UpdateCells

Applies updates to cells of a cube.

Added: 11.0.0

IsBound: true

Table 114. UpdateCells parameters
Name	Details
Cube	The cube targeted by the update, specified in the resource path of the URL. Type: tm1.Cube Nullable: false
Updates	The cells of the cube targeted by the update and the values with which to update those cells. Type: Collection(tm1.CubeUpdate)
Order	The update order to use. Specify 0 for no ordering. The spreading commands are executed on each cell in the order that they are provided in Updates. Specify 1 to order the cells by level. Leaf cell values are set first and these leaf cells are held. Then, their parents are set and held, and so on, until the highest level consolidations are reached. Type: tm1.UpdateOrder