Help Desk

Submit a ticket My Tickets
Welcome
Login

UltiPro Command Reference

Connector for the UltiPro API

Connections

UltiPro

Connection to authenticate with the UltiPro API with basic authentication.

Inputs

Input Type Detail Notes
Username TextField The UltiPro API users' username
Password TextField The UltiPro API user's password
Customer API Key TextField The Customer API Key (e.g. AAAAA)
User API Key TextField The User API Key (e.g. AAAA9A000000)
Host URL TextField The URL for your UltiPro API (e.g. https://service4.ultipro.com)

Commands

Execute Report

Runs a report request and then downloads the contents of the report to a CSV file.

Inputs

Input Type Detail Notes
Report Path TextField The path to the report. To find the path, on the report's properties page, select the View the search path link which will display the view dialog. Copy the contents of the Search path input. This is the report path you need.
Parameters GroupField The parameters to pass to the report. If the report has no parameters, you can ignore this field.

Outputs

Output Output Type Notes
Report File
Report Key String
Report Size (bytes) Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error running this command
2 Error Unable to authenticate with UltiPro

Get Report List

Returns a list of the public IBM Cognos reports

Inputs

Input Type Detail Notes
Name Filter TextField Optionally filter the reports returned by name. The filter will check if any part of the name contains the filter text (case insensitive).

Outputs

Output Output Type Notes
Reports Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error running this command
2 Error Unable to authenticate with UltiPro

Get Report Parameters

Retrieves a list of parameters for a report.

Inputs

Input Type Detail Notes
Report Path TextField The path to the report. To find the path, on the report's properties page, select the View the search path link which will display the view dialog. Copy the contents of the Search path input. This is the report path you need.

Outputs

Output Output Type Notes
Report Parameters Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error running this command
2 Error Unable to authenticate with UltiPro
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.