...
All that is required to POST an adaptor is an adaptor name. If the request succeeds, an adaptor UUID and security credentials are returned.
POST /zones/661f5d763c9000a9-6bc73eb6-4fc041fe-97fda11b-f331ab6833795a5859020c65/adaptors
Code Block | ||
---|---|---|
| ||
{ "name": "My First Adaptor" } |
...
Code Block | ||
---|---|---|
| ||
{ "uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a", "zoneUuid": "661f5d763c9000a9-6bc73eb6-4fc041fe-97fda11b-f331ab6833795a5859020c65", "clientId": "64ed6954-3987-4020-9553-54d9e4e7d258", "clientSecret": "76e33a67-8e8c-4209-ae38-5e4fa59fd452" } |
...
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:
|
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
...
Code Block | ||
---|---|---|
| ||
{ "uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a", "name": "Test Adaptor1", "zoneUuid": "3c9000a9661f5d76-3eb66bc7-41fe4fc0-a11b97fd-5a5859020c65f331ab683379", "state": "ADAPTOR_POSTED", "dateCreated": 1503634367407, "lastUpdated": 1503635641288, "changeVersion": 4117664412 } |
...
Code Block | ||
---|---|---|
| ||
{ "state": "ADAPTOR_PLAY_RO", "changeVersion": 4117664412 } |
Manage an Adaptor
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
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.
GET /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a/registration
The response would look similar to:
Code Block | ||
---|---|---|
| ||
{
"uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
"zoneUuid": "661f5d76-6bc7-4fc0-97fd-f331ab683379",
"clientId": "64ed6954-3987-4020-9553-54d9e4e7d258",
"clientSecret": "76e33a67-8e8c-4209-ae38-5e4fa59fd452"
} |