Skip to main content
POST
{BASE_URL}
/
api
/
runtime
/
wks
/
{workspaceId}
/
app
/
{appId}
/
rdi
/
{resourceDefinitionId}
/
start
/
inherit-from
/
{processInstanceId}
curl -X POST "{BASE_URL}/api/runtime/wks/{workspaceId}/app/{appId}/rdi/{resourceDefinitionId}/start/inherit-from/{processInstanceId}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "flowx-platform: web" \
  -H "Accept: application/json" \
  -d '{
    "paramsToInherit": {
      "paramsToCopy": ["customerName", "customerId", "accountType"]
    }
  }'

{
  "processDefinitionFlowxUuid": "66e74ea1-0775-42b4-b27e-a4a21ea78dfc",
  "buildId": "7d5560be-3846-49fa-9c17-4059c54c7c5f",
  "buildStatusAtStart": "COMMITTED",
  "applicationId": "dbe0ab87-539b-4015-962d-6e73226b9e58",
  "workspaceId": "ws-123456789",
  "parentApplicationId": null,
  "rootApplicationId": null,
  "processDefinitionName": "customer_onboarding_child",
  "tokens": [
    {
      "id": 2112691,
      "state": "ACTIVE",
      "statusCurrentNode": "ARRIVED"
    }
  ],
  "state": "STARTED",
  "uuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d",
  "instanceMetadata": {
    "processInstanceId": 2112617,
    "processInstanceUuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d"
  }
}

​
Base URL

  • Always prepend the endpoint with the correct Base URL for your environment.
  • For different environments (like staging or production), switch the base URL accordingly.

​
Path Parameters

Need help finding these IDs? See the Finding Identifiers and Parameters guide for detailed instructions on where to locate these values in FlowX Designer.
The combination of workspaceId, appId, and resourceDefinitionId must be valid and associated in the system. The processInstanceId must reference an existing process instance from which values will be inherited.
​
workspaceId
string
required
The ID of the workspace where the process will be started. This parameter is now required to support multi-workspace environments.
​
appId
string
required
The ID of the application in which the process will be started.
​
resourceDefinitionId
string
required
The ID of the resource definition that defines the process to be started. This is typically used when starting processes from UI actions.
​
processInstanceId
string
required
The UUID of the related process instance from which parameter values will be inherited. This allows the new process to start with data from an existing process.

​
Request Headers

​
Authorization
string
required
Bearer token required for authentication. Format: Bearer <token>.
​
Content-Type
string
required
Indicates the media type of the request body. Must be set to application/json.
​
Flowx-Platform
string
required
Identifies the client platform (e.g., web, mobile).
​
Accept
string
Specifies the media types that are acceptable for the response. Example: application/json, text/plain, */*.
​
Accept-Encoding
string
Indicates supported content encoding algorithms for the response. Example: gzip, deflate, br, zstd.
​
Accept-Language
string
Specifies language preferences for the response. Example: en-GB,en-US;q=0.9,en;q=0.8.

​
Request Body

The request body should contain a paramsToInherit object that controls which parameter values are inherited from the related process instance.
​
paramsToInherit
object
required
A map containing information about which values to copy from the related process instance. This object can contain one of the following keys:
  • paramsToCopy (array of strings): Use this to pick only a subset of parameters to be inherited from the parent process. It holds the list of key names that will be inherited from the parent parameters.
  • withoutParams (array of strings): Use this to remove specific parameter values from the parent process before inheriting them. It holds the list of key names that will be removed from the parent parameters.
If neither key is provided or both are empty, all parameter values from the parent process will be inherited by the new process.

​
Example Request Body

{
  "paramsToInherit": {
    "paramsToCopy": ["customerName", "customerId", "accountType"]
  }
}
When designing your process inheritance strategy, consider which parameters are truly needed in the new process. Use paramsToCopy for explicit control or withoutParams to exclude sensitive or temporary data.

​
Response

​
processDefinitionFlowxUuid
string
The unique identifier of the process definition within FlowX.
​
buildId
string
The ID of the build associated with the process.
​
buildStatusAtStart
string
The status of the build at the time the process was started (e.g., “COMMITTED”).
​
applicationId
string
The ID of the application where the process was initiated.
​
workspaceId
string
The ID of the workspace where the process was started.
​
parentApplicationId
string or null
The ID of the parent application if applicable, otherwise null.
​
rootApplicationId
string or null
The ID of the root application if applicable, otherwise null.
​
processDefinitionName
string
The name of the process definition that was started.
​
tokens
array
A list of tokens representing active workflow states within the process.
​
state
string
The current state of the process instance (e.g., “STARTED”).
​
uuid
string
The unique identifier for the newly created process instance.
​
instanceMetadata
object
Metadata related to the process instance, including:
  • processInstanceId: The numeric ID of the process instance.
  • processInstanceUuid: The UUID of the process instance.

​
Response Headers

​
Access-Control-Allow-Credentials
boolean
Indicates whether the response can be exposed when credentials are present. Value is true.
​
Access-Control-Allow-Headers
string
Lists the allowed headers in the actual request.
​
Access-Control-Allow-Methods
string
Specifies the allowed HTTP methods.
​
Access-Control-Allow-Origin
string
Indicates the allowed origin for cross-origin requests.
​
Content-Encoding
string
Specifies the encoding used to compress the response.
​
Content-Type
string
Indicates the media type of the response content.
​
Strict-Transport-Security
string
Enforces secure (HTTPS) connections to the server.
​
X-Content-Type-Options
string
Prevents the browser from MIME-sniffing a response away from the declared Content-Type.
​
X-XSS-Protection
string
Controls the cross-site scripting (XSS) filter.
curl -X POST "{BASE_URL}/api/runtime/wks/{workspaceId}/app/{appId}/rdi/{resourceDefinitionId}/start/inherit-from/{processInstanceId}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "flowx-platform: web" \
  -H "Accept: application/json" \
  -d '{
    "paramsToInherit": {
      "paramsToCopy": ["customerName", "customerId", "accountType"]
    }
  }'

{
  "processDefinitionFlowxUuid": "66e74ea1-0775-42b4-b27e-a4a21ea78dfc",
  "buildId": "7d5560be-3846-49fa-9c17-4059c54c7c5f",
  "buildStatusAtStart": "COMMITTED",
  "applicationId": "dbe0ab87-539b-4015-962d-6e73226b9e58",
  "workspaceId": "ws-123456789",
  "parentApplicationId": null,
  "rootApplicationId": null,
  "processDefinitionName": "customer_onboarding_child",
  "tokens": [
    {
      "id": 2112691,
      "state": "ACTIVE",
      "statusCurrentNode": "ARRIVED"
    }
  ],
  "state": "STARTED",
  "uuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d",
  "instanceMetadata": {
    "processInstanceId": 2112617,
    "processInstanceUuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d"
  }
}

​
Triggering from FlowX Designer

This endpoint is triggered through a Send data to user interface node action configured in FlowX Designer:
1

Add node action

Add a Send data to user interface action to the node where you want to trigger the child process.
2

Configure message type

Set the Message type to action to enable process triggering capabilities.
3

Configure inheritance parameters

In the action configuration, specify which parameters should be inherited using paramsToCopy or withoutParams in the action payload.
For detailed instructions on configuring node actions in FlowX Designer, see the Managing a Process Flow documentation.

​
Use Cases

This endpoint is particularly useful for:
  • Multi-step workflows: Starting a child process that continues work begun in a parent process
  • Process chaining: Creating related processes that share common data
  • UI-triggered actions: Starting processes from user interface actions that need to carry over existing data
  • Data inheritance: Maintaining context across related process instances while controlling which data is passed forward
This endpoint is specifically designed for runtime operations initiated from UI actions. The workspaceId parameter ensures proper isolation in multi-tenant environments.