Scripts

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

Civis API /scripts endpoint.

Methods

delete_containers_projects(id, project_id)

Remove a Container Script from a project

delete_containers_runs(id, run_id)

Cancel a run

delete_containers_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_containers_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_custom_projects(id, project_id)

Remove a Custom Script from a project

delete_custom_runs(id, run_id)

Cancel a run

delete_custom_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_custom_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_dbt_projects(id, project_id)

Remove a dbt Script from a project

delete_dbt_runs(id, run_id)

Cancel a run

delete_dbt_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_dbt_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_javascript_projects(id, project_id)

Remove a JavaScript Script from a project

delete_javascript_runs(id, run_id)

Cancel a run

delete_javascript_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_javascript_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_python3_projects(id, project_id)

Remove a Python Script from a project

delete_python3_runs(id, run_id)

Cancel a run

delete_python3_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_python3_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_r_projects(id, project_id)

Remove an R Script from a project

delete_r_runs(id, run_id)

Cancel a run

delete_r_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_r_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_sql_projects(id, project_id)

Remove a SQL Script from a project

delete_sql_runs(id, run_id)

Cancel a run

delete_sql_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_sql_shares_users(id, user_id)

Revoke the permissions a user has on this object

get(id)

Get details about a SQL script (legacy)

get_containers(id)

View a container

get_containers_runs(id, run_id)

Check status of a run

get_containers_runs_inputs(id, run_id)

Get the inputs for a run

get_custom(id)

Get a Custom Script

get_custom_runs(id, run_id)

Check status of a run

get_custom_runs_inputs(id, run_id)

Get the inputs for a run

get_dbt(id)

Get a dbt Script

get_dbt_runs(id, run_id)

Check status of a run

get_dbt_runs_inputs(id, run_id)

Get the inputs for a run

get_javascript(id)

Get a JavaScript Script

get_javascript_git(id)

Get the git metadata attached to an item

get_javascript_git_commits(id, commit_hash)

Get file contents at git ref

get_javascript_runs(id, run_id)

Check status of a run

get_javascript_runs_inputs(id, run_id)

Get the inputs for a run

get_python3(id)

Get a Python Script

get_python3_git(id)

Get the git metadata attached to an item

get_python3_git_commits(id, commit_hash)

Get file contents at git ref

get_python3_runs(id, run_id)

Check status of a run

get_python3_runs_inputs(id, run_id)

Get the inputs for a run

get_r(id)

Get an R Script

get_r_git(id)

Get the git metadata attached to an item

get_r_git_commits(id, commit_hash)

Get file contents at git ref

get_r_runs(id, run_id)

Check status of a run

get_r_runs_inputs(id, run_id)

Get the inputs for a run

get_sql(id)

Get a SQL Script

get_sql_git(id)

Get the git metadata attached to an item

get_sql_git_commits(id, commit_hash)

Get file contents at git ref

get_sql_runs(id, run_id)

Check status of a run

get_sql_runs_inputs(id, run_id)

Get the inputs for a run

list(*[, type, category, author, status, ...])

List Scripts

list_containers_dependencies(id, *[, user_id])

List dependent objects for this object

list_containers_projects(id, *[, hidden])

List the projects a Container Script belongs to

list_containers_runs(id, *[, limit, ...])

List runs for the given Container job

list_containers_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_containers_runs_outputs(id, run_id, *)

List the outputs for a run

list_containers_shares(id)

List users and groups permissioned on this object

list_custom(*[, from_template_id, author, ...])

List Custom Scripts

list_custom_dependencies(id, *[, user_id])

List dependent objects for this object

list_custom_projects(id, *[, hidden])

List the projects a Custom Script belongs to

list_custom_runs(id, *[, limit, page_num, ...])

List runs for the given Custom job

list_custom_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_custom_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_custom_shares(id)

List users and groups permissioned on this object

list_dbt_dependencies(id, *[, user_id])

List dependent objects for this object

list_dbt_projects(id, *[, hidden])

List the projects a dbt Script belongs to

list_dbt_runs(id, *[, limit, page_num, ...])

List runs for the given dbt job

list_dbt_runs_logs(id, run_id, *[, last_id, ...])

Get the logs for a run

list_dbt_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_dbt_shares(id)

List users and groups permissioned on this object

list_history(id)

Get the run history and outputs of this script

list_javascript_dependencies(id, *[, user_id])

List dependent objects for this object

list_javascript_git(id)

Get the git metadata attached to an item

list_javascript_git_commits(id)

Get the git commits for an item on the current branch

list_javascript_projects(id, *[, hidden])

List the projects a JavaScript Script belongs to

list_javascript_runs(id, *[, limit, ...])

List runs for the given Javascript job

list_javascript_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_javascript_runs_outputs(id, run_id, *)

List the outputs for a run

list_javascript_shares(id)

List users and groups permissioned on this object

list_python3_dependencies(id, *[, user_id])

List dependent objects for this object

list_python3_git(id)

Get the git metadata attached to an item

list_python3_git_commits(id)

Get the git commits for an item on the current branch

list_python3_projects(id, *[, hidden])

List the projects a Python Script belongs to

list_python3_runs(id, *[, limit, page_num, ...])

List runs for the given Python job

list_python3_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_python3_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_python3_shares(id)

List users and groups permissioned on this object

list_r_dependencies(id, *[, user_id])

List dependent objects for this object

list_r_git(id)

Get the git metadata attached to an item

list_r_git_commits(id)

Get the git commits for an item on the current branch

list_r_projects(id, *[, hidden])

List the projects an R Script belongs to

list_r_runs(id, *[, limit, page_num, order, ...])

List runs for the given R job

list_r_runs_logs(id, run_id, *[, last_id, limit])

Get the logs for a run

list_r_runs_outputs(id, run_id, *[, limit, ...])

List the outputs for a run

list_r_shares(id)

List users and groups permissioned on this object

list_sql_dependencies(id, *[, user_id])

List dependent objects for this object

list_sql_git(id)

Get the git metadata attached to an item

list_sql_git_commits(id)

Get the git commits for an item on the current branch

list_sql_projects(id, *[, hidden])

List the projects a SQL Script belongs to

list_sql_runs(id, *[, limit, page_num, ...])

List runs for the given SQL job

list_sql_runs_logs(id, run_id, *[, last_id, ...])

Get the logs for a run

list_sql_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_sql_shares(id)

List users and groups permissioned on this object

list_types()

List available script types

patch_container_runs(id, run_id, *[, error])

Update the given run

patch_containers(id, *[, name, parent_id, ...])

Update a container

patch_custom(id, *[, name, parent_id, ...])

Update some attributes of this Custom Script

patch_dbt(id, *[, name, parent_id, ...])

Update some attributes of this dbt Script

patch_dbt_runs(id, run_id, *[, error])

Update the given run

patch_javascript(id, *[, name, parent_id, ...])

Update some attributes of this JavaScript Script

patch_javascript_git(id, *[, git_ref, ...])

Update an attached git file

patch_javascript_runs(id, run_id, *[, error])

Update the given run

patch_python3(id, *[, name, parent_id, ...])

Update some attributes of this Python Script

patch_python3_git(id, *[, git_ref, ...])

Update an attached git file

patch_python3_runs(id, run_id, *[, error])

Update the given run

patch_r(id, *[, name, parent_id, ...])

Update some attributes of this R Script

patch_r_git(id, *[, git_ref, git_branch, ...])

Update an attached git file

patch_r_runs(id, run_id, *[, error])

Update the given run

patch_sql(id, *[, name, parent_id, ...])

Update some attributes of this SQL Script

patch_sql_git(id, *[, git_ref, git_branch, ...])

Update an attached git file

patch_sql_runs(id, run_id, *[, error])

Update the given run

post(name, remote_host_id, credential_id, sql, *)

Create a script (legacy)

post_cancel(id)

Cancel a run

post_containers(required_resources, *[, ...])

Create a container

post_containers_clone(id, *[, ...])

Clone this Container Script

post_containers_runs(id)

Start a run

post_containers_runs_logs(id, run_id, *[, ...])

Add log messages

post_containers_runs_outputs(id, run_id, ...)

Add an output for a run

post_custom(from_template_id, *[, name, ...])

Create a Custom Script

post_custom_clone(id, *[, clone_schedule, ...])

Clone this Custom Script

post_custom_runs(id)

Start a run

post_custom_runs_outputs(id, run_id, ...)

Add an output for a run

post_dbt(name, repo_http_uri, *[, ...])

Create a dbt Script

post_dbt_clone(id, *[, clone_schedule, ...])

Clone this dbt Script

post_dbt_runs(id)

Start a run

post_dbt_runs_outputs(id, run_id, ...)

Add an output for a run

post_javascript(name, source, ...[, ...])

Create a JavaScript Script

post_javascript_clone(id, *[, ...])

Clone this JavaScript Script

post_javascript_git_checkout(id)

Checkout content that the existing git_ref points to and save to the object

post_javascript_git_checkout_latest(id)

Checkout latest commit on the current branch of a script or workflow

post_javascript_git_commits(id, content, ...)

Commit and push a new version of the file

post_javascript_runs(id)

Start a run

post_javascript_runs_outputs(id, run_id, ...)

Add an output for a run

post_python3(name, source, *[, parent_id, ...])

Create a Python Script

post_python3_clone(id, *[, clone_schedule, ...])

Clone this Python Script

post_python3_git_checkout(id)

Checkout content that the existing git_ref points to and save to the object

post_python3_git_checkout_latest(id)

Checkout latest commit on the current branch of a script or workflow

post_python3_git_commits(id, content, ...)

Commit and push a new version of the file

post_python3_runs(id)

Start a run

post_python3_runs_outputs(id, run_id, ...)

Add an output for a run

post_r(name, source, *[, parent_id, ...])

Create an R Script

post_r_clone(id, *[, clone_schedule, ...])

Clone this R Script

post_r_git_checkout(id)

Checkout content that the existing git_ref points to and save to the object

post_r_git_checkout_latest(id)

Checkout latest commit on the current branch of a script or workflow

post_r_git_commits(id, content, message, ...)

Commit and push a new version of the file

post_r_runs(id)

Start a run

post_r_runs_outputs(id, run_id, object_type, ...)

Add an output for a run

post_run(id)

Run a SQL script (legacy)

post_sql(name, sql, remote_host_id, ...[, ...])

Create a SQL Script

post_sql_clone(id, *[, clone_schedule, ...])

Clone this SQL Script

post_sql_git_checkout(id)

Checkout content that the existing git_ref points to and save to the object

post_sql_git_checkout_latest(id)

Checkout latest commit on the current branch of a script or workflow

post_sql_git_commits(id, content, message, ...)

Commit and push a new version of the file

post_sql_runs(id)

Start a run

put_containers(id, required_resources, *[, ...])

Edit a container

put_containers_archive(id, status)

Update the archive status of this object

put_containers_projects(id, project_id)

Add a Container Script to a project

put_containers_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_containers_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_containers_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_custom(id, *[, name, parent_id, ...])

Replace all attributes of this Custom Script

put_custom_archive(id, status)

Update the archive status of this object

put_custom_projects(id, project_id)

Add a Custom Script to a project

put_custom_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_custom_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_custom_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_dbt(id, name, repo_http_uri, *[, ...])

Replace all attributes of this dbt Script

put_dbt_archive(id, status)

Update the archive status of this object

put_dbt_projects(id, project_id)

Add a dbt Script to a project

put_dbt_shares_groups(id, group_ids, ...[, ...])

Set the permissions groups has on this object

put_dbt_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_dbt_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_javascript(id, name, source, ...[, ...])

Replace all attributes of this JavaScript Script

put_javascript_archive(id, status)

Update the archive status of this object

put_javascript_git(id, *[, git_ref, ...])

Attach an item to a file in a git repo

put_javascript_projects(id, project_id)

Add a JavaScript Script to a project

put_javascript_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_javascript_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_javascript_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_python3(id, name, source, *[, ...])

Replace all attributes of this Python Script

put_python3_archive(id, status)

Update the archive status of this object

put_python3_git(id, *[, git_ref, ...])

Attach an item to a file in a git repo

put_python3_projects(id, project_id)

Add a Python Script to a project

put_python3_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_python3_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_python3_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_r(id, name, source, *[, parent_id, ...])

Replace all attributes of this R Script

put_r_archive(id, status)

Update the archive status of this object

put_r_git(id, *[, git_ref, git_branch, ...])

Attach an item to a file in a git repo

put_r_projects(id, project_id)

Add an R Script to a project

put_r_shares_groups(id, group_ids, ...[, ...])

Set the permissions groups has on this object

put_r_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_r_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_sql(id, name, sql, remote_host_id, ...)

Replace all attributes of this SQL Script

put_sql_archive(id, status)

Update the archive status of this object

put_sql_git(id, *[, git_ref, git_branch, ...])

Attach an item to a file in a git repo

put_sql_projects(id, project_id)

Add a SQL Script to a project

put_sql_shares_groups(id, group_ids, ...[, ...])

Set the permissions groups has on this object

put_sql_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_sql_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user