REST APIs
The REST APIs screen lists the workflows that have been registered as REST APIs using the Register Workflow as REST API Wizard. To access the screen, select the Data > Rest APIs folder in the LiveCompare hierarchy.
The workflows are displayed in a table which has the following columns:
Workspace
The name of the workspace in which the workflow is stored.
Workflow
The name of the workflow registered as a REST API.
Swagger
Click this link to display the Swagger (Open API) user interface for the REST API. The following endpoints are available.
| Endpoint | Description |
|---|---|
| run (post) | Runs the workflow referenced by the REST API. |
| result (post) | Returns the result of the workflow referenced in the REST API. The result is available when the workflow has completed. |
| status (post) | Returns the execution status of the workflow referenced in the REST API. |
| version (get) | Retrieves the version of LiveCompare. |
Swagger Json
The JSON representation of the REST API. The URL may be pasted into Tosca’s API scanner by carrying out the following steps:
-
Select the workflow’s link in the Swagger Json column and choose Copy link address from the context menu.
-
Open a Tosca workspace, and click API Scan in the API TESTING tab.
-
Click URL and paste the Swagger Json URL into the Enter URL to scan field.
-
Click OK.
The REST API’s endpoints will be available in the API scan hierarchy. The POST result, POST run and POST status payloads may be populated with values and then run. The GET version method may be run to retrieve the installed version of LiveCompare.
Delete REST APIs
To delete one or more REST APIs, select the checkbox next to each table entry and click Delete. To mark all the REST APIs for deletion, select the checkbox in the column heading. Deleting REST APIs requires LiveCompare Editor permissions. If a REST API is deleted, any API tokens associated with it are also deleted.