Preview Flow Run Parameters

post

https://api.habu.com/v1/cleanrooms/{cleanroomId}/cleanroom-flows/{cleanroomFlowId}/preview-flow-run-parameters

Returns the expected runtime and partition parameters for each question node that would be included in a flow run, without actually creating a run. Accepts the same request shape as Create Cleanroom Flow Run. If parentFlowRunId is set on the request, it is treated as a replay scenario.

Path Params

cleanroomId

string

required

Cleanroom ID

cleanroomFlowId

string

required

Cleanroom Flow ID

Body Params

Input for previewing flow run parameters

branches

string

Branch names to filter flow execution (comma-separated)

excludeNodesWithoutTags

boolean

Exclude nodes without tags when branch filtering is enabled

ignoreParentChildRule

boolean

Ignore parent-child dependency rules

includeMismatchingTaggedNodes

boolean

Include unmatched nodes when branch filtering is enabled

datasetAssignments

array of objects

Dataset assignments for each node (used to derive partition parameters)

datasetAssignments

parentFlowRunId

string

When set, preview is treated as a replay of this parent flow run

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Successfully retrieved the preview of flow run parameters.

400Bad Request - Incorrect syntax or request

401Authorization information was missing or invalid

404The specified resource was not found

500Internal Server Error