Command line syntax for the HTTP API

Use the command line interface to issue HTTP API requests that create, delete, and modify content in InfoSphere® Information Analyzer.

The command line interface program, IAAdmin, is stored in the following directory:

(Windows) \IBM\InformationServer\ASBNode\bin
(Linux, UNIX) /IBM/InformationServer/ASBNode/bin

The syntax for running HTTP API commands from the command line is:

IAAdmin
[-help| -h]
-user <user name>
-password <password>
-url https://<host name>:<port number>
[-xml | -csv | -xsl <XSL file name>]
[-output <output file name>]
-listProjects  |
-getProject -projectName <project name>  |
-listRuleDefinitions -projectName <project name> |
-listExecutableRules -projectName <project name> |
-listGlobalVariables |
-getRuleDefinition -projectName <project name> -ruleName 
<rule name 1> |
-getExecutableRule -projectName <project name> -ruleName 
<rulename 2>  |
-create -projectContent <XML file name> |
-update -projectContent <XML file name> |
 -deleteProject -projectName <project name> |
-deleteExecutionHistory -projectName <project name> 
                 -ruleName <rule or rule set name>
                 -executionID <execution ID> |
                 -keepLastRuns <number of runs to keep> |
                 -olderThanNMonths <number of months to keep> |
                 -olderThanNWeeks <number of weeks to keep> |
                 -olderThanDate <date in yyyy-mm-dd format>
-deleteOutputTable -projectName <project name>
                   -ruleName <rule or rule set name> 
                   [-executionID <execution ID> |
                   -keepLastRuns <Number of runs to keep> | 
                   -olderThanNMonths <Number of months to keep> |
                   -olderThanNWeeks <Number of weeks to keep> | 
                   -olderThanDate <date in yyyy-mm-dd format>] 
-deleteRuleDefinition -projectName <project name> -ruleName 
<rule> |
-deleteExecutableRule -projectName <project name> -ruleName 
<rule or rule set name> |
-deleteGlobalVariables -variable <variable name>
-runTasks -content <XML file name> |
-getColumnAnalysisResult -projectName <project name> 
                         -columnName <dataStoreName.dataBaseName.
tableName.columnName>|

-getOutputTable -projectName <project name> 
                -ruleName <rule or rule set name> |
                [-subRule <subrule1 name> [, <subrule2 name>...]]
                -executionID <execution ID> 
                [-startIndex StartIndex
	              -nbOfRows <number of rows>]  |
-getFrequencyDistribution -projectName <project name> 
                          -columnName <dataStoreName.dataBaseName.
tableName.columnName>
                          [-maxNbOfValues <maximum number of values>] 
                          [-startIndex <start index>]  
                          [-ordering <ordering>]  |
-getFormatDistribution -projectName <project name> 
                          -columnName <dataStoreName.dataBaseName.
tableName.columnName>
                          [-maxNbOfValues <maximum number of values>] 
                          [-startIndex <start index>]  
                          [-ordering <ordering>]  | 
-getExecutionHistory -projectName <project name> 
                     -ruleName <rule or rule set name>
-getMetrics -projectName <project name>  
           [-metricName <MetricName>] | 
-deleteMetric -projectName <ProjectName>  
              -metricName <MetricName> | 
-getMetricExecutionHistory  -projectName <ProjectName>  
                            -metricName <MetricName> | 
-publishResults -content <XMLFileName> |
-deletePublishedResults -projectName <ProjectName>  
                        -tableName <FullyQualifiedTableName> | 
-getPublishedResults -projectName <ProjectName> | 
-getKeyAnalysisResults  -projectName <ProjectName>  
                        -tableName <TableName> | 
-getCrossDomainAnalysisResults  -projectName <ProjectName>  
                                -columnName<dataStoreName.dataBaseName.
tableName.columnName> 
                                -percentOverlapThreshold <percentOverlapThreshold> | 
-getReferentialIntegrityAnalysisResults  
                     -projectName <ProjectName>  
                     -baseColumnName <dataStoreName.dataBaseName.
tableName.baseColumnName>
                     -pairedColumnName <dataStoreName.dataBaseName.
tableName.pairedColumnName> | 
-publishRule -projectName <ProjectName>  
             -ruleName <rule name> | 
-getPublicRules  | 
-getPublicRule -ruleName <rule name>  | 
-deletePublicRule -ruleName <rule name>  | 
-copyPublicRule -ruleName <rule name> 
-setIADBParams -iaDBHost <HostSystemName> 
			-iaDBDataConnection <DataConnectionName> 
			-iaDataSource <JNDINameDefinedForDataSource> 
			[-projectName <ProjectName>] |
-setDSParams [-projectName <ProjectName>] 
			-dsHost <DataStageHostName> 
			[-dsUser <DataStageUserName> 
			-dsPassword <DataStagePassword> 
			-dsPort <DataStagePortNumber> 
			-dsProject <DataStageProjectName> 
			-handlerName <HandlerName> 
			-retainOSH TRUE|FALSE 
			-arraySize <Arraysize> 
			-isolationLevel <IsolationLevel> 
			-autoCommitMode 0 | 1 
			-useCredentialMapping TRUE|FALSE] |
-getIADBParams [-projectName <ProjectName>] |
-getDSParams [-projectName <ProjectName>]

Note:

The projectName cannot contain any of the following characters: % (percent sign), \ (backslash), " (double quote), ' (single quote).

You must enclose any parameter that contains a space in double quotation marks. For example:

IAAdmin -user admin -password admin -url https://localhost:9443 -xml -output
 c:\temp\allrules.xml -list RuleDefinitions -projectName "New Project"