HTTP Method | Description | Template |
GET | Lists the available adapter listener factory types for AS/400 Adapter. | { "method" : "describeConnectionFactory", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/describe/ {adapterTypeName}/listener/", "input" : "", "output" : "" } Note: This AS/400 Adapter's Administrator API returns an empty value as the AS/400 Adapter does not have explicit listener factory types. |
GET | Describes all the fields for AS/400 Adapter. | { "method" : "describe", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/describe/ {adapterTypeName}/listener/{listenerTemplate}/", "input" : "", "output" : "" } Note: The variable listenerTemplate is a dummy value as the AS/400 Adapter does not have explicit listener factory types. You can use this AS/400 Adapter's Administrator API to retrieve the fields and their default values for a listener. |
GET | Retrieves the list of all available adapter listeners for AS/400 Adapter. | { "method" : "list", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/listener/ {adapterTypeName}/?expand={expandValue}", "input" : "", "output" : "" } |
GET | Retrieves all the fields for the specified adapter listener. | { "method" : "get", "httpMethod" : "GET", "urlTemplate" : "/admin/adapters/listener/ {adapterTypeName}/{listenerAlias}/", "input" : "", "output" : "" } |
POST | Creates a new adapter listener | { "method" : "post", "httpMethod" : "POST", "urlTemplate" : "/admin/adapters/listener/", "input" : "", "output" : "" } Note: You can get the list of fields for an adapter listener by invoking the describe method in the AS/400 Adapter Administrator API. Sample for creating an adapter listener. { "adapterTypeName":"AS400Adapter", "connectionAlias":"Test_Conn_DATAQUEUE", "notificationNodeName":"WAS:listenerService", "notificationEnabled":"true", "notificationInterval":"-1", "dataQueueName":"/QSYS.LIB/TESTLIB.LIB/MYDATAQ.DTAQ", "isKeyedDataQueue":"false", "keyType":"String", "keyLength":"50", "keyValue":"NAME", "keyCompareType":"EQ" } For more details on input parameters and sample, see
Configuring Data Queue Listeners. |
PATCH | Updates the specified adapter listener details. | { "method" : "update", "httpMethod" : "PATCH", "urlTemplate" : "/admin/adapters/listener/ {listenerAlias}", "input" : "", "output" : "" } Note: You can get the list of fields for an adapter listener by invoking the describe method in the AS/400 Adapter Administrator API. You can get the existing field values for the specific adapter listener by invoking the get method in the AS/400 Adapter Administrator API. You must specify all the fields for the adapter listener in the request body. For more details on input parameters and sample, see
Configuring Data Queue Listeners. |
DELETE | Deletes the specified adapter listener. | { "method" : "delete", "httpMethod" : "DELETE", "urlTemplate" : "/admin/adapters/listener/ {listenerAlias}", "input" : "", "output" : "" } |
PUT | Enables or disables the specified adapter listener. | { "method" : "stateChange", "httpMethod" : "PUT", "urlTemplate" : "/admin/adapters/listener/ {listenerAlias}/?action={enableValue}", "input" : "", "output" : "" } |