Imports

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

Civis API /imports endpoint.

Methods

delete_files_csv_runs(id, run_id)	Cancel a run
delete_files_runs(id, run_id)	Cancel a run
delete_projects(id, project_id)	Remove an Import 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 details about an import
get_batches(id)	Get details about a batch import
get_files_csv(id)	Get a CSV Import
get_files_csv_runs(id, run_id)	Check status of a run
get_files_csv_runs_inputs(id, run_id)	Get the inputs for a run
get_files_runs(id, run_id)	Check status of a run
get_files_runs_inputs(id, run_id)	Get the inputs for a run
list(*[, type, destination, source, status, ...])	List Imports
list_batches(*[, hidden, limit, page_num, ...])	List batch imports
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_files_csv_runs(id, *[, limit, ...])	List runs for the given CSV Import job
list_files_csv_runs_logs(id, run_id, *[, ...])	Get the logs for a run
list_files_runs(id, *[, limit, page_num, ...])	List runs for the given Import job
list_files_runs_logs(id, run_id, *[, ...])	Get the logs for a run
list_projects(id, *[, hidden])	List the projects an Import belongs to
list_runs(id)	Get the run history of this import
list_runs_logs(id, run_id, *[, last_id, limit])	Get the logs for a run
list_shares(id)	List users and groups permissioned on this object
patch(id, *[, name, source, destination, ...])	Update some attributes of this import
patch_files_csv(id, *[, name, source, ...])	Update some attributes of this CSV Import
patch_syncs(id, sync_id, *[, source, ...])	Update some attributes of this sync
post(name, sync_type, is_outbound, *[, ...])	Create a new import configuration
post_batches(file_ids, schema, table, ...[, ...])	Upload multiple files to Civis
post_cancel(id)	Cancel a run
post_clone(id, *[, clone_schedule, ...])	Clone this Import
post_files(schema, name, remote_host_id, ...)	Initate an import of a tabular file into the platform
post_files_csv(source, destination, ...[, ...])	Create a CSV Import
post_files_csv_runs(id)	Start a run
post_files_runs(id)	Start a run
post_runs(id)	Run an import
post_syncs(id, source, destination, *[, ...])	Create a sync
put(id, name, sync_type, is_outbound, *[, ...])	Update an import
put_archive(id, status)	Update the archive status of this object
put_files_csv(id, source, destination, ...)	Replace all attributes of this CSV Import
put_files_csv_archive(id, status)	Update the archive status of this object
put_projects(id, project_id)	Add an Import 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_syncs(id, sync_id, source, destination, *)	Replace all attributes of this sync
put_syncs_archive(id, sync_id, *[, status])	Update the archive status of this sync
put_transfer(id, user_id, ...[, email_body, ...])	Transfer ownership of this object to another user