Action Instances

Get action instance

get/action-runtime/action-instances/{actionInstanceId}

Request

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

actionInstanceIdstring required

Unique identifier of an action instance

Indicates the action instance was found 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.

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