---
title: "Execute an action definition"
method: POST
path: "/action-repository/action-definitions/{actionDefinitionId}/execute"
tags: ["Action Definitions"]
---

# Execute an action definition

`POST /action-repository/action-definitions/{actionDefinitionId}/execute`

## Request

- Base URL: `http://localhost:8090/action-api`
- URL: `http://localhost:8090/action-api/action-repository/action-definitions/{actionDefinitionId}/execute`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-action-rest-api/docs/action-repository/action-definitions/:actionDefinitionId/execute/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `actionDefinitionId` string, required

## Query parameters

- `scopeDefinitionId` string
- `scopeId` string
- `scopeType` string
- `formId` string
- `formFieldId` string

## Request body

- object

## Response `200`

Indicates the action definition was found and executed.

- ActionInstanceExecutionResponse: The response for an execution of an action instance
  - `id` string, required: The id of the historic action instance.
  - `actionDefinitionId` string, required: The action definition id of this historic action instance
  - `scopeDefinitionId` string: The definition id of the scope for this action instance
  - `scopeId` string: The scope id for this action instance
  - `scopeType` string: The scope type for this action instance
  - `startDate` string, required: The date when this action instance was started in ISO 8601
  - `executedBy` string: The id of the user that executed the action instance
  - `executionDate` string: The date when this action instance was executed in ISO 8601
  - `formInstanceId` string: The id of form instance that is linked with this action instance
  - `priority` integer: The optional priority of the action, which can be used for sorting the actions
  - `tenantId` string: The tenant id
  - `intent` IntentResponse: The response for an intent
    - `type` string, required: The type of the intent
  - `executionPayload` JsonNode
    - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
    - `array` boolean
    - boolean
    - `float` boolean
    - `containerNode` boolean
    - `integralNumber` boolean
    - `floatingPointNumber` boolean
    - `pojo` boolean
    - `long` boolean
    - `int` boolean
    - `valueNode` boolean
    - `missingNode` boolean
    - `object` boolean
    - `short` boolean
    - `double` boolean
    - `bigDecimal` boolean
    - `bigInteger` boolean
    - `textual` boolean
    - `boolean` boolean
    - `binary` boolean
    - `number` boolean

## Other responses

- `403`: Indicates the user does not have the rights to execute the action definition.
- `404`: Indicates the requested action definition was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-action-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-action-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-action-rest-api/revisions/d8a514102707?raw)