Versions Compared

Key

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


Warning

This API is not public anymore. Existing endpoints are maintained, but no support will be provided for new integrations.


Quick reference

Latest versionDocumentation
1.0 (alpha)

REST API endpoints

...

OperationHTTP method

Create

POST

Read

GET

Update

PUT (complete data) -  PATCH (partial data)

Delete

DELETE

...


As a convention, parameters required for actions on particular resources (for instance actions applied to a specific ticket in the previous example), are defined as path variables.  Query parameters are only used to refine the request (like filtering or sorting). When a frequently used action requires the setting of specific parameters, then it is aliased (i.e. a new action with abstraction of parameters).

...