(EXPERIMENTAL) Execute a flow
Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
Request Body
inputsobject · requiredInputs of the flow by name. A transformation refers to an input by its name.
transformationsobject[]Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.
Responses
The flow was accepted.
linksobject · requiredLinks to the execution result.
(EXPERIMENTAL) Apply the given cancel tokens to flows
Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
Responses
OK
resultIdToCancelTokenPairsobject · requiredresultId to cancel token pairs
(EXPERIMENTAL) List the operations of flows
Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
Responses
OK
operationsobject[] · requiredAvailable operations.
(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
resultIdstring · requiredResult ID
query Parameters
rowOffsetinteger · int32Index of the first row to return. The default is 0.
rowLimitinteger · int32Maximum number of rows to return. The default is all remaining rows.
columnOffsetinteger · int32Index of the first column to return. The default is 0.
columnLimitinteger · int32Maximum number of columns to return. The default is all remaining columns.
Responses
The result.
(EXPERIMENTAL) Get the metadata of a flow result
Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
resultIdstring · requiredResult ID
Responses
OK
columnsobject[] · requiredColumns of the result, in order.
metadataobject · requiredMetadata of the result, as the operations that produced it give them.
totalRowsinteger · int64 · requiredNumber of rows in the result.
(EXPERIMENTAL) Get a page of a flow result
Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
path Parameters
workspaceIdstring · pattern:^(?!\.)[.A-Za-z0-9_-…· requiredWorkspace identifier
resultIdstring · requiredResult ID
query Parameters
rowOffsetinteger · int32Index of the first row to return. The default is 0.
rowLimitinteger · int32Maximum number of rows to return. The default is all remaining rows.
columnOffsetinteger · int32Index of the first column to return. The default is 0.
columnLimitinteger · int32Maximum number of columns to return. The default is all remaining columns.
Responses
OK
columnsobject[] · requiredColumns of the page, in order.
dataarray[] · requiredRows of the page. A row has one value for each column, in the order of the columns.
pagingobject · requiredPosition of a page in a table result.