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.

lastErrorProblemDetails — unresolved $ref

Changes

Changed in 10 of the 67 revisions of this API.11012

Oct 12, 2025abce40efa7012See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 20259088b70544d42See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 2025b389c0efc2392See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 20256ea21199b7262See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 20256915d62b393a122See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 2025a52f8ca5b6712See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 23, 2025474599254bb92See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 21, 2025078670d5b1161See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Sep 21, 20254531c91133742See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 10, 202541e4e0c694983See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added

Full history