Action model

The rest API provides a list of actions you can execute for each record.

These actions can be requested by sending a request with Accept header set to application/hal+json

The API will then respond with a list of available actions per record.

Getting a list of actions

A list of all actions can be requested by sending a request to /action-definitions

Executing an action

They can be executed in 2 ways:

Sending a request to /records/{recordId}/actions/{actionName} for a specific record
Sending a request to /actions/{actionName} to execute for a list of record ids or query

Custom actions

Engine plugins can define additional actions which can be active for specific organisations.

The /plugins endpoint returns a list of all available engine plugins.

To activate an engine plugin (and thus a custom action) for an organisation, it must be linked to a module plugin of category ActionModel via the uri property. Additionally, a module containing the module plugin must be active for the organisation.

A module plugin can be fetched by performing a GET request to /module-plugins/{modulePluginId}:

{
  "Id": <module plugin id>,
  "Name": <name of the module plugin id>,
  "Category": "ActionModel",
  "Uri": <name of the engine plugin>
}