Upgrade adapter

Upgrades the specified adapter version and revision. From the Grid Manager UI, you can only upgrade one adapter at a time. By using the REST API, you can upgrade many adapters on the grid.

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/upgrade

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	Name of the adapter to upgrade You can provide multiple names (shown in the example). You can retrieve a list of adapter names using Get-all-adapters.	User-provided value Existing user-defined value	NA
adapterType	String	Yes	Adapter type	User-provided value	NA
version	String	Yes	Version to which adapter should be upgraded	User-provided value	NA
revision	String	Yes	Revision to which adapter should be upgraded	User-provided value	NA

Example request JSON

{"adapters":[{    "name": "WebServiceAdapter",
       "adapterType": "ro-adapter-ws",
   "version":"20.16.02.00",
   "revision": "1"
},
{
  "name": "HTTPAdapter",
     "adapterType": "ro-adapter-http",
   "version":"20.16.02.00",
   "revision": "1"
}
]
}

Response

If successful, this method upgrades the adapter version and revision.

Response body properties

Property	Description
status	Status of the request
message	Message associated with the request status

Example response JSON

{
"status": "Success",
"message": "Requested adapter/s successfully upgraded."
}

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 upgrading the adapter
401		Unauthorized
405		Method not allowed