Workflows

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

Civis API /workflows endpoint.

Methods

delete_projects(id, project_id)	Remove a Workflow from a project
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)	Get a Workflow
get_executions(id, execution_id)	Get a workflow execution
get_executions_tasks(id, execution_id, task_name)	Get a task of a workflow execution
get_git(id)	Get the git metadata attached to an item
get_git_commits(id, commit_hash)	Get file contents at git ref
list(*[, hidden, archived, author, state, ...])	List Workflows
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_executions(id, *[, limit, page_num, ...])	List workflow executions
list_git(id)	Get the git metadata attached to an item
list_git_commits(id)	Get the git commits for an item on the current branch
list_projects(id, *[, hidden])	List the projects a Workflow belongs to
list_shares(id)	List users and groups permissioned on this object
patch(id, *[, name, description, ...])	Update some attributes of this Workflow
patch_git(id, *[, git_ref, git_branch, ...])	Update an attached git file
post(name, *[, description, from_job_chain, ...])	Create a Workflow
post_clone(id, *[, clone_schedule, ...])	Clone this Workflow
post_executions(id, *[, target_task, input, ...])	Execute a workflow
post_executions_cancel(id, execution_id)	Cancel a workflow execution
post_executions_resume(id, execution_id)	Resume a paused workflow execution
post_executions_retry(id, execution_id, *[, ...])	Retry a failed task, or all failed tasks in an execution
post_git_checkout_latest(id)	Checkout latest commit on the current branch of a script or workflow
post_git_commits(id, content, message, file_hash)	Commit and push a new version of the file
put(id, name, *[, description, definition, ...])	Replace all attributes of this Workflow
put_archive(id, status)	Update the archive status of this object
put_git(id, *[, git_ref, git_branch, ...])	Attach an item to a file in a git repo
put_projects(id, project_id)	Add a Workflow 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