Rhapsody Integration Engine (Rhapsody) includes a programmatic Application Programming Interface (API) that allows external applications to access information about the status of components in the Rhapsody engines, and modify the state of components. It also allows access to messages in the Error and Hold Queues.

The API is a set of web services that can be accessed remotely using any application that supports calling web services. The unauthenticated services allow access to basic information about the state of the Rhapsody engine, and the authenticated services provide access to information on the configuration and status of components in the engine. The authenticated services require a Rhapsody username and password, and are governed by the access permissions defined in the User Manager.

All queries and responses are provided over an encrypted Web service connection (HTTPS) which defaults to being available on port 8449. Refer to Framework Settings for details on how this default port can be changed, and how to configure which SSL certificate should be used.

All operations in the API web services support both the SOAP 1.1 and 1.2 bindings, and provide optional support for WS-Addressing.

Unauthenticated API Services

No authentication is required to access any of the operations in this service.

Service

WSDL Location

Description

 Access Rights

Rhapsody Status

https://<RhapsodyEngine>:
<WSPort>/services/RhapsodyStatusService?wsdl

Provides simple operations to determine the status of the Rhapsody engine. Primarily, this is status information while Rhapsody is starting up, and a ping operation to verify that it is still responding. No authentication is required to access any of the operations in this service.
  • 'Call the Rhapsody Web Services API'.

Authenticated API Services

These services are authenticated using a Rhapsody username and password. Authentication is performed using a WS-Security UsernameToken over the HTTPS connection. The password must be provided as plain text, rather than as a digest. As an encrypted connection is in use these passwords are not visible to any other application.

Service

WSDL Location

Description

 Access Rights

System Statistics

https://<RhapsodyEngine>:<WSPort>/services/SystemStatisticsService?wsdl

Provides operations to retrieve message counts for individual components or the entire engine, memory usage for the engine, and the ability to export historical values for all of those statistics.
  • 'Call the Rhapsody Web Services API'.
  • 'Export system statistics', 'View system statistics', 

    'Log in to Management Console' (for getMemoryUsageStatistics, getTotalCountStatistics,  getComponentCountStatistics).

Rhapsody Components

https://<RhapsodyEngine>:<WSPort>/services/RhapsodyComponentsService?wsdl

Provides operations to find the communication points and routes in the Rhapsody configuration, simple statistical information about these components, and allows them to be stopped and started.
  • 'Call the Rhapsody Web Services API'.

Message Searching

https://<RhapsodyEngine>:<WSPort>/services/MessageSearchingService?wsdl

Provides a mechanism to find messages on the Error and Hold Queues, retrieve details about these messages, and reprocess or delete them.
  • 'Call the Rhapsody Web Services API'.

  • 'View message bodies' and 'View message properties' (for getMessage).

  • 'Delete held/errored messages' (for deleteMessageFromTable).

  • 'Release/reprocess messages' (for releaseMessageFromTable).

Lookup Tables

https://<RhapsodyEngine>:<WSPort>/services/LookupTableService?wsdl

Provides operations to lookup values contained within Rhapsody lookup tables.
  • 'Call the Rhapsody Web Services API'.

<RhapsodyEngine> is the hostname or IP address of the server being queried. <WSPort> is the port number defined for the Secure Web Services API. The default port is 8449 (you can change the port number via the property WebServiceApi.httpsPort in the rhapsody.properties file).

For example:

https://<RhapsodyEngine>:<WSPort>/services/RhapsodyStatusService?wsdl

becomes

https://MyRhapsodyEngineServer:8449/services/RhapsodyStatusService?wsdl