<< Back to GIL API Documentation

API documentation: pipeline/stages

Returns a list of stages present in the transfer pipeline.

Data transferred between the process model and the external system passes the transfer pipeline. The transfer pipeline consists of zero or more stages. Each stage can monitor or process data, which is specific to each implementation of a stage.

URL:

api/pipeline/stages[.format]

Example: api/pipeline/stages.xml

Omitted format defaults to html.

Formats:

html, xml, json

HTTP Method(s):

GET

Response:

ElementDescription
seqNoIndicates where the stage is placed in the chain of stages in the transfer pipeline. seqNo 0 indicates the first stage.
nameA descriptive name of the transfer pipeline stage.
commandsThe uri to the list of available control commands on the stage.

Response example(s):

XML:

<pipelineStages>
    <pipelineStage>
        <seqNo>0</seqNo>
        <name>ConvertStage</name>
        <commands>http://localhost:9980/api/pipeline/stages/0/commands.xml</commands>
    </pipelineStage>
</pipelineStages>