Fetch Processes:
Fetch a list of all process names in the specified application.
API Query: | Processes?$select=Name |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes?$select=Name |
API Call Type: | GET |
Fetch Process Definition:
Fetch a definition of the specified process.
API Query: | Processes('<process_name>') |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes('<process_name>') |
API Call Type: | GET |
Fetch Process Definition - Specific Components:
Fetch a definition of the specified process and return specific components.
API Query: | Processes('<process_name>')?$select=Name,HasSecurityAccess,PrologProcedure,MetadataProcedure,DataProcedure,EpilogProcedure,Parameters,Variables,UIData,VariablesUIData,DataSource/Type,DataSource/dataSourceNameForServer,DataSource/dataSourceNameForClient,DataSource/asciiDecimalSeparator,DataSource/asciiDelimiterChar,DataSource/asciiDelimiterType,DataSource/asciiHeaderRecords,DataSource/asciiQuoteCharacter,DataSource/asciiThousandSeparator,DataSource/view,DataSource/query,DataSource/userName,DataSource/password,DataSource/usesUnicode,DataSource/subset |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes('<process_name>')?$select=Name,HasSecurityAccess,PrologProcedure,MetadataProcedure,DataProcedure,EpilogProcedure,Parameters,Variables,UIData,VariablesUIData,DataSource/Type,DataSource/dataSourceNameForServer,DataSource/dataSourceNameForClient,DataSource/asciiDecimalSeparator,DataSource/asciiDelimiterChar,DataSource/asciiDelimiterType,DataSource/asciiHeaderRecords,DataSource/asciiQuoteCharacter,DataSource/asciiThousandSeparator,DataSource/view,DataSource/query,DataSource/userName,DataSource/password,DataSource/usesUnicode,DataSource/subset |
API Call Type: | GET |
Delete Process:
Delete a specified process.
API Query: | Processes('<process_name>') |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes('<process_name>') |
API Call Type: | DELETE |
Run Process:
Run a specified process (without parameters).
API Query: | Processes('<process_name>')/tm1.ExecuteWithReturn |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes('<process_name>') |
Post Body: | {"Parameters":[]} |
API Call Type: | POST |
Run Process with Parameters:
Run a specified process (with parameters).
API Query: | Processes('<process_name>')/tm1.ExecuteWithReturn |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Processes('<process_name>') |
Post Body: | {"Parameters": [{"Name": "<parameter1_name>","Value": "<parameter1_value>"},{"Name": "<parameter2_name>","Value": "<parameter2_value>"}]} |
API Call Type: | POST |