Skip to main content

Action Service

The action resource contains all the standard public and your own proprietary workflow actions


The Action REST API is a full CRUD API allowing you to search and filter actions as well as update, version and delete them. It is accessed through the following URL:

The API consists of the following calls:

GETGet the build information for this service
GET{release}/{source}v1/public v1/privateList public or private actions
GET{release}/{source}/{key}v1/private/TESTRetrieve a single action using its unique id
GET{release}/{source}/{key}/{version}v1/private/TEST/1Retrieve a version of a single action
GET{release}/{source}/{key}/*v1/private/TEST/*Get a list of versions for a specific action
PUT{release}/{source}/{key}/{version}/{tag}v1/private/TEST/1/PRODTag a version with a name (which can be used instead of the version number when retrieving it)
POST{release}v1Create or update an action, the action is the body of the POST request
DELETE{release}/{source}/{key}v1/private/TESTRollback to the previous version of an action, if it is the only version then the action will be deleted
DELETE{release}/{source}/{key}/{version}v1/private/TEST/1Delete a specific version of an action
DELETE{release}/{source}/{key}/*v1/private/TEST/*Fully delete an action, including all versions


Action Entity

The action entity contains the following information:

_idUnique id for the action (or object id if this is not the latest version of the action)String
_typeThe type of the action - always VarActionString
categoryThe category of the actionString
scriptA base64 encoded String of the entire script that created the actionString
inputsThe input parameters for the actionVarArg[]
outputsThe output values for the actionVarArg[]
exitsThe output transition namesString[]
_oidThe id of the action - will match _id if this is the latest version of the actionString
_timestampTimestamp of when this action version was createdString(DateTime)
_userThe user id (email) of the user that created this action versionString
_tagA list of version tag names for this action versionString[]
_versionThe version number of this action versionint

VarArg Entity

The VarArg entity is used for the input and output parameters of an action and contains the following:

_idThe variable name of the argumentString
optionalTrue if this is optional, false if it is mandatoryBoolean
argTypeThe variable type of the argumentString
_typeThe type of this entity - always VarArgString