...
| State | Description |
|---|
| Posted | Adaptor is successfully POSTed. An API consumer can make this request or it can be done through the YOUnite UI. |
| Configured | The adaptors had a: - Successful connection to the YOUnite Datahub via the message bus/broker
- Subscribed to the appropriate message broker topics
- Its message broker queue has been created
|
| Pause | The adaptors is running but not accepting adaptor (read/write) requests. |
Play Read-Only | The adaptor is accepting read requests only. |
| Play | The adaptor is accepting read and write requests.
|
Start the Adaptor - Connect to the Hub
Once the adaptor has been added and configured, it can be launched. It should successfully connect to the hub and move briefly into the "Configured" state and then into the "Play" state unless otherwise configured.
TODO KEVIN: Debugging
Change an
...
Adaptor's
...
State
An adaptor state can be changed using the request:
...
| Code Block |
|---|
|
{
"uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
"name": "Test Adaptor1",
"zoneUuid": "661f5d76-6bc7-4fc0-97fd-f331ab683379",
"state": "ADAPTOR_POSTED",
"dateCreated": 1503634367407,
"lastUpdated": 1503635641288,
"changeVersion": 4117664412
} |
Pause
The following request and request body will change an adaptor's state to "pause":
| Code Block |
|---|
|
PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a
|
| Code Block |
|---|
|
{
"state": "ADAPTOR_PAUSE",
"changeVersion": 4117664412
} |
Play
The following request and request body will change an adaptor's state to "play":
| Code Block |
|---|
|
PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
| Code Block |
|---|
|
{
"state": "ADAPTOR_PLAY",
"changeVersion": 4117664412
} |
Play Read Only
The following request and request body will change an adaptor's state to "play read only":
| Code Block |
|---|
|
PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
| Code Block |
|---|
|
{
"state": "ADAPTOR_PLAY_RO",
"changeVersion": 4117664412
} |
...
See the YOUnite API documentation (https://younite.us/api) for more requests that can be made to the adaptors endpoint. A few common requests include:
Deleting an Adaptor
| Code Block |
|---|
|
DELETE /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
Get Credentials for an Adaptor
By default only the zone data steward can retrieve the credentials for an adaptor.:
| Code Block |
|---|
|
GET /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a/registration |
The response would look similar to:
...