listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.
Signature
Method signatures onclient.runs:
Parameters
listAllItems()
string
required
Pipeline run ID with prefix
plr..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
listItemsPage()
string
required
Pipeline run ID with prefix
plr..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
Returns
listAllItems() result
AsyncGenerator<RunItem>
Yields one item at a time. The fields below describe each yielded item.
One item processed by a pipeline run.
RunItemId
required
Run item ID with prefix
plri..RunId
required
Pipeline run ID with prefix
plr..DatasetItemId
required
Dataset item ID with prefix
di..number
required
Index of this item within the run.
string
required
Time the run item was created, as an ISO 8601 timestamp.
string
required
Time the run item was last updated, as an ISO 8601 timestamp.
RunItemState
required
The current state and pipeline-level input, output and partial output revision references for a run item.
listItemsPage() result
Promise<{ items: RunItem[]; pagination: Pagination }>
RunItem[]
required
Run items in this page.
Pagination
required
Pagination information for this page.
Errors
HTTP errors throwPotatoApiError. The endpoint documents these error responses:
HTTP endpoint:
GET /runs/{runId}/items.