...
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'.
| Note |
|---|
If you find there is some functionality missing from the Workbench API that is necessary for your integration, feel free to contact us. |
List Endpoints
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.
...
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
Most API methods operation are performed as the logged in user (i.e. the Workbench account user that was used to generate 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 and endpoint some unexpected behaviour, please check the setup of the performing user.
...