client.jobs.list_runs_outputs

A method of the Jobs endpoint.

list_runs_outputs(id: int, run_id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List the outputs for a run

API URL: GET /jobs/{id}/runs/{run_id}/outputs

import civis
client = civis.APIClient()
response = client.jobs.list_runs_outputs(...)
Parameters:
idint

The ID of the job.

run_idint

The ID of the run.

limitint, optional

Number of results to return. Defaults to its maximum of 50.

page_numint, optional

Page number of the results to return. Defaults to the first page, 1.

orderstr, optional

The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.

order_dirstr, optional

Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

iteratorbool, optional

If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:
civis.ListResponse | civis.PaginatedResponse
  • object_typestr

    The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue

  • object_idint

    The ID of the output.

  • namestr

    The name of the output.

  • linkstr

    The hypermedia link to the output.

  • value : object