client.jobs.list_children

A method of the Jobs endpoint.

list_children(id: int) ListResponse

Show nested tree of children that this job triggers

API URL: GET /jobs/{id}/children

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

The ID for this job.

Returns:
civis.ListResponse
  • id : int

  • name : str

  • type : str

  • from_template_id : int

  • statestr

    Whether the job is queued, running, succeeded, failed, cancelled, idle or scheduled.

  • created_at : str (date-time)

  • updated_at : str (date-time)

  • runsList[civis.Response]
    • id : int

    • statestr

      The state of the run. One of queued, running, succeeded, failed or cancelled.

    • created_atstr (time)

      The time that the run was queued.

    • started_atstr (time)

      The time that the run started.

    • finished_atstr (time)

      The time that the run completed.

    • errorstr

      The error message for this run, if present.

  • last_runcivis.Response
    • id : int

    • statestr

      The state of the run. One of queued, running, succeeded, failed or cancelled.

    • created_atstr (time)

      The time that the run was queued.

    • started_atstr (time)

      The time that the run started.

    • finished_atstr (time)

      The time that the run completed.

    • errorstr

      The error message for this run, if present.

  • children : List[civis.Response]