Adapter Administrator APIs

Overview

The administrator can manage adapter resources such as connections, listeners and notifications using Integration Server Administrator. Alternatively, you can use the REST APIs provided by the Adapter Administrator API.

You can use any REST API client to invoke the Adapter Administrator APIs. Refer the REST API client documentation for more information on how to use the client. You must use your Integration Server Administrator credentials to authenticate the Adapter Administrator APIs to access adapter resources from the API client.

REST URL Structure

An Adapter Administrator API makes resources accessible through a URL path. All Adapter Administrator API requests must be issued using HTTP or HTTPS. The Adapter Administrator API supports the standard HTTP methods such as GET, POST, PUT, PATCH, and DELETE. Not all resources support all HTTP methods.

An absolute URL for an Adapter Administrator API resource has the following structure:

http://host:port/admin/adapters/resourceType/{resourceId}

Where:
  • http is the transport protocol. You can use HTTP or HTTPS.
  • host:port is the host and port of the Integration Server on which you want to administer adapter resources.
  • admin/adapters is the directive for the adapter's Administrator API.
  • resourceType is the type of resource, such as adapter connection, adapter listener or adapter notification.
  • resourceId identifies a specific resource.

For example, the following API retrieves all the adapter connections for XXXAdapter:

HTTP GET http://host:port/admin/adapters/connection/XXXAdapter

Adapter Operations

Common Request Parameters

The following request parameters are commonly used in REST URL to invoke the Adapter Administrator APIs.

Parameter Name Parameter Description
adapterTypeName Adapter type name registered with the Integration Server.
Note: You can get the display name and adapter type name of all the adapters registered with Integration Server by invoking the Adapter Administrator API as follows: GET /admin/adapters
connectionAlias Name of the adapter connection.
connectionFactoryTypeName Name of the adapter connection factory type.
Note: You can get the list of adapter connection factory types available for the specified adapter by invoking the Adapter Administrator API as follows: GET /admin/adapters/describe/{adapterTypeName}/connection
listenerAlias Name of the adapter listener.
listenerFactoryTypeName Name of the adapter listener factory type.
Note: You can get the list of adapter listener factory types available for the specified adapter by invoking the Adapter Administrator API as follows: GET /admin/adapters/describe/{adapterTypeName}/listener
listenerTemplate Same as listenerFactoryTypeName parameter.
notificationAlias Name of the adapter notification.
notificationType Name of the adapter notification type. The values allowed for notificationType are:
  • polling.
  • listener.
Note: You can have either or both the adapter notification types depending on the specified adapter.

Connection, Listener and Notification Operations

The following adapter Administrator APIs are available for adapter connection, listener and notification operations:

Operation Description
GET /admin/adapters
  Lists the adapter name and adapter type of all the adapters registered with Integration Server.
Connection Operations
GET /admin/adapters/connection
  Lists aggregate connections of all adapters.
GET /admin/adapters/describe/{adapterTypeName}/connection
  Lists the available adapter connection factory types for the specified adapter type.
GET /admin/adapters/describe/{adapterTypeName}/connection/{connectionFactoryTypeName}?expand={expandValue}
  Lists the fields or the fields with metadata for the specified adapter type and the specified adapter connection factory type. The values allowed for expandValue query parameter are:
  • true. Displays all the fields and the metadata of the fields for the specified adapter type and the specified adapter connection factory type.
  • false. Default. Displays all the fields for the specified adapter type and the specified adapter connection factory type.
GET /admin/adapters/connection/{adapterTypeName}?expand={expandValue}
  Retrieves the list of all available adapter connections for the specified adapter type. The values allowed for expandValue query parameter are:
  • true. Displays the details of each adapter connection.
  • false. Default. Displays the name and URL of each adapter connection.
GET /admin/adapters/connection/{adapterTypeName}/{connectionAlias}
  Retrieves the fields and their values for the specified adapter connection.
POST /admin/adapters/connection
  Creates a new adapter connection.
Note: You can get the list of fields for an adapter connection by invoking the describe method in Adapter Administrator API.

For more details about the input parameters and samples, see the respective adapter's section in Adapter Specific Samples.

PATCH /admin/adapters/connection/{connectionAlias}
  Updates the specified adapter connection details.
Note:
  • You can get the list of fields for an adapter connection by invoking the describe method in Adapter Administrator API.
  • You can get the existing fields values for the specific adapter connection by invoking the get method in Adapter Administrator API.
  • You must specify all the fields for the adapter connection in the request body.

For more details about the input parameters and samples, see the respective adapter's section in Adapter Specific Samples.

DELETE /admin/adapters/connection/{connectionAlias}
  Deletes the specified adapter connection.
PUT /admin/adapters/connection/{connectionAlias}?action={enableValue}
  Enables or disables the specified adapter connection. The values allowed for enableValue query parameter are:
  • enable. Enables adapter connection.
  • disable. Disables adapter connection.
  • reset. Refreshes the adapter connection.
Listener Operations
GET /admin/adapters/describe/{adapterTypeName}/listener
  Lists the available adapter listener factory types for the specified adapter type.
GET /admin/adapters/describe/{adapterTypeName}/listener/{listenerTemplate}
  Describes all the fields for the specified adapter type and the specified adapter listener template.
GET /admin/adapters/listener/{adapterTypeName}?expand={expandValue}
  Retrieves the list of all available adapter listeners for the specified adapter type. The values allowed for expandValue query parameter are:
  • true. Displays the details of each adapter listener.
  • false. Default. Displays the name and URL of each adapter listener.
GET /admin/adapters/listener/{adapterTypeName}/{listenerAlias}
  Retrieves all the fields for the specified adapter listener.
POST /admin/adapters/listener
  Creates a new adapter listener.
Note: You can get the list of fields for an adapter listener by invoking the describe method in Adapter Administrator API.

For more details about the input parameters and samples, see the respective adapter's section in Adapter Specific Samples.

PATCH /admin/adapters/listener/{listenerAlias}
  Updates the specified adapter listener details.
Note:
  • You can get the list of fields for an adapter listener by invoking the describe method in Adapter Administrator API.
  • You can get the existing fields values for the specific adapter listener by invoking the get method in Adapter Administrator API.
  • You must specify all the fields for the adapter listener in the request body.

For more details about the input parameters and samples, see the respective adapter's section in Adapter Specific Samples.

DELETE /admin/adapters/listener/{listenerAlias}
  Deletes the specified adapter listener.
PUT /admin/adapters/listener/{listenerAlias}?action={enableValue}
  Enables or disables the specified adapter listener. The values allowed for enableValue query parameter are:
  • enable. Enables the adapter listener.
  • disable. Disables the adapter listener.
Notification Operations
GET /admin/adapters/notification/{adapterTypeName}?node={notificationType}&expand={expandValue}
  Retrieves the list of all available adapter notifications. The values allowed for expandValue query parameter are:
  • true. Displays the details of each adapter notification.
  • false. Default. Displays the name and URL of each adapter notification.
GET /admin/adapters/notification/{adapterTypeName}/{notificationAlias}?node={notificationType}
  Retrieves all the fields for the specified adapter notification.
DELETE /admin/adapters/notification/{notificationAlias}?node={notificationType}
  Deletes the specified adapter notification.
PUT /admin/adapters/notification/{notificationAlias}?node={notificationType}&action={enableValue}
  Enables or disables the specified adapter notification. The values allowed for enableValue query parameter are:
  • enable. Enables the adapter notification.
  • disable. Disables the adapter notification.