API documentation: {adapter}/commands

API documentation: <adapter>/commands

Lists the available control commands that may be invoked on the external system or process model. In html format, a form is returned from which the commands may be invoked.

URL:

api/adapters/{externalsystem|processmodel}/commands[.format]

Example: api/adapters/externalsystem/commands.xml

Omitted format defaults to html.

Formats:

html, xml, json

HTTP Method(s):

GET

Response:

command
name	Identifies the command. To be used when invoking the command
documentation	A brief description of the command.
parameters	Lists the available paramaters for the command.
parameter
name	Identifies the parameter. To be used to specify parameters when invoking a command.
documentation	A brief description of the parameter.
mandatory	The parameter may not be omitted when mandatory is set to true.

Response example(s):

XML:

<commands>
  <command>
    <name>SayHello</name>
    <documentation>Says hello to the given person</documentation>
    <parameters>
      <parameter>
        <name>firstname</name>
        <mandatory>false</mandatory>
        <documentation>The first name of the person</documentation>
      </parameter>
      <parameter>
        <name>surname</name>
        <mandatory>false</mandatory>
        <documentation>Probably the family name of the person</documentation>
      </parameter>
    </parameters>
  </command>
  <command>
    <name>SayBye</name>
    <documentation>Says bye</documentation>
    <parameters/>
  </command>
</commands>