API Explorer 935 endpoints

Get Message Docs Swagger

GET /obp/v7.0.0/message-docs/CONNECTOR/swagger2.0

OBPv3.1.0-getMessageDocsSwagger No role required Message-DocDocumentationAPI

This endpoint provides example message docs in swagger format. It is only relavent for REST Connectors.

This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS). That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.

i.e.:

OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)

User Authentication is Optional. The User need not be logged in.

URL Parameters:

CONNECTOR: CONNECTOR

JSON response body fields (0)
Possible errors (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv3.1.0 getMessageDocsSwagger Originally /obp/v3.1.0/message-docs/CONNECTOR/swagger2.0