Adapter Configuration (GET)
Retrieves the user configuration of a specific adapter.
Roles
Users in the following roles are authorized to perform this operation:
- mfpadmin
- mfpdeployer
- mfpmonitor
- mfpoperator
Method
GET
Path
/management-apis/2.0/runtimes/runtime-name/adapters/adapter-name/config
Example
https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/adapters/myadapter/config?flattened=false&locale=de_DE&mode=defaults
Path Parameters
- runtime-name
- The name of the runtime. This is the context root of the runtime web application, without the leading slash.
- adapter-name
- The name of the adapter.
Query Parameters
Query parameters are optional.
- flattened
- If the parameter is set to
true
(default value), the configuration is a flat list of properties. If the parameter is set tofalse
, the configuration is a hierarchy of objects. - locale
- The locale used for error messages.
- mode
- If no mode is specified, the transaction returns the current user configuration. If the mode
defaults
is specified, the transaction returns the default configuration.
Produces
application/json, application/xml, text/xml
Response
The user configuration of the specified adapter.
JSON Example
{
"adapter" : "myAdapter",
"connectivity" : {
"http" : {
"connectionTimeoutInMilliseconds" : 30000,
"cookiePolicy" : "BEST_MATCH",
"dtdvalidationEnabled" : false,
"maxConcurrentConnectionsPerNode" : 49,
"maxRedirects" : 11,
"port" : 444,
"protocol" : "http",
"socketTimeoutInMilliseconds" : 30002,
},
},
"properties" : {
"database" : "test-db",
},
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<adapterconfig adapter="myAdapter">
<connectivity>
<http
connectionTimeoutInMilliseconds="30000"
cookiePolicy="BEST_MATCH"
dtdvalidationEnabled="false"
maxConcurrentConnectionsPerNode="49"
maxRedirects="11"
port="444"
protocol="http"
socketTimeoutInMilliseconds="30002"/>
</connectivity>
<properties database="test-db"/>
</adapterconfig>
Response Properties
The response has the following properties:
- adapter
- The name of the adapter.
- connectivity
- The connectivity details
- properties
- The properties of the adapter, mainly for Java adapters
The connectivity has the following properties:
- http
- The HTTP connection details
The httpdetails has the following properties:
- connectionTimeoutInMilliseconds
- The connection timeout value in milliseconds
- cookiePolicy
- The cookie policy to be used
- dtdvalidationEnabled
- Whether DTD validation is enabled for syntax and structure of the XML DTD
- maxConcurrentConnectionsPerNode
- The maximum number of concurrent connections allowed per node
- maxRedirects
- The maximum number of redirections allowed
- port
- The port used for the connection
- protocol
- The HTTP protocol used for connection
- socketTimeoutInMilliseconds
- The timeout value for socket
The properties has the following properties:
- database
- The name of the datbase to connect to.
Errors
403The user is not authorized to call this service.404
The corresponding runtime or the adapter is not found.500
An internal error occurred.