Action Definitions

Execute an action definition by key

post/action-repository/action-definitions/key/{actionDefinitionKey}/execute

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/key/:actionDefinitionKey/execute/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

actionDefinitionKeystring required

Key of the action definition

Query parameters

scopeDefinitionIdstring

Unique identifier of a scope definition

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

Request body

object required

Response

Indicates the action definition was found and executed.

idstring required

The id of the historic action instance.

actionDefinitionIdstring required

The action definition id of this historic action instance

scopeDefinitionIdstring

The definition id of the scope for this action instance

scopeIdstring

The scope id for this action instance

scopeTypestring

The scope type for this action instance

startDatestring required

The date when this action instance was started in ISO 8601

executedBystring

The id of the user that executed the action instance

executionDatestring

The date when this action instance was executed in ISO 8601

formInstanceIdstring

The id of form instance that is linked with this action instance

priorityinteger

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

tenantIdstring

The tenant id

Changes

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