PipelineResponse
Data returned for Pipeline. Required fields are id, name, category, type, steps, item.
Server-assigned unique identifier
Resource name
alias object
Display name shown to users.
- string
- null
Resource type tag
Pipeline execution mode: 'batch' or 'event'
Possible values: [batch, event]
collection_id object
Parent collection ID
- string
- null
folder_id object
Identifier of the containing folder.
- string
- null
tags object
Classification labels
- string[]
- null
description object
Resource description
- string
- null
Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.
[]created_at object
Creation timestamp (Unix ms)
- integer
- null
updated_at object
Last update timestamp (Unix ms)
- integer
- null
owners object[]
Users and groups that own the resource.
"user.
Possible values: [user, group, public]
avatar_url object
- string
- null
avatar_config object
- object
- null
email object
- string<email>
- null
my_share_scope object
How the current caller received access to the resource.
- string
- null
Possible values: [owner, grant, admin]
steps object[]필수
Execution steps
Step name
alias object
- string
- null
description object
Step-owned description, independent of the referenced Code's description so steps sharing one Code can be labeled distinctly.
- string
- null
script object
Code resource ID to execute (code step)
- string
- null
transform object
Native transform spec (transform step)
- object
- null
Possible values: [join, stages, union]
- join
- stages
- union
11config object필수
Two-input equi-join configuration. left_input and right_input are pipeline port keys, keys contains at least one equality pair, and columns explicitly selects the output. Other join predicates are not accepted.
Left input port key
Right input port key
inner | left | right | full
Possible values: [inner, left, right, full]
keys object[]필수
Equi-join column pairs (non-empty)
Join column on the left input
Join column on the right input
columns object[]필수
Output projection (non-empty)
Source input port key (left_input or right_input)
Source column name on that input
alias object
Output column name (defaults to name)
- string
- null
11config object필수
Config for the stages op.
Input port key (a PipelineStep.inputs key)
pipeline object[]필수
Ordered stages (non-empty)
Possible values: >= 1
- SelectStage
- WithColumnsStage
- FilterStage
- DropStage
- RenameStage
- CastStage
- SortStage
- UniqueStage
- HeadStage
- TailStage
- SliceStage
- DropNullsStage
- FillNullStage
- WithRowIndexStage
- GroupByStage
- GroupByDynamicStage
- ExplodeStage
- UnnestStage
- UnpivotStage
selectexprs object
- object[]
- null
Output column name
Polars-SQL expression, e.g. 'qty * unit_price'
columns object
- string[]
- null
11config object필수
Union configuration for two or more pipeline input ports. Inputs are aligned by column name, missing values become null, and duplicate rows are retained.
Input port keys to union (>= 2)
agent object
Workflow agent call spec (agent step)
- AgentStepSpec
- null
11Agent resource ID (workflow mode)
timeout_seconds object
Per-call timeout. Capped at the agent control plane's fixed 300s forward timeout, above which the call 504s before this applies.
- integer
- null
Possible values: > 0 and <= 300
inputs object
Input dataset mapping
- object
- null
outputs object
Output dataset mapping
- object
- null
dependencies object
List of dependent step names
- string[]
- null
options object
- object
- null
secrets object
Secret values to inject into contexts['secrets']
- object[]
- null
contexts['secrets'] key the step reads
Secret reference, e.g. secret://secret.
options object
- object
- null
metadata object
- object
- null
run_as object
Execution subject for unattended runs. Readable so a designee can see and withdraw their own designation; settable only to yourself, and only if you already own this pipeline.
- string
- null
{
"id": "string",
"name": "string",
"alias": "string",
"category": "string",
"type": "batch",
"collection_id": "string",
"folder_id": "string",
"tags": [
"string"
],
"description": "string",
"markings": [
"string"
],
"created_at": 0,
"updated_at": 0,
"owners": [
{
"id": "string",
"type": "user",
"display_name": "string",
"avatar_url": "string",
"avatar_config": {},
"email": "user@example.com"
}
],
"my_share_scope": "owner",
"steps": [
{
"name": "string",
"alias": "string",
"description": "string",
"script": "string",
"transform": {
"version": 1,
"op": "stages",
"config": {
"input": "string",
"pipeline": [
{
"op": "select",
"exprs": [
{
"name": "string",
"expr": "string"
}
],
"columns": [
"string"
]
},
{
"op": "with_columns",
"exprs": [
{
"name": "string",
"expr": "string"
}
]
},
{
"op": "filter",
"expr": "string"
},
{
"op": "drop",
"columns": [
"string"
]
},
{
"op": "rename",
"map": {}
},
{
"op": "cast",
"dtypes": {}
},
{
"op": "sort",
"by": [
"string"
],
"descending": false
},
{
"op": "unique",
"subset": [
"string"
],
"keep": "any"
},
{
"op": "head",
"n": 0
},
{
"op": "tail",
"n": 0
},
{
"op": "slice",
"offset": 0,
"len": 0
},
{
"op": "drop_nulls",
"subset": [
"string"
]
},
{
"op": "fill_null",
"expr": "string"
},
{
"op": "with_row_index",
"name": "string",
"offset": 0
},
{
"op": "group_by",
"by": [
"string"
],
"agg": [
{
"name": "string",
"expr": "string"
}
]
},
{
"op": "group_by_dynamic",
"index_column": "string",
"every": "string",
"period": "string",
"offset": "string",
"closed": "left",
"by": [
"string"
],
"agg": [
{
"name": "string",
"expr": "string"
}
]
},
{
"op": "explode",
"columns": [
"string"
]
},
{
"op": "unnest",
"columns": [
"string"
]
},
{
"op": "unpivot",
"on": [
"string"
],
"index": [
"string"
]
}
]
}
},
"agent": {
"version": 1,
"agent_id": "string",
"timeout_seconds": 0
},
"inputs": {},
"outputs": {},
"dependencies": [
"string"
],
"options": {},
"secrets": [
{
"name": "string",
"ref": "string"
}
]
}
],
"options": {},
"metadata": {},
"run_as": "string"
}