...
To see the current Workbench OpenAPI definition, go to [swagger]. The Swagger UI app is embedded into Web Workbench and shows a complete list of all endpoints and supported operations, as well as providing an interactive client to test them in the browser in real time. This is usually a good place to start getting familiar with the Workbench API.
Releases of the Workbench API come bundled with releases of Web Workbench, so the share the same version numbers and release schedule.
Structure
The Workbench API covers most of the functionality available in Web Workbench. An API endpoint will usually correspond to a specific screen in Web Workbench and share the same business logic. Generally speaking there are 2 different types of endpoints: 'List' and 'Detail'.
...
These endpoints end with the suffix ‘Detail’. The expose the CRUD operations of a resource and so usually support the GET, POST, and DELETE HTTP methods. These operations are symmetric, meaning that they share the same JSON data structure. So that the response from a GET request can be modified and used as the body of a POST request to update the resource.
User
API Operations will usually be performed as the authenticating user (the Workbench account that was used in authentication).
For example…
However, some endpoints…
| Note |
|---|
If you find and endpoint unexpected behaviour it could be related to…, so check the setup of … |