engine-cmd

Synopsis

engine-cmd [-h|-help|-?|-list|-list-xml|<function> [help|<name>=<value>]]
      

Description

The engine-cmd command is located in the bin subdirectory of Watson Explorer Engine installation. This command enabled you to execute any Watson Explorer Engine SOAP/REST API function from the command line. Additionally, the command can be used to provide detailed help for an API function.

Options

• -h|-help|-? Displays the command line help message and exits.
• -list Displays a list of all the available API functions. This list is very long. Make sure your terminal buffer is sufficiently large enough to accommodate it. Utilities such as more and less are useful for analyzing this list.
• -list-xml Displays a list of all the available API functions in XML format which is more useful for programmatic consumption. This list is very long. Make sure your terminal buffer is sufficiently large enough to accommodate it.
• <function> help Returns compresensive help about the specified function.
• <function> [<name>=<value>[...]] Performs the Watson Explorer Engine REST API function using the specified parameters. The API response is then delivered to the command line. The xml header is included in the response. Any API function may be performed by the engine-cmd command, use the -list or -list-xml for a complete list of available API commands and expected syntax.

When executed with no arguments, the engine-cmd command displays the same output as if it had been called with its -help option.

Exit Status

• 0 - Command executed successfully
• 1 - Command encountered an error
• 2 - Missing command line argument or usage requested