Sign in
Credentials

Gets the state of an existing exchange and returns it in the response body.

Gets the configuration of an existing exchange and returns it in the response body.

get/workflows/{localWorkflowId}/exchanges/{localExchangeId}

Parameters

./components/parameters/path/LocalWorkflowId.yml — unresolved $ref
./components/parameters/path/LocalExchangeId.yml — unresolved $ref

Response

Exchange configuration retrieved!

idstring

The local exchange ID that identifies the exchange.

sequenceinteger

A sequence number for the exchange. Set to 0 on creation.

expiresstring

The date and time (expressed as an XML Schema dateTimeStamp) that the exchange expires.

stepstring

The current step in the exchange.

statestring

The status ("pending" | "active" | "complete" | "invalid") of the exchange, set to "pending" on creation.

Changes