API documentation: stages/{seqNo}/commands

API documentation: stages/<seqNo>/commands

Returns a list of the available control commands on the stage with the given seqNo. In html format, a form is returned from which the commands may be invoked.

URL:

api/pipeline/stages/<seqNo>/commands[.format]

Example: /api/pipeline/stages/0/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>bypass</name>
    <documentation>Bypasses the convert stage i.e. the passing values are unaffected.</documentation>
    <parameters>
      <parameter>
        <name>doBypass</name>
        <mandatory>true</mandatory>
        <documentation>true|false to switch the bypass on or off.</documentation>
      </parameter>
    </parameters>
  </command>
</commands>