Table of Contents

Connections

Commands

Connections

IBM Planning Analytics TM1

IBM Cognos TM1 authentication connection.

Inputs

Input

Type

Detail

Notes

TM1 API Url

TextField

The full URL to your TM1 application (i.e. https://<Your TM1 URL here>/api/v1)

Username

TextField

Your TM1 User name

Password

TextField

Your TM1 password

Token

TextField

Your token for authentication (Only for Windows Integrated Authentication)

Authentication Type

DropdownField

The type of authentication used for your TM1 server (See https://www.ibm.com/support/knowledgecenter/en/SS9RXT_10.3.0/com.ibm.swg.ba.cognos.tm1_rest_api.10.3.0.doc/dg_tm1_odata_auth.html)

LDAP Namespace

TextField

This is the LDAP namespace for Cognos Authentication Manager (CAM) authentication.

Commands

Activate a Chore

Activate a Chore

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The Chore name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Deactivate a Chore

Deactivate a Chore

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The Chore name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Delete a Chore

Delete a Chore

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The Chore name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Delete a Cube

Delete a Cube

Inputs

Input

Type

Detail

Notes

Cube name

TextField

The Cube name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Delete a Cube View

Delete a Cube View

Inputs

Input

Type

Detail

Notes

Cube name

TextField

The Cube name

View name

TextField

The name of the View to delete

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Delete a Process

Delete a Process

Inputs

Input

Type

Detail

Notes

Process name

TextField

The Process name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Execute MDX

Execute an MDX function, and export it to a CSV

Inputs

Input

Type

Detail

Notes

MDX function

TextField

The MDX function to execute

Output type

DropdownField

The format of the generated CSV File

skipEmpty

BooleanField

If the value of a cell is empty (null) do not return it in the results.

Outputs

Output

Output Type

Notes

Cell data

File

Cellset ID

String

Total cells processed

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Execute a Chore

Run a Chore in TM1. NOTE: The Chore must not be activated in order to run it manually.

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The Chore name

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Execute a Process

Run a Process in TM1

Inputs

Input

Type

Detail

Notes

Process name

TextField

The Process name

Process params

MapField

The params to run the Process with

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

53

Error

The process failed to run

10

Error

Invalid Process parameter

55

Error

The process failed to run

Filter Message Logs

Get a list of the server's Message Logs

Inputs

Input

Type

Detail

Notes

Start date

TextField

The start date filter for the logs

End date

TextField

The end date of the filter for the logs

Max results

NumberField

The maximum amount of logs entries to retrieve

Outputs

Output

Output Type

Notes

Log file

File

Log entry count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Filter Transaction Logs

Get a list of the server's Transaction Logs

Inputs

Input

Type

Detail

Notes

Start date

TextField

The start date filter for the logs

End date

TextField

The end date of the filter for the logs

Max results

NumberField

The maximum amount of logs entries to retrieve

Cube filter

TextField

Filter Transaction logs by a specific Cube

User filter

TextField

Filter transaction logs by a specific User

Outputs

Output

Output Type

Notes

Log file

File

Log entry count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Generic HTTP Request

Execute a generic http request

Inputs

Input

Type

Detail

Notes

Request Body

TextField

The Request Body

Path of the Request

TextField

The URI request path

Request Method

DropdownField

Http Request Method

Request Parameters

GroupField

Http Request Parameters

Outputs

Output

Output Type

Notes

Http Response Body

File

Http Response Code

Integer

Http Response Headers

Json

Http Request Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Get Process Error Logs

Get a zipped up file of the process error logs.

Inputs

Input

Type

Detail

Notes

Start date

TextField

The start date filter for the logs

End date

TextField

The end date of the filter for the logs

Max results

NumberField

The maximum amount of logs entries to retrieve

Process name

TextField

The Process name

Outputs

Output

Output Type

Notes

Zipped logs

File

Log file count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Chore Tasks

Get a list of available Tasks in a Chore

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The name of the Chore to list the Tasks of

Outputs

Output

Output Type

Notes

ChoreTask steps

Array

ChoreTask count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Chores

Get a list of available Chores

Inputs

None

Outputs

Output

Output Type

Notes

Chore names

Array

Chore active settings

Array

Chore count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Cube Dimensions

Get a list of Dimension in a Cube

Inputs

Input

Type

Detail

Notes

Cube name

TextField

The name of the Cube of which to list the Dimensions

Outputs

Output

Output Type

Notes

Dimension names

Array

Dimension unique names

Array

Dimension count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Cube Views

Get a list of Views in a Cube

Inputs

Input

Type

Detail

Notes

Cube name

TextField

The name of the Cube of which to list the Views

Outputs

Output

Output Type

Notes

View names

Array

View count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Cubes

Get a list of Cubes

Inputs

None

Outputs

Output

Output Type

Notes

Cube names

Array

Cube count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Processes

Get a list of available Processes

Inputs

None

Outputs

Output

Output Type

Notes

Process names

Array

Process count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

List Users

Get a list of the servers Users

Inputs

None

Outputs

Output

Output Type

Notes

User unique names

Array

User names

Array

User types

Array

User enabled

Array

User actives

Array

User count

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Read View Cells

Generate a CSV with Hierarchies as headers of all of the Cell values in a View.

Inputs

Input

Type

Detail

Notes

Cube Name

TextField

The Cube name

View name

TextField

The View name

Output type

DropdownField

The format of the generated CSV File

Skip empty cells

BooleanField

If the value of a cell is empty (null) do not return it in the results.

Outputs

Output

Output Type

Notes

View data

File

Cellset ID

String

Total cells processed

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

Update Chore Task Parameters

Make changes to the parameters set for a given Chore Task

Inputs

Input

Type

Detail

Notes

Chore name

TextField

The Chore name

Task number

NumberField

The number of the Task to update the parameters of.

Parameters

MapField

The new parameter values for the Task

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

10

Error

Invalid Chore Task parameter

13

Error

The Chore Tasks specified has no parameters

17

Error

Cannot update a Chore while it has an active schedule

Write Cube Cells

Given a CSV file with the Hierarchy unique names as the headers, and a column header Value that holds the value, write these values to the specified Cube.

Inputs

Input

Type

Detail

Notes

Cube Name

TextField

The Cube name

File format

DropdownField

The format of the CSV File

CSV File

FileField

The CSV source file

Outputs

Output

Output Type

Notes

Cells updated count

Integer

Failed cell writes

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid arguments were provided

2

Error

Failed to authenticate with TM1

3

Error

The command failed to run, please contact support@oneceloud.io.

16

Error

Some of the cells failed to write to the Cube

Did this answer your question?