...
| Note |
|---|
If you find there is some functionality missing from the Workbench API that is necessary for your integration, feel free to contact us at [enquire] to discuss. |
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.
Predicate
...
Response
Detail Endpoints
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.
...
API Operations will usually be performed as the authenticating user (the Workbench account that was used in authentication).
For example…
However, some endpoints…
...
If you find and endpoint unexpected behaviour
...
,
...
check the setup
...
Postman
Postman is an third party application that lets you test and explore web APIs without having to write code. To get up and running with the Workbench API follow these steps:
...