...
To see the current Workbench OpenAPI definition, go to [swagger]the Swagger UI dashboard screen in your instance of Web Workbench. 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.
...
The Workbench API covers most of the functionality available in Web Workbench. An API The API is form-based, meaning an endpoint will usually correspond to a specific screen or form 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 ‘List’, and they return a paged list of resources. They only support the POST HTTP method because a JSON predicate object must be provided in the body of the request, which filters and sorts the returned data. Usually no query parameters are required.
...
Request
Response
Detail Endpoints
These endpoints end with the suffix ‘Detail’. The , and provide detailed information on specific items. They 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.
...
This is a ‘List’ endpoint, which accepts a predicate like object and returns a filtered list of database rows.
TableRowApi
This is a ‘Detail’ endpoint, which returns provides access to a particular object or resourcedatabase row.
User
Most API operation are performed as the logged in user (i.e. the Workbench user that was logged in when the the client token for the authentication header was generated). However, some methods will always be performed as a special Workbench Admn user. This user always has a PersonID of 1 and has access to all permissions. Some methods also accept a PersonID in the request that will be used to perform the operation. If you find some unexpected behaviour, please check the setup of the performing user.
...