Update adapter configuration

Updates the specified adapter, including name, description, and configuration.

This topic includes the following sections:

Request

HTTP method: PUT

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

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

Request parameters

Parameter

Type

Required

Description

Values

Default value

name

String

Yes

Name of the adapter to update

You can retrieve a list of adapter names using Get all adapters.

User-provided value

Existing user-defined value

NA

Request body properties

Property	Type	Required	Description	Values	Default value
name	String	Yes	New adapter name	User-provided value	NA
description	String	No	New 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	New configuration details If using Autopilot-AD-Utilities:HTTP:PUT process, wrap the configuration in the CDATA tag. Example: `{ "name": "AR_Tenantnew", "description":"Remedy Adapter for new Tenant", "adapterType": "ro-adapter-remedy-actor", "version":"20.19.01.00", "revision": "1", "configuration":"<![CDATA[<config>.....</config>]]>", "configurationDataType":"XML" }`	User-provided value	NA
configurationDataType	String	No	Adapter configuration details (XML string)	XML	XML

Example request JSON

{
    "name": "WebServiceAdapterNew",
    "description":"New adapter configuration",
    "adapterType": "ro-adapter-ws",
    "version":"20.16.02.00",
    "revision": "1",
    "configuration":"<config><clear-asynchronous-cache>true</clear-asynchronous-cache><delay>30</delay></config>",
    "configurationDataType":"xml"
}

Response

If successful, this method updates the specified adapter's configuration.

Response body properties

Property	Description
adapterId	System-generated ID for the updated 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 updated."
}

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 updating adapter. The adapter name might not have been specified.
401		Unauthorized
405		Method not allowed