Swagger documentation

The APIs exposed by the ITX REST API are documented using Swagger.

To access the Swagger documentation, enter the following URL in a browser. If the tx-rest.war file is installed on a server other than the local host, adjust the host name.

http://localhost:8080/tx-rest/api-docs?url=/tx-rest/swagger.json

You can invoke the APIs directly from the Swagger documentation by clicking Try it out under each API definition.

Note: The Swagger page descriptions for the GET trace and audit endpoints include warnings informing users that retrieving these logs will return an error if the initial map run was configured with preserveAudit=true or preserveTrace=true.