Commands that get or list content

Use these commands to get or list content from InfoSphere® Information Analyzer.

When you use a command to issue an HTTP API request that gets or lists content, you can specify how the output of the command is returned. By default, commands return plain text to the console. However, you can specify that a get or list command return a file that is in XML file format or in comma-separated value (CSV) file format, or you can apply an XSLT style sheet to transform the XML that is returned by the command into a custom format.

The basic syntax to display the output of a command on the console is the following:
IAAdmin -user user_name -password password -url https://host:port option -[suboption]
For example, the following command gets the list of existing projects and displays it on the console. The display includes success or failure error codes for the operation due to the use of the-v option.
IAAdmin -user admin -password admin -url https://myhost:9443 -listProjects -v
The basic syntax to save the output of a command to a file is as follows:
IAAdmin -user user_name -password password -url https://host:port output_file_type 
-output output_file_path option -[suboption]
For example, the following command gets the list of existing rules for the project Project1 and returns the list in the XML file allrules.xml:
IAAdmin -user admin -password admin -url https://myhost:9443 -xml -output
c:\temp\allrules.xml -listRuleDefinitions -projectName Project1

Basic parameters

Table 1. Basic parameters
Parameter Description
-user user_name Name of the user (required)
-password password Password to use (required)
-help or -h Displays list of available IAAdmin parameters
-v Verbose. If specified, success or failure error codes are displayed on the console or are sent to the specified file. The success code is (200). Error code 400 indicates that the request was bad. Error code 500 indicates that there was a server error. Consult the application server log files for more details.
-url https://host:port Host name and port number of the server (required)
-xml Specifies XML file format. If you use this option, the command returns data in XML file format.
-csv Specifies comma-separated value (CSV) file format. If you use this option, the command returns data in a comma-separated file format that you can easily open in a spreadsheet. The default CSV output contains multi-line headers. To obtain CSV output with single-line headers, use the -xsl option with provided XSL files that produce single-line header output.
-xsl XSL_path_and_file_name

Specifies the path and file name of the XSLT style sheet to use to transform the XML document that is returned.

-output output_file_name Specifies the full path and file name of the file that stores the output from the command. If you do not specify this option, the console displays the output.

Options that get or list content

Table 2. Options that get or list content
Content to get or list Option
List of all projects -listProjects
Content of a specified project -getProject
-projectName project_name
List of data rule definitions in a specified project -listRuleDefinitions
-projectName project_name
List of data rules in a specified project -listExecutableRules
-projectName project_name
List of all global variables defined on the system -listGlobalVariables
Content of a rule or rule set definition -getRuleDefinition
-projectName project_name
-ruleName  rule_or_rule_set_definition_name
Content of a data rule or data rule set -getExecutableRule
-projectName project_name
-ruleName rule_name_or_rule_set_name
Column analysis results for a specified column -getColumnAnalysisResult
-projectName project_name
-columnName column_name

Content of the output table of a specified data rule or data rule set.

You can use the -subRule option to limit output to results based on a subset of rules in a rule set.

If -subRule is specified, the value for -ruleName must be the name of a rule set, and the value or values for -subRule must be names of rules in the specified rule set.

-getOutputTable
-projectName project_name
-ruleName rule_or_rule_set_name[
-subRule subrule1_name[, subrule2_name...] ]
-executionID execution ID
-startIndex start_index
-nbOfRows number_of_rows
Frequency distribution of a specified column -getFrequencyDistribution -projectName project_name
-columnName data_store_name.database_name.
table_name.column_name
-maxNbOfValues maximum_number_of_values
-startIndex start_index
-ordering ordering
Format distribution of a specified column

The output returns the frequency, percent and format for each distinct format of the values in the column.

-getFormatDistribution -projectName project_name
-columnName data_store_name.database_name.
table_name.column_name
-maxNbOfValues maximum_number_of_values
-startIndex start_index
-ordering ordering
Execution history of a rule or rule set -getExecutionHistory
-projectName project_name
-ruleName rule_or_rule_set_name
Content of metrics -getMetrics
-projectName project_name
[-metricName metric_name]
Execution history of a metric -getMetricExecutionHistory
-projectName project_name
-metricName metric_name
Published analysis results for a specified project -getPublishedResults
-projectName project_name
Primary key candidates for a specified table -getKeyAnalysisResults
-projectName project_name
-tableName table_name
Foreign key and cross-domain analysis results -getCrossDomainAnalysisResults
-projectName project_name
-columnName dat_ store_name.database name.
table_name.column_name
-percentOverlapThreshold percent_overlap_threshold
Referential integrity analysis results -getReferentialIntegrityAnalysisResults
-projectName project_name
-baseColumnName data_store_name.
database_name.table_name.base_column_name
-pairedColumnName paired_column_name
List of published rules and rule sets -getPublicRules
Content of a specified published rule or rule set definition -getPublicRule
-ruleName rule_or_rule_set_definition_name
Display default InfoSphere Information Analyzer analysis database parameters -getIADBParams
-projectName project_name
Display default data stage options -getDSParams
-projectName project _name