Jobs

class Jobs(session_kwargs, client, return_type='raw')

Civis API /jobs endpoint.

Methods

delete_projects(id, project_id)	Remove a Job from a project
delete_runs(id, run_id)	Cancel a run
delete_shares_groups(id, group_id)	Revoke the permissions a group has on this object
delete_shares_users(id, user_id)	Revoke the permissions a user has on this object
get(id)	Show basic job info
get_runs(id, run_id)	Check status of a job
get_runs_inputs(id, run_id)	Get the inputs for a run
list(*[, state, type, q, permission, ...])	List Jobs
list_children(id)	Show nested tree of children that this job triggers
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_parents(id)	Show chain of parents as a list that this job triggers from
list_projects(id, *[, hidden])	List the projects a Job belongs to
list_runs(id, *[, limit, page_num, order, ...])	List runs for the given job
list_runs_logs(id, run_id, *[, last_id, limit])	Get the logs for a run
list_runs_outputs(id, run_id, *[, limit, ...])	List the outputs for a run
list_shares(id)	List users and groups permissioned on this object
list_workflows(id, *[, archived])	List the workflows a job belongs to
post_runs(id)	Run a job
post_trigger_email(id)	Generate and retrieve trigger email address
put_archive(id, status)	Update the archive status of this object
put_projects(id, project_id)	Add a Job to a project
put_shares_groups(id, group_ids, ...[, ...])	Set the permissions groups has on this object
put_shares_users(id, user_ids, ...[, ...])	Set the permissions users have on this object
put_transfer(id, user_id, ...[, email_body, ...])	Transfer ownership of this object to another user