client.jobs.get

A method of the Jobs endpoint.

Show basic job info

API URL: GET /jobs/{id}

import civis
client = civis.APIClient()
response = client.jobs.get(...)

Parameters:

idint: The ID for this job.

Returns:

civis.Response

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)
last_run_updated_at : str (date-time)
runsList[civis.Response]
Information about the most recent runs of the job.
- 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.
hiddenbool
The hidden status of the item.
archivedbool
The archival status of the requested item(s).
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
success_email_subject : str
success_email_body : str
running_as_user : str
run_by_user : str
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.