FLflowable
Action Instances

Create action instance

post/action-runtime/action-instances

Request

Request body

actionDefinitionIdstring

The id of the action definition that should be used when creating the action instance. One of actionDefinitionId or actionDefinitionKey must be provided.

actionDefinitionKeystring

The key of the action definition that should be used when creating the action instance. One of actionDefinitionId or actionDefinitionKey must be provided.

scopeIdstring

The id of the scoped object for which this action instance is being created for. When this property is set, then scopeType must also be set.

scopeTypestring

The type of the scoped object for which this action instance is being created for. When this property is set then scopeId must also be set.

scopeDefinitionIdstring

The definition id of the scoped object for which the action instance is being created for.

formInstanceIdstring

The id of the form instance that is linked with the action instance.

priorityinteger

The priority of the action instance. If not set it will use the one from the action definition model.

tenantIdstring

The id of the tenant that the created action instance will belong to. By default it is the tenant of the current user. Can only be set by users with admin privileges.

Response

Indicates the action instance was created and returned.

idstring required

The unique identifier for the action instance.

namestring required

The name for the action instance.

actionDefinitionIdstring required

The id of the action definition for this action instance.

scopeDefinitionIdstring

The optional definition id for the scoped object.

scopeIdstring

The optional id of the scope that is linked with this action instance. If this property is set then scopeType is also set.

scopeTypestring

The optional type of the scope that is linked with this action instance. If this property is set then scopeId is also set.

startDatestring required

The starting date of the action instance in ISO 8601 format.

formKeystring

The key of the form linked with this action instance.

formParentDeploymentIdstring

The parent deployment id of the form linked with this action instance. If not set it means newest form.

formInstanceIdstring

The id of the form instance linked with this action instance.

priorityinteger

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

tenantIdstring

The id of the tenant that this action instance belongs to.

Changes

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