...
Adaptor configuration (metadata) and capabilities can be added. Most adaptors self-register their capabilities but there may be a need to override them. be added to the POST request body. The metadata must be in JSON format and the capabilities JSON schema can be seen below (TODO - More on capabilities):
...
Code Block | ||
---|---|---|
| ||
{ "uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a", "zoneUuid": "3c9000a9-3eb6-41fe-a11b-5a5859020c65", "clientId": "8c9167a6-bb83-4f77-bdfc-1947a946f77b", "clientSecret": "de02e3fa-4b23-46cb-aed6-5665a16e73d3" } |
The metadata and adaptor capabilities can be updated with a PUT request.
WARNING: HTTP PUT stipulates that all properties defined in the PUT request body must be provided. Any properties omitted or left blank will overwrite the resource with a null value.
Note: Steps 2 through 4 are implementation specific. After they are completed, continue on to step 5, below.
...
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 adaptor has:
|
Pause | The adaptor 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. |
An adaptor state can be changed using the request:
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||
---|---|---|
| ||
DELETE /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
Note: When you delete an adaptor it is a soft delete (meaning the adaptor's "active" setting will be set to false). A soft-delete for entities avoids purging important information, including that which can be used to associate past activity in the system, such as logged events, zone, and adaptor type.
However, the linking (mapping) between the (YOUnite) Data Record and the source entities in the source system attached to the deleted adaptor will be hard deletes. Linking for deleted adaptors is hard-deleted as this particular data carries no useful additional data or metadata (the link entities are just an adaptorUuid and a drUuid). Post-delete, an adaptor's linking history can still be viewed in system logs that should include all the relevant details about that link, as well as a log timestamp.
Get Credentials for an Adaptor
...