Documentation Service

The Documentation Service provides access to the Open API 3.1 documentation. This capability allows the client-side API tools to automatically build client-side code to use the APIs.

Generates the Open API Specification for Clearingworks Services.

Clearingworks includes its own Open API 3.x generator. This is particularly useful for cases where the PathInfoObjects aredynamic, based on Clearingworks configuration. For example, the QueryService use Biz Intel searches to supportadding/changing queries dynamically. Using the metadata from that service, this Open API generator can define newPath Infos based on the defined queries at runtime, and can provide that information directly in the Open API 3.xspecification. This capability allows the client-side API tools to automatically build client-side code to callthose queries.

SecurityNone
Request
query Parameters
serviceMatchExpr
required
string
useCase
required
string
Responses
200

Success

500

Internal Server Error

get/public/documentation/openAPI
Request samples 
➔ Next to Exceptions