Versions Compared

Version Old Version 8 New Version 9
Changes made by

Cam Mackay

Cam Mackay

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Clients

There are multiple ways to consume the Workbench API

  • PowerShell scripts installed as recurring tasks

  • JavaScript web apps

  • NSwagStudio is part of the NSwag toolchain and can be used to generate C# client code.

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:

...