HTTP Method | Description | Template |
GET | Lists the available adapter connection factory types for AS/400 Adapter. | { "method" : "describeConnectionFactory", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/describe/ {adapterTypeName}/connection/", "input" : "", "output" : "" } |
GET | Describes all the fields for AS/400 Adapter and the specified adapter connection factory type . | { "method" : "describe", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/describe/ {adapterTypeName}/connection/ {connectionFactoryTypeName}/", "input" : "", "output" : "" } |
GET | Retrieves the list of all available adapter connections for AS/400 Adapter. | { "method" : "list", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/connection/ {adapterTypeName}/?expand={expandValue}" "input" : "", "output" : "" } |
GET | Retrieves the fields and their values for the specified adapter connection. | { "method" : "get", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/connection/ {adapterTypeName}/{connectionAlias}/", "input" : "", "output" : "" } |
POST | Creates a new adapter connection. | { "method" : "post", "httpMethod" : "POST", "urlTemplate" : "/admin/adapters/connection/", "input" : "", "output" : "" } Note: You can get the list of fields for an adapter connection by invoking the describe method in the AS/400 Adapter Administrator API. Sample for creating an adapter connection. { "adapterTypeName": "AS400Adapter", "connectionFactoryType": "DATAQUEUE", "connectionAlias": "Test_Conn_DATAQUEUE", "system": "AS400ServerName", "userId": "sagcc", "password": "sagccpass", "initProgram": "", "currentLibrary": "TESTLIB", "poolable": "true", "minimumPoolSize": "1", "maximumPoolSize": "10", "poolIncrementSize": "1", "blockingTimeout": "1000", "expireTimeout": "1000" } For more details on input parameters and sample, see
Configuring Adapter Connections. |
PATCH | Updates the specified adapter connection details. | { "method" : "update", "httpMethod" : "PATCH", "urlTemplate" : "/admin/adapters/connection/ {connectionAlias}", "input" : "", "output" : "" } Note:  You can get the list of fields for an adapter connection by invoking the describe method in the AS/400 Adapter Administrator API.You can get the existing fields values for the specific adapter connection by invoking the get method in the AS/400 Adapter Administrator API.You must specify all the fields for the adapter connection in the request body.For more details on input parameters and sample, see
Configuring Adapter Connections. |
DELETE | Deletes the specified adapter connection. | { "method" : "delete", "httpMethod" : "DELETE", "urlTemplate" : "/admin/adapters/connection/ {connectionAlias}", "input" : "", "output" : "" } |
PUT | Enables or disables the specified adapter connections. | { "method" : "stateChange", "httpMethod" : "PUT", "urlTemplate" : "/admin/adapters/connection/ {connectionAlias}/?action={enableValue}", "input" : "", "output" : "" } |