Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

StateDescription
PostedAdaptor is successfully POSTed. An API consumer can make this request or it can be done through the YOUnite UI.
Configured

The adaptor has:

  • Connected successfully to the YOUnite Datahub via the message bus/broker
  • Subscribed to the appropriate message broker topics
  • Created its message broker queue
PauseThe adaptor is running but not accepting adaptor (read/write) requests.

Play Read-Only

The adaptor is accepting read requests only.
PlayThe adaptor is accepting read and write requests.


An adaptor state can be changed using the request:

Anchor
opsAdaptorState
opsAdaptorState

...

The states normally set by the YOUnite Data Hub are: POSTED, CONFIGURED, and DOWN. The ../controls endpoint changes an adaptor's state to operational states and those normally set only by the datahub. However, there may be situations where you want to use this endpoing endpoint to set these states, such as if an adaptor is an unknown state and restarting the adaptor does not provide a remedy.

Note: Under normal circumstances this resource should never be used and it can render an adaptor and the source entity read/write requests in an unknown state.

This resource overwrites the adaptor to a state normally set by the

...

YOUnite Data Hub. Valid states for this request are the normal adaptor operational states:

  • ADAPTOR_PAUSE
  • ADAPTOR_PLAY
  • ADAPTOR_PLAY_RO

And the states normally set only by the datahub:

  • ADAPTOR_POSTED
  • ADAPTOR_CONFIGURED
  • ADAPTOR_DOWN


Code Block
languagejs
PUT /zones/zone-uuid/adaptors/adaptor-uuid/controls

...