Action Definitions

Get action definition

get/action-repository/action-definitions/{actionDefinitionId}

Request

Base URL
http://localhost:8090/action-api
Auth
HTTP basic
TypeScript
https://skmtc.dev/flowable/apis/flowable-action-rest-api/docs/action-repository/action-definitions/:actionDefinitionId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

actionDefinitionIdstring required

Unique identifier of the action definition

Query parameters

scopeIdstring

Unique identifier of a scope

scopeTypestring

Type of a scope

formIdstring

The optional id of the form definition in which the action is located

formFieldIdstring

The optional id of the form field. This is mandatory if formId is set

Response

Indicates the action definition was found and returned.

idstring required

The unique identifier of an action definition

namestring

The name of the action definition

keystring required

The key of the action definition

versioninteger required

The version of the action definition

deploymentIdstring

The deployment id of the action definition

tenantIdstring

The tenant id of the action definition

resourceNamestring

The resource name of the action definition

descriptionstring

The description of the action definition

formKeystring

The form key for the action definition

scopeTypestring

The optional scope type for the action definition

scopeIdstring

The optional scope id for the action definition

confirmationMessagestring

The confirmation message for the action definition

confirmationTitlestring

The confirmation title for the action definition

themestring

The theme for the action definition

iconstring

The icon for the action definition

samplestring

A sample how this action definition can be used

helpstring

Help text for the action definition

botKeystring

The key for the bot, if this action definition has a bot

globalboolean required

Flag indicating whether this action definition is a global one

priorityinteger

The optional priority of the action, which can be used for sorting the actions

groupIdstring

The optional grouping id for the action

actionInstanceIdstring

The id of the action instance (if this action definition is actually an action instance)

startDatestring

The start date in ISO 8601 for the action instance (if this action definition is actually an action instance)

formInstanceIdstring

The id of the form instance for the action instance (if this action definition is actually an action instance)

translationsobject

The translations for the action instance. Map having locale as the key and key value pairs for each locale.

Changes

No recorded changes to this operation across all 1 revision of this API.