Add and configure adapter

Adds and configures the specified adapter on the peer.

This topic includes the following sections:

For a video demonstration of how to use this call, see Adapter-management-API.

Request

HTTP method: POST

Request URL: https://<hostname>:<port>/baocdp/rest/adapter/add

Header: See HTTP-request-and-response-headers for header information, such as required authentication token.

Request body properties

Property	Type	Required	Description	Values	Default value
name	String	Yes	Adapter name	User-provided value	NA
description	String	No	Adapter description	User-provided value	NA
adapterType	String	Yes	Adapter type	User-provided value	NA
version	String	Yes	Adapter type version	User-provided value	NA
revision	String	Yes	Adapter type revision	User-provided value	NA
configuration	String	No	Adapter configuration details in XML format These vary based on the adapter. For more information about configuring adapters, see Configuring-adapters.	User-provided value	NA
configurationDataType	String	No	Adapter configuration details (XML)	XML	XML

Example request JSON

{
"name": "WebServiceAdapter",
"description":"This is a test description",
"adapterType": "ro-adapter-ws",
"version":"20.15.03.00",
"revision": "1",
"configuration":"<config><clear-asynchronous-cache>true</clear-asynchronous-cache><delay>10</delay></config>",
"configurationDataType":"xml"
}

Response

If successful, the adapter is added to the peer and configured.

Response body properties

Property	Description
adapterId	System-generated ID for the added adapter
status	Status of the request
message	Message associated with the request status

Example response JSON

{
"adapterId": "AdapterConfiguration1466676891545-17392293",
"status": "Success",
"message": "Requested adapter successfully configured."
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code	Message	Description
200	OK	Request succeeded
400		Bad request An error occurred while adding and configuring the adapter.
401		Unauthorized
405		Method not allowed