`flywheel.flywheel`

`Flywheel`

Main client class for the Python SDK.

Normally initialized via a call to flywheel.Client rather than by directly calling this class.

Parameters:

Name	Type	Description	Default
`api_key`	`str`	The API key to authenticate with.	required
`minimum_supported_major_version`	`(int, optional)`	Minimum major version of the SDK the caller accepts.	`0`
`root`	`(bool, optional)`	Sets default parameter for requests to return a complete list regardless of permissions - for site admin users. Deprecated - use `exhaustive` instead.	`False`
`skip_version_check`	`(bool, optional)`	Deprecated--does nothing.	`None`
`subjects_in_resolver`	`(bool, optional)`	Deprecated--does nothing.	`None`
`request_timeout`	`(int, optional)`	The client timeout for making requests, in seconds.	`None`
`connect_timeout`	`(int, optional)`	The client timeout for making connections, in seconds.	`None`
`exhaustive`	`(bool, optional)`	Sets default parameter for requests to return a complete list regardless of permissions - for site admin users.	`False`

`View(**kwargs)`

Short-hand for flywheel.ViewBuilder(**kwargs).build()

Parameters:

Name	Type	Description	Default
`kwargs`		The arguments to pass directly to ViewBuilder	`{}`

Returns:

Type	Description
	The built data view

`acquisition_copy(acquisition_id, body, **kwargs)`

Smart copy an acquisition

See AcquisitionsApi.acquisition_copy() for parameter details.

`add_acquisition(body, **kwargs)`

Create a new acquisition

See AcquisitionsApi.add_acquisition() for parameter details.

`add_acquisition_analysis(cid, body, **kwargs)`

Create an analysis and upload files.

See AcquisitionsApi.add_acquisition_analysis() for parameter details.

`add_acquisition_analysis_note(container_id, analysis_id, body, **kwargs)`

Add a note to a(n) acquisition analysis.

See AcquisitionsApi.add_acquisition_analysis_note() for parameter details.

`add_acquisition_note(container_id, body, **kwargs)`

Add a note to a(n) acquisition.

See AcquisitionsApi.add_acquisition_note() for parameter details.

`add_acquisition_tag(cid, body, **kwargs)`

Add a tag to a(n) acquisition.

See AcquisitionsApi.add_acquisition_tag() for parameter details.

`add_acquisition_tags(cid, body, **kwargs)`

Add multiple tags to a(n) acquisition

See AcquisitionsApi.add_acquisition_tags() for parameter details.

`add_acquisitions_to_collection(collection_id, acquisition_ids, **kwargs)`

Add a list of acquisitions to a collection.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	The id of the collection to update	required
`acquisition_ids`	`list[str]`	The list of acquisition ids to add	required

`add_analysis_note(container_id, body, **kwargs)`

Add a note to a(n) analysis.

See AnalysesApi.add_analysis_note() for parameter details.

`add_analysis_tag(container_id, body, **kwargs)`

Add a tag to a(n) analysis.

See AnalysesApi.add_analysis_tag() for parameter details.

`add_audit_trail_report(body, **kwargs)`

Starts generation of an Audit Trail Report

See AuditTrailApi.add_audit_trail_report() for parameter details.

`add_collection(body, **kwargs)`

Create a collection

See CollectionsApi.add_collection() for parameter details.

`add_collection_note(container_id, body, **kwargs)`

Add a note to a(n) collection.

See CollectionsApi.add_collection_note() for parameter details.

`add_collection_permission(collection_id, body, **kwargs)`

Add a permission

See CollectionsApi.add_collection_permission() for parameter details.

`add_collection_tag(cid, body, **kwargs)`

Add a tag to a(n) collection.

See CollectionsApi.add_collection_tag() for parameter details.

`add_collection_tags(cid, body, **kwargs)`

Add multiple tags to a(n) collection

See CollectionsApi.add_collection_tags() for parameter details.

`add_container_analysis(cid, body, **kwargs)`

Create an analysis and upload files.

See ContainersApi.add_container_analysis() for parameter details.

`add_container_analysis_note(container_id, analysis_id, body, **kwargs)`

Add a note to a(n) container analysis.

See ContainersApi.add_container_analysis_note() for parameter details.

`add_container_note(container_id, body, **kwargs)`

Add a note to a(n) container.

See ContainersApi.add_container_note() for parameter details.

`add_container_tag(cid, body, **kwargs)`

Add a tag to a(n) container.

See ContainersApi.add_container_tag() for parameter details.

`add_container_tags(cid, body, **kwargs)`

Add multiple tags to a(n) container

See ContainersApi.add_container_tags() for parameter details.

`add_file_tags(file_id, body, **kwargs)`

Add list of tags on a file.

See FilesApi.add_file_tags() for parameter details.

`add_gear(gear_name, body, **kwargs)`

Create or update a gear.

See GearsApi.add_gear() for parameter details.

`add_gear_permission(gear_name, permission_type, body, **kwargs)`

Add an individual permission to the given gear

See GearsApi.add_gear_permission() for parameter details.

`add_group(body, **kwargs)`

Add a group

See GroupsApi.add_group() for parameter details.

`add_group_permission(group_id, body, **kwargs)`

Add a permission

See GroupsApi.add_group_permission() for parameter details.

`add_group_permission_template(group_id, body, **kwargs)`

Add a permission template

See GroupsApi.add_group_permission_template() for parameter details.

`add_group_tag(cid, body, **kwargs)`

Add a tag to a(n) group.

See GroupsApi.add_group_tag() for parameter details.

`add_group_tags(cid, body, **kwargs)`

Add multiple tags to a(n) group

See GroupsApi.add_group_tags() for parameter details.

`add_job(body, **kwargs)`

Add a job

See JobsApi.add_job() for parameter details.

`add_job_logs(job_id, body, **kwargs)`

Add logs to a job.

See JobsApi.add_job_logs() for parameter details.

`add_modality(body, **kwargs)`

Create a new modality.

See ModalitiesApi.add_modality() for parameter details.

`add_nodes_to_collection(collection_id, level, node_ids, **kwargs)`

Generic method to add a list of nodes to a collection.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	The id of the collection to update	required
`level`	`str`	The level of nodes to add (e.g. session or acquisition)	required
`node_ids`	`list[str]`	The list of node ids of type level to add	required

`add_project(body, **kwargs)`

Create a new project

See ProjectsApi.add_project() for parameter details.

`add_project_analysis(cid, body, **kwargs)`

Create an analysis and upload files.

See ProjectsApi.add_project_analysis() for parameter details.

`add_project_analysis_note(container_id, analysis_id, body, **kwargs)`

Add a note to a(n) project analysis.

See ProjectsApi.add_project_analysis_note() for parameter details.

`add_project_note(container_id, body, **kwargs)`

Add a note to a(n) project.

See ProjectsApi.add_project_note() for parameter details.

`add_project_permission(project_id, body, **kwargs)`

Add a permission

See ProjectsApi.add_project_permission() for parameter details.

`add_project_rule(project_id, body, **kwargs)`

Create a new rule for a project.

See ProjectsApi.add_project_rule() for parameter details.

`add_project_tag(cid, body, **kwargs)`

Add a tag to a(n) project.

See ProjectsApi.add_project_tag() for parameter details.

`add_project_tags(cid, body, **kwargs)`

Add multiple tags to a(n) project

See ProjectsApi.add_project_tags() for parameter details.

`add_provider(body, **kwargs)`

Add a new provider

See SiteApi.add_provider() for parameter details.

`add_role(body, **kwargs)`

Add a new role

See RolesApi.add_role() for parameter details.

`add_role_to_group(group_id, body, **kwargs)`

Add a role to the pool of roles in a group

See GroupsApi.add_role_to_group() for parameter details.

`add_session(body, **kwargs)`

Create a new session

See SessionsApi.add_session() for parameter details.

`add_session_analysis(cid, body, **kwargs)`

Create an analysis and upload files.

See SessionsApi.add_session_analysis() for parameter details.

`add_session_analysis_note(container_id, analysis_id, body, **kwargs)`

Add a note to a(n) session analysis.

See SessionsApi.add_session_analysis_note() for parameter details.

`add_session_note(container_id, body, **kwargs)`

Add a note to a(n) session.

See SessionsApi.add_session_note() for parameter details.

`add_session_tag(cid, body, **kwargs)`

Add a tag to a(n) session.

See SessionsApi.add_session_tag() for parameter details.

`add_session_tags(cid, body, **kwargs)`

Add multiple tags to a(n) session

See SessionsApi.add_session_tags() for parameter details.

`add_sessions_to_collection(collection_id, session_ids, **kwargs)`

Add a list of sessions to a collection.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	The id of the collection to update	required
`session_ids`	`list[str]`	The list of session ids to add	required

`add_site_rule(body, **kwargs)`

Create a new site rule.

See SiteApi.add_site_rule() for parameter details.

`add_subject(body, **kwargs)`

Create a new subject

See SubjectsApi.add_subject() for parameter details.

`add_subject_analysis(cid, body, **kwargs)`

Create an analysis and upload files.

See SubjectsApi.add_subject_analysis() for parameter details.

`add_subject_analysis_note(container_id, analysis_id, body, **kwargs)`

Add a note to a(n) subject analysis.

See SubjectsApi.add_subject_analysis_note() for parameter details.

`add_subject_note(container_id, body, **kwargs)`

Add a note to a(n) subject.

See SubjectsApi.add_subject_note() for parameter details.

`add_subject_tag(cid, body, **kwargs)`

Add a tag to a(n) subject.

See SubjectsApi.add_subject_tag() for parameter details.

`add_subject_tags(cid, body, **kwargs)`

Add multiple tags to a(n) subject

See SubjectsApi.add_subject_tags() for parameter details.

`add_user(body, **kwargs)`

Add a new user

See UsersApi.add_user() for parameter details.

`add_view(container_id, body, **kwargs)`

Add a new data view

See ContainersApi.add_view() for parameter details.

`archive_task_protocol(protocol_id, **kwargs)`

`ask_jobs(body, **kwargs)`

Ask the queue a question

See JobsApi.ask_jobs() for parameter details.

`ask_jobs_state(job_state, body, **kwargs)`

Ask job count by state

See JobsApi.ask_jobs_state() for parameter details.

`assign_reader_task(task_id, body, **kwargs)`

Assign

See TasksApi.assign_reader_task() for parameter details.

`batch_create_adjudication_task_set(body, **kwargs)`

Create Adjudication Batch

See TasksApi.batch_create_adjudication_task_set() for parameter details.

`batch_create_reader_task(body, **kwargs)`

Create Batch

See TasksApi.batch_create_reader_task() for parameter details.

`bulk_move_sessions(body, **kwargs)`

Perform a bulk move of sessions to either a subject or project

See BulkApi.bulk_move_sessions() for parameter details.

`cancel_batch(batch_id, **kwargs)`

Cancel a Job

See BatchApi.cancel_batch() for parameter details.

`catalog_list(**kwargs)`

Catalog List

See ProjectsApi.catalog_list() for parameter details.

`change_job_state(job_id, state)`

Change a job state.

Parameters:

Name	Type	Description	Default
`job_id`	`str`	The id of the job to modify	required
`state`	`str`	The new job state	required

`check_uids_exist(body, **kwargs)`

Check for existence of UIDs system-wide

See UidsApi.check_uids_exist() for parameter details.

`clean_packfiles(**kwargs)`

Clean up expired upload tokens and invalid token directories.

See PackfileApi.clean_packfiles() for parameter details.

`cleanup_info(container_type, path, **kwargs)`

Remove a custom field from all applicable containers

See ContainerTypeApi.cleanup_info() for parameter details.

`cleanup_signed_upload_url(body, **kwargs)`

Cleanup unused file blob previously uploaded using signed URL

See UploadApi.cleanup_signed_upload_url() for parameter details.

`collect_usage(**kwargs)`

Collect daily usage statistics.

See ReportsApi.collect_usage() for parameter details.

`complete_job(job_id, body, **kwargs)`

Complete a job, with information

See JobsApi.complete_job() for parameter details.

`complete_reader_task(task_id, **kwargs)`

Complete

See TasksApi.complete_reader_task() for parameter details.

`complete_s3_multipart_upload(body, **kwargs)`

Complete S3 multipart signed url upload

See UploadApi.complete_s3_multipart_upload() for parameter details.

`create_adjudication_task_set(body, **kwargs)`

Create Adjudication

See TasksApi.create_adjudication_task_set() for parameter details.

`create_batch_job_from_jobs(body, **kwargs)`

Create a batch job proposal from preconstructed jobs and insert it as 'pending'.

See BatchApi.create_batch_job_from_jobs() for parameter details.

`create_custom_filter(body, **kwargs)`

Create a custom filter for user

See CustomFiltersApi.create_custom_filter() for parameter details.

`create_device(body, **kwargs)`

Create a new device.

See DevicesApi.create_device() for parameter details.

`create_download_ticket(body, **kwargs)`

Create a download ticket

See DownloadApi.create_download_ticket() for parameter details.

`create_master_subject_code(body, **kwargs)`

Request a master subject code for the given patient

See SubjectsApi.create_master_subject_code() for parameter details.

`create_or_replace_task_response(task_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

See FormResponsesApi.create_or_replace_task_response() for parameter details.

`create_project_aet(body, **kwargs)`

Create a new DIMSE project AET

See DimseApi.create_project_aet() for parameter details.

`create_reader_task(body, **kwargs)`

Create

See TasksApi.create_reader_task() for parameter details.

`create_service_aet(body, **kwargs)`

Create a new DIMSE service AET

See DimseApi.create_service_aet() for parameter details.

`create_signed_upload_url(body, **kwargs)`

Create new signed upload URL

See UploadApi.create_signed_upload_url() for parameter details.

`create_staffing_pool(body, **kwargs)`

Create

See StaffingPoolsApi.create_staffing_pool() for parameter details.

`create_task_protocol(body, **kwargs)`

Create

See ProtocolsApi.create_task_protocol() for parameter details.

`data_view_columns(**kwargs)`

Return a list of all known column aliases for use in data views

See ViewsApi.data_view_columns() for parameter details.

`delete_acquisition(acquisition_id, **kwargs)`

Delete a acquisition

See AcquisitionsApi.delete_acquisition() for parameter details.

`delete_acquisition_analysis(cid, analysis_id, **kwargs)`

Delete an analysis

See AcquisitionsApi.delete_acquisition_analysis() for parameter details.

`delete_acquisition_analysis_note(cid, analysis_id, note_id, **kwargs)`

Remove a note from a(n) acquisition analysis.

See AcquisitionsApi.delete_acquisition_analysis_note() for parameter details.

`delete_acquisition_file(cid, filename, **kwargs)`

Delete a file

See AcquisitionsApi.delete_acquisition_file() for parameter details.

`delete_acquisition_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See AcquisitionsApi.modify_acquisition_file_classification() for parameter details.

`delete_acquisition_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See AcquisitionsApi.modify_acquisition_file_info() for parameter details.

`delete_acquisition_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See AcquisitionsApi.modify_acquisition_info() for parameter details.

`delete_acquisition_note(cid, note_id, **kwargs)`

Remove a note from a(n) acquisition

See AcquisitionsApi.delete_acquisition_note() for parameter details.

`delete_acquisition_tag(cid, value, **kwargs)`

Delete a tag

See AcquisitionsApi.delete_acquisition_tag() for parameter details.

`delete_acquisition_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) acquisition

See AcquisitionsApi.delete_acquisition_tags() for parameter details.

`delete_acquisitions_by_ids(body, **kwargs)`

Delete multiple acquisitions by ID list

See ContainersApi.delete_acquisitions_by_ids() for parameter details.

`delete_analyses_by_ids(body, **kwargs)`

Delete multiple analyses by ID list

See ContainersApi.delete_analyses_by_ids() for parameter details.

`delete_analysis(analysis_id, **kwargs)`

Delete an analysis

See AnalysesApi.delete_analysis() for parameter details.

`delete_analysis_file(cid, filename, **kwargs)`

Delete a file

See AnalysesApi.delete_analysis_file() for parameter details.

`delete_analysis_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See AnalysesApi.modify_analysis_file_classification() for parameter details.

`delete_analysis_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See AnalysesApi.modify_analysis_file_info() for parameter details.

`delete_analysis_info_fields(container_id, body, **kwargs)`

Delete the specified fields from + name + .

See AnalysesApi.modify_analysis_info() for parameter details.

`delete_analysis_note(container_id, note_id, **kwargs)`

Remove a note from a(n) analysis

See AnalysesApi.delete_analysis_note() for parameter details.

`delete_analysis_tag(container_id, value, **kwargs)`

Delete a tag

See AnalysesApi.delete_analysis_tag() for parameter details.

`delete_audit_trail_report(report_id, **kwargs)`

Deletes an Audit Trail Report

See AuditTrailApi.delete_audit_trail_report() for parameter details.

`delete_by_search(body, **kwargs)`

Delete containers by a search query

See DataexplorerApi.delete_by_search() for parameter details.

`delete_collection(collection_id, **kwargs)`

Delete a collection

See CollectionsApi.delete_collection() for parameter details.

`delete_collection_file(cid, filename, **kwargs)`

Delete a file

See CollectionsApi.delete_collection_file() for parameter details.

`delete_collection_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See CollectionsApi.modify_collection_file_classification() for parameter details.

`delete_collection_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See CollectionsApi.modify_collection_file_info() for parameter details.

`delete_collection_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See CollectionsApi.modify_collection_info() for parameter details.

`delete_collection_note(cid, note_id, **kwargs)`

Remove a note from a(n) collection

See CollectionsApi.delete_collection_note() for parameter details.

`delete_collection_tag(cid, value, **kwargs)`

Delete a tag

See CollectionsApi.delete_collection_tag() for parameter details.

`delete_collection_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) collection

See CollectionsApi.delete_collection_tags() for parameter details.

`delete_collection_user_permission(collection_id, user_id, **kwargs)`

Delete a permission

See CollectionsApi.delete_collection_user_permission() for parameter details.

`delete_collections_by_ids(body, **kwargs)`

Delete multiple collections by ID list

See ContainersApi.delete_collections_by_ids() for parameter details.

`delete_container(container_id, **kwargs)`

Delete a container

See ContainersApi.delete_container() for parameter details.

`delete_container_analysis(cid, analysis_id, **kwargs)`

Delete an analysis

See ContainersApi.delete_container_analysis() for parameter details.

`delete_container_analysis_note(cid, analysis_id, note_id, **kwargs)`

Remove a note from a(n) container analysis.

See ContainersApi.delete_container_analysis_note() for parameter details.

`delete_container_file(cid, filename, **kwargs)`

Delete a file

See ContainersApi.delete_container_file() for parameter details.

`delete_container_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See ContainersApi.modify_container_file_classification() for parameter details.

`delete_container_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See ContainersApi.modify_container_file_info() for parameter details.

`delete_container_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See ContainersApi.modify_container_info() for parameter details.

`delete_container_note(cid, note_id, **kwargs)`

Remove a note from a(n) container

See ContainersApi.delete_container_note() for parameter details.

`delete_container_tag(cid, value, **kwargs)`

Delete a tag

See ContainersApi.delete_container_tag() for parameter details.

`delete_container_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) container

See ContainersApi.delete_container_tags() for parameter details.

`delete_custom_filter(custom_filter_id, **kwargs)`

Delete a custom filter for user

See CustomFiltersApi.delete_custom_filter() for parameter details.

`delete_device(device_id, **kwargs)`

Delete a device

See DevicesApi.delete_device() for parameter details.

`delete_device_key(device_id, key_id, **kwargs)`

Delete Device Key

See DevicesApi.delete_device_key() for parameter details.

`delete_file(file_id, **kwargs)`

Delete a File

See FilesApi.delete_file() for parameter details.

`delete_file_tags(file_id, **kwargs)`

Remove the specified tags from most recent file version

See FilesApi.delete_file_tags() for parameter details.

`delete_files_by_ids(body, **kwargs)`

Delete multiple files by ID list

See ContainersApi.delete_files_by_ids() for parameter details.

`delete_gear(gear_id, **kwargs)`

Delete a gear (not recommended)

See GearsApi.delete_gear() for parameter details.

`delete_gear_permission(gear_name, permission_type, permission_id, **kwargs)`

Delete an individual permission of the given gear

See GearsApi.delete_gear_permission() for parameter details.

`delete_gear_permissions(gear_name, **kwargs)`

Delete permissions of the given gear

See GearsApi.delete_gear_permissions() for parameter details.

`delete_group(group_id, **kwargs)`

Delete group

See GroupsApi.delete_group() for parameter details.

`delete_group_tag(cid, value, **kwargs)`

Delete a tag

See GroupsApi.delete_group_tag() for parameter details.

`delete_group_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) group

See GroupsApi.delete_group_tags() for parameter details.

`delete_group_user_permission(group_id, user_id, **kwargs)`

Delete a permission

See GroupsApi.delete_group_user_permission() for parameter details.

`delete_group_user_permission_template(group_id, user_id, **kwargs)`

Delete a permission

See GroupsApi.delete_group_user_permission_template() for parameter details.

`delete_groups_by_ids(body, **kwargs)`

Delete multiple groups by ID list

See ContainersApi.delete_groups_by_ids() for parameter details.

`delete_modality(modality_id, **kwargs)`

Delete a modality

See ModalitiesApi.delete_modality() for parameter details.

`delete_project(project_id, **kwargs)`

Delete a project

See ProjectsApi.delete_project() for parameter details.

`delete_project_aet(project_aet, **kwargs)`

Delete a DIMSE project AET

See DimseApi.delete_project_aet() for parameter details.

`delete_project_analysis(cid, analysis_id, **kwargs)`

Delete an analysis

See ProjectsApi.delete_project_analysis() for parameter details.

`delete_project_analysis_note(cid, analysis_id, note_id, **kwargs)`

Remove a note from a(n) project analysis.

See ProjectsApi.delete_project_analysis_note() for parameter details.

`delete_project_file(cid, filename, **kwargs)`

Delete a file

See ProjectsApi.delete_project_file() for parameter details.

`delete_project_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See ProjectsApi.modify_project_file_classification() for parameter details.

`delete_project_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See ProjectsApi.modify_project_file_info() for parameter details.

`delete_project_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See ProjectsApi.modify_project_info() for parameter details.

`delete_project_note(cid, note_id, **kwargs)`

Remove a note from a(n) project

See ProjectsApi.delete_project_note() for parameter details.

`delete_project_tag(cid, value, **kwargs)`

Delete a tag

See ProjectsApi.delete_project_tag() for parameter details.

`delete_project_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) project

See ProjectsApi.delete_project_tags() for parameter details.

`delete_project_user_permission(project_id, uid, **kwargs)`

Delete a permission

See ProjectsApi.delete_project_user_permission() for parameter details.

`delete_projects_by_ids(body, **kwargs)`

Delete multiple projects by ID list

See ContainersApi.delete_projects_by_ids() for parameter details.

`delete_provider(provider_id, **kwargs)`

Delete the provider identified by ProviderId

See SiteApi.delete_provider() for parameter details.

`delete_role(role_id, **kwargs)`

Delete the role

See RolesApi.delete_role() for parameter details.

`delete_save_search(search_id, **kwargs)`

Delete a saved search

See DataexplorerApi.delete_save_search() for parameter details.

`delete_service_aet(service_aet, **kwargs)`

Delete a DIMSE service AET

See DimseApi.delete_service_aet() for parameter details.

`delete_session(session_id, **kwargs)`

Delete a session

See SessionsApi.delete_session() for parameter details.

`delete_session_analysis(cid, analysis_id, **kwargs)`

Delete an analysis

See SessionsApi.delete_session_analysis() for parameter details.

`delete_session_analysis_note(cid, analysis_id, note_id, **kwargs)`

Remove a note from a(n) session analysis.

See SessionsApi.delete_session_analysis_note() for parameter details.

`delete_session_file(cid, filename, **kwargs)`

Delete a file

See SessionsApi.delete_session_file() for parameter details.

`delete_session_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See SessionsApi.modify_session_file_classification() for parameter details.

`delete_session_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See SessionsApi.modify_session_file_info() for parameter details.

`delete_session_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See SessionsApi.modify_session_info() for parameter details.

`delete_session_note(cid, note_id, **kwargs)`

Remove a note from a(n) session

See SessionsApi.delete_session_note() for parameter details.

`delete_session_tag(cid, value, **kwargs)`

Delete a tag

See SessionsApi.delete_session_tag() for parameter details.

`delete_session_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) session

See SessionsApi.delete_session_tags() for parameter details.

`delete_sessions_by_ids(body, **kwargs)`

Delete multiple sessions by ID list

See ContainersApi.delete_sessions_by_ids() for parameter details.

`delete_staffing_pool(pool_id, **kwargs)`

Delete

See StaffingPoolsApi.delete_staffing_pool() for parameter details.

`delete_subject(subject_id, **kwargs)`

Delete a subject

See SubjectsApi.delete_subject() for parameter details.

`delete_subject_analysis(cid, analysis_id, **kwargs)`

Delete an analysis

See SubjectsApi.delete_subject_analysis() for parameter details.

`delete_subject_analysis_note(cid, analysis_id, note_id, **kwargs)`

Remove a note from a(n) subject analysis.

See SubjectsApi.delete_subject_analysis_note() for parameter details.

`delete_subject_file(cid, filename, **kwargs)`

Delete a file

See SubjectsApi.delete_subject_file() for parameter details.

`delete_subject_file_classification_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See SubjectsApi.modify_subject_file_classification() for parameter details.

`delete_subject_file_info_fields(cid, filename, body, **kwargs)`

Delete the specified fields from + name + .

See SubjectsApi.modify_subject_file_info() for parameter details.

`delete_subject_info_fields(cid, body, **kwargs)`

Delete the specified fields from + name + .

See SubjectsApi.modify_subject_info() for parameter details.

`delete_subject_note(cid, note_id, **kwargs)`

Remove a note from a(n) subject

See SubjectsApi.delete_subject_note() for parameter details.

`delete_subject_tag(cid, value, **kwargs)`

Delete a tag

See SubjectsApi.delete_subject_tag() for parameter details.

`delete_subject_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) subject

See SubjectsApi.delete_subject_tags() for parameter details.

`delete_subjects_by_ids(body, **kwargs)`

Delete multiple subjects by ID list

See ContainersApi.delete_subjects_by_ids() for parameter details.

`delete_task_protocol(protocol_id, **kwargs)`

Delete

See ProtocolsApi.delete_task_protocol() for parameter details.

`delete_user(user_id, **kwargs)`

Delete a user

See UsersApi.delete_user() for parameter details.

`delete_user_key(id_, **kwargs)`

Delete User Api Key

See UsersApi.delete_user_key() for parameter details.

`delete_view(view_id, **kwargs)`

Delete a data view

See ViewsApi.delete_view() for parameter details.

`delete_view_execution(data_view_execution_id, **kwargs)`

Delete a data_view_execution

See DataViewExecutionsApi.delete_view_execution() for parameter details.

`determine_provider_for_job(body, **kwargs)`

Determine the effective compute provider for a proposed job.

See JobsApi.determine_provider_for_job() for parameter details.

`download_audit_trail_report(report_id, **kwargs)`

Download Audit Trail Report

See AuditTrailApi.download_audit_trail_report() for parameter details.

`download_file_from_acquisition(acquisition_id, file_name, dest_file, **kwargs)`

Download a file.

See AcquisitionsApi.download_file_from_acquisition() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_acquisition_as_data(acquisition_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See AcquisitionsApi.download_file_from_acquisition() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_analysis(analysis_id, file_name, dest_file, **kwargs)`

Download a file.

See AnalysesApi.download_file_from_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_analysis_as_data(analysis_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See AnalysesApi.download_file_from_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_collection(collection_id, file_name, dest_file, **kwargs)`

Download a file.

See CollectionsApi.download_file_from_collection() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_collection_as_data(collection_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See CollectionsApi.download_file_from_collection() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_container(container_id, file_name, dest_file, **kwargs)`

Download a file.

See ContainersApi.download_file_from_container() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_container_as_data(container_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See ContainersApi.download_file_from_container() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_project(project_id, file_name, dest_file, **kwargs)`

Download a file.

See ProjectsApi.download_file_from_project() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_project_as_data(project_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See ProjectsApi.download_file_from_project() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_session(session_id, file_name, dest_file, **kwargs)`

Download a file.

See SessionsApi.download_file_from_session() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_session_as_data(session_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See SessionsApi.download_file_from_session() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_file_from_subject(subject_id, file_name, dest_file, **kwargs)`

Download a file.

See SubjectsApi.download_file_from_subject() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_file_from_subject_as_data(subject_id, file_name, **kwargs)`

Download a file.

Returns binary file data instead of downloading to a file. See SubjectsApi.download_file_from_subject() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_acquisition_analysis(acquisition_id, analysis_id, filename, dest_file, **kwargs)`

Download analysis outputs with filter.

See AcquisitionsApi.download_output_from_acquisition_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_acquisition_analysis_as_data(acquisition_id, analysis_id, filename, **kwargs)`

Download analysis outputs with filter.

Returns binary file data instead of downloading to a file. See AcquisitionsApi.download_output_from_acquisition_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_analysis(analysis_id, filename, dest_file, **kwargs)`

Download output file from analysis

See AnalysesApi.download_output_from_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_analysis_as_data(analysis_id, filename, **kwargs)`

Download output file from analysis

Returns binary file data instead of downloading to a file. See AnalysesApi.download_output_from_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_container_analysis(container_id, analysis_id, filename, dest_file, **kwargs)`

Download analysis outputs with filter.

See ContainersApi.download_output_from_container_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_container_analysis_as_data(container_id, analysis_id, filename, **kwargs)`

Download analysis outputs with filter.

Returns binary file data instead of downloading to a file. See ContainersApi.download_output_from_container_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_project_analysis(project_id, analysis_id, filename, dest_file, **kwargs)`

Download analysis outputs with filter.

See ProjectsApi.download_output_from_project_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_project_analysis_as_data(project_id, analysis_id, filename, **kwargs)`

Download analysis outputs with filter.

Returns binary file data instead of downloading to a file. See ProjectsApi.download_output_from_project_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_session_analysis(session_id, analysis_id, filename, dest_file, **kwargs)`

Download analysis outputs with filter.

See SessionsApi.download_output_from_session_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_session_analysis_as_data(session_id, analysis_id, filename, **kwargs)`

Download analysis outputs with filter.

Returns binary file data instead of downloading to a file. See SessionsApi.download_output_from_session_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_output_from_subject_analysis(subject_id, analysis_id, filename, dest_file, **kwargs)`

Download analysis outputs with filter.

See SubjectsApi.download_output_from_subject_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_output_from_subject_analysis_as_data(subject_id, analysis_id, filename, **kwargs)`

Download analysis outputs with filter.

Returns binary file data instead of downloading to a file. See SubjectsApi.download_output_from_subject_analysis() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_tar(containers, dest_file, include_types=None, exclude_types=None)`

Download the given set of containers as a tarball to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters:

Name	Type	Description	Default
`containers`		The container, or list of containers to download.	required
`dest_file`	`str`	The destination file on disk	required
`include_types`	`(list[str], optional)`	The optional list of types to include in the download (e.g. ['nifti'])	`None`
`exclude_types`	`(list[str], optional)`	The optional list of types to exclude from the download (e.g. ['dicom'])	`None`

Returns:

Type	Description
`DownloadTicketStub`	A summary of the download

`download_ticket(ticket, dest_file, **kwargs)`

Download files listed in the given ticket.

See DownloadApi.download_ticket() for parameter details.

Parameters:

Name	Type	Description	Default
`dest_file`	`str`	Destination file path	required

`download_ticket_as_data(ticket, **kwargs)`

Download files listed in the given ticket.

Returns binary file data instead of downloading to a file. See DownloadApi.download_ticket() for parameter details.

Returns:

Type	Description
`bytes`	The binary file data

`download_zip(containers, dest_file, include_types=None, exclude_types=None)`

Download the given set of containers as a zip archive to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters:

Name	Type	Description	Default
`containers`		The container, or list of containers to download.	required
`dest_file`	`str`	The destination file on disk	required
`include_types`	`(list[str], optional)`	The optional list of types to include in the download (e.g. ['nifti'])	`None`
`exclude_types`	`(list[str], optional)`	The optional list of types to exclude from the download (e.g. ['dicom'])	`None`

Returns:

Type	Description
`DownloadTicketStub`	A summary of the download

`enable_feature(value)`

Enable feature named value, via the x-accept-feature header

`end_project_packfile_upload(token, metadata, file_count, project_id, **kwargs)`

End a packfile upload

See ProjectsApi.end_project_packfile_upload() for parameter details.

`engine_complete_job(job_id, body, **kwargs)`

Complete a job, with information.

See JobsApi.engine_complete_job() for parameter details.

`engine_prepare_complete_job(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

See JobsApi.engine_prepare_complete_job() for parameter details.

`evaluate_view(view_id, container_id, **kwargs)`

Execute a view, returning data in the preferred format.

See ViewsApi.evaluate_view() for parameter details.

`evaluate_view_adhoc(container_id, body, **kwargs)`

Execute an ad-hoc view, returning data in the preferred format.

See ViewsApi.evaluate_view_adhoc() for parameter details.

`fetch_tree(body, **kwargs)`

Query a portion of the flywheel hierarchy, returning only the requested fields.

See TreeApi.fetch_tree() for parameter details.

`file_url(path)`

Perform a path based lookup of a file in the Flywheel hierarchy, and return a single-use download URL.

Parameters:

Name	Type	Description	Default
`path`	`str`	The path to resolve	required

Returns:

Type	Description
`str`	The file URL if found, otherwise raises an error

`find_all_api_staffing_pools_get(**kwargs)`

Find All

See StaffingPoolsApi.find_all_api_staffing_pools_get() for parameter details.

`find_all_api_tasks_reader_get(**kwargs)`

Find All

See TasksApi.find_all_api_tasks_reader_get() for parameter details.

`find_task_protocols(**kwargs)`

Find All

See ProtocolsApi.find_task_protocols() for parameter details.

`generate_key(device_id, **kwargs)`

Generate device API key

See DevicesApi.generate_key() for parameter details.

`generate_user_key(body, **kwargs)`

Generates user api key

See UsersApi.generate_user_key() for parameter details.

`get(id, **kwargs)`

Retrieve the specified object by id.

Objects that can be retrieved in this way are: group, project, session, subject, acquisition, analysis and collection

Parameters:

Name	Type	Description	Default
`id`	`str`	The id of the object to retrieve	required

`get_access_log_report(**kwargs)`

Get a report of access log entries for the given parameters

See ReportsApi.get_access_log_report() for parameter details.

`get_access_log_types(**kwargs)`

Get the list of types of access log entries

See ReportsApi.get_access_log_types() for parameter details.

`get_acquisition(acquisition_id, **kwargs)`

Get a single acquisition

See AcquisitionsApi.get_acquisition() for parameter details.

`get_acquisition_analyses(cid, **kwargs)`

Get analyses for a(n) acquisition.

See AcquisitionsApi.get_acquisition_analyses() for parameter details.

`get_acquisition_analysis(cid, analysis_id, **kwargs)`

Get an analysis.

See AcquisitionsApi.get_acquisition_analysis() for parameter details.

`get_acquisition_analysis_output_download_url(acquisition_id, analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See AcquisitionsApi.get_acquisition_analysis_output_download_ticket() for parameter details.

`get_acquisition_analysis_output_zip_info(acquisition_id, analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See AcquisitionsApi.get_acquisition_analysis_output_zip_info() for parameter details.

`get_acquisition_download_url(acquisition_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See AcquisitionsApi.get_acquisition_download_ticket() for parameter details.

`get_acquisition_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See AcquisitionsApi.get_acquisition_file_info() for parameter details.

`get_acquisition_file_zip_info(acquisition_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See AcquisitionsApi.get_acquisition_file_zip_info() for parameter details.

`get_acquisition_note(cid, note_id, **kwargs)`

Get a note of a(n) acquisition.

See AcquisitionsApi.get_acquisition_note() for parameter details.

`get_acquisition_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See AcquisitionsApi.get_acquisition_tag() for parameter details.

`get_all_acquisitions(**kwargs)`

Get a list of acquisitions

See AcquisitionsApi.get_all_acquisitions() for parameter details.

`get_all_analyses(**kwargs)`

Find all analyses

See AnalysesApi.get_all_analyses() for parameter details.

`get_all_batches(**kwargs)`

Get a list of batch jobs the user has created.

See BatchApi.get_all_batches() for parameter details.

`get_all_collections(**kwargs)`

List all collections.

See CollectionsApi.get_all_collections() for parameter details.

`get_all_collections_curators(**kwargs)`

List all curators of collections

See CollectionsApi.get_all_collections_curators() for parameter details.

`get_all_custom_filters(**kwargs)`

Get all custom filters for user

See CustomFiltersApi.get_all_custom_filters() for parameter details.

`get_all_data_view_executions(**kwargs)`

Get a list of data_view_executions

See DataViewExecutionsApi.get_all_data_view_executions() for parameter details.

`get_all_devices(**kwargs)`

List all devices.

See DevicesApi.get_all_devices() for parameter details.

`get_all_devices_status(**kwargs)`

Get status for all known devices.

See DevicesApi.get_all_devices_status() for parameter details.

`get_all_files(**kwargs)`

Return all files

See FilesApi.get_all_files() for parameter details.

`get_all_gears(**kwargs)`

List all gears

See GearsApi.get_all_gears() for parameter details.

`get_all_group_roles(group_id, **kwargs)`

Get list of group roles

See GroupsApi.get_all_group_roles() for parameter details.

`get_all_groups(**kwargs)`

List all groups

See GroupsApi.get_all_groups() for parameter details.

`get_all_jobs(**kwargs)`

Return all jobs

See JobsApi.get_all_jobs() for parameter details.

`get_all_modalities(**kwargs)`

List all modalities.

See ModalitiesApi.get_all_modalities() for parameter details.

`get_all_project_aets(**kwargs)`

List all DIMSE project AETs

See DimseApi.get_all_project_aets() for parameter details.

`get_all_projects(**kwargs)`

Get a list of projects

See ProjectsApi.get_all_projects() for parameter details.

`get_all_projects_groups(**kwargs)`

List all groups which have a project in them

See ProjectsApi.get_all_projects_groups() for parameter details.

`get_all_roles(**kwargs)`

Get list of all roles

See RolesApi.get_all_roles() for parameter details.

`get_all_saved_searches(**kwargs)`

Get Queries

See DataexplorerApi.get_all_saved_searches() for parameter details.

`get_all_service_aets(**kwargs)`

List all DIMSE services AETs

See DimseApi.get_all_service_aets() for parameter details.

`get_all_sessions(**kwargs)`

Get a list of sessions

See SessionsApi.get_all_sessions() for parameter details.

`get_all_subjects(**kwargs)`

Get a list of subjects

See SubjectsApi.get_all_subjects() for parameter details.

`get_all_users(**kwargs)`

Return a list of all users

See UsersApi.get_all_users() for parameter details.

`get_analyses(container_name, container_id, subcontainer_name, **kwargs)`

Get nested analyses for a container

See AnalysesApi.get_analyses() for parameter details.

`get_analysis(analysis_id, **kwargs)`

Get an analysis.

See AnalysesApi.get_analysis() for parameter details.

`get_analysis_download_url(analysis_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See AnalysesApi.get_analysis_download_ticket() for parameter details.

`get_analysis_file_zip_info(analysis_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See AnalysesApi.get_analysis_file_zip_info() for parameter details.

`get_analysis_input_files(container_id, filename, **kwargs)`

Get metadata for input file(s) for an analysis.

See AnalysesApi.get_analysis_input_files() for parameter details.

`get_analysis_note(container_id, note_id, **kwargs)`

Get a note of a(n) analysis.

See AnalysesApi.get_analysis_note() for parameter details.

`get_analysis_output_download_url(analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See AnalysesApi.get_analysis_output_download_ticket() for parameter details.

`get_analysis_output_file(cid, filename, **kwargs)`

Get metadata for an output file of an analysis.

See AnalysesApi.get_analysis_output_file() for parameter details.

`get_analysis_output_zip_info(analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See AnalysesApi.get_analysis_output_zip_info() for parameter details.

`get_analysis_tag(container_id, value, **kwargs)`

Get the value of a tag, by name.

See AnalysesApi.get_analysis_tag() for parameter details.

`get_auth_status(**kwargs)`

Get Login status

See AuthApi.get_auth_status() for parameter details.

`get_batch(batch_id, **kwargs)`

Get batch job details.

See BatchApi.get_batch() for parameter details.

`get_bookmark_list(**kwargs)`

Get Bookmark List

See SiteApi.get_bookmark_list() for parameter details.

`get_catalog_list_filter_options(**kwargs)`

Get all filter options for sharing a project

See ProjectsApi.get_catalog_list_filter_options() for parameter details.

`get_change_log(container_type, container_id, **kwargs)`

Get Change Log

See ChangeLogApi.get_change_log() for parameter details.

`get_collection(collection_id, **kwargs)`

Retrieve a single collection

See CollectionsApi.get_collection() for parameter details.

`get_collection_acquisitions(collection_id, **kwargs)`

List acquisitions in a collection

See CollectionsApi.get_collection_acquisitions() for parameter details.

`get_collection_download_url(collection_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See CollectionsApi.get_collection_download_ticket() for parameter details.

`get_collection_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See CollectionsApi.get_collection_file_info() for parameter details.

`get_collection_file_zip_info(collection_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See CollectionsApi.get_collection_file_zip_info() for parameter details.

`get_collection_note(cid, note_id, **kwargs)`

Get a note of a(n) collection.

See CollectionsApi.get_collection_note() for parameter details.

`get_collection_sessions(collection_id, **kwargs)`

List sessions in a collection

See CollectionsApi.get_collection_sessions() for parameter details.

`get_collection_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See CollectionsApi.get_collection_tag() for parameter details.

`get_collection_user_permission(collection_id, user_id, **kwargs)`

List a user's permissions for this group.

See CollectionsApi.get_collection_user_permission() for parameter details.

`get_config(**kwargs)`

Get public configuration

See ConfigApi.get_config() for parameter details.

`get_config_js(**kwargs)`

Return public Scitran configuration information in javascript format.

See ConfigApi.get_config_js() for parameter details.

`get_container(container_id, **kwargs)`

Retrieve a single container

See ContainersApi.get_container() for parameter details.

`get_container_analyses(cid, **kwargs)`

Get analyses for a(n) container.

See ContainersApi.get_container_analyses() for parameter details.

`get_container_analysis(cid, analysis_id, **kwargs)`

Get an analysis.

See ContainersApi.get_container_analysis() for parameter details.

`get_container_analysis_output_download_url(container_id, analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See ContainersApi.get_container_analysis_output_download_ticket() for parameter details.

`get_container_analysis_output_zip_info(container_id, analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See ContainersApi.get_container_analysis_output_zip_info() for parameter details.

`get_container_download_url(container_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See ContainersApi.get_container_download_ticket() for parameter details.

`get_container_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See ContainersApi.get_container_file_info() for parameter details.

`get_container_file_zip_info(container_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See ContainersApi.get_container_file_zip_info() for parameter details.

`get_container_note(cid, note_id, **kwargs)`

Get a note of a(n) container.

See ContainersApi.get_container_note() for parameter details.

`get_container_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See ContainersApi.get_container_tag() for parameter details.

`get_current_device(**kwargs)`

Get current device.

See DevicesApi.get_current_device() for parameter details.

`get_current_user(**kwargs)`

Get information about the current user

See UsersApi.get_current_user() for parameter details.

`get_current_user_avatar(**kwargs)`

Get the avatar of the current user

See UsersApi.get_current_user_avatar() for parameter details.

`get_current_user_info(**kwargs)`

Get info of the current user

See UsersApi.get_current_user_info() for parameter details.

`get_current_user_jobs(**kwargs)`

Return list of jobs created by the current user

See UsersApi.get_current_user_jobs() for parameter details.

`get_daily_usage_range_report(**kwargs)`

DEPRECATED - Use /reports/usage-summary instead

See ReportsApi.get_daily_usage_range_report() for parameter details.

`get_daily_usage_report(**kwargs)`

Get a daily usage report for the given month.

See ReportsApi.get_daily_usage_report() for parameter details.

`get_data_view_execution(data_view_execution_id, **kwargs)`

Get a single data_view_execution

See DataViewExecutionsApi.get_data_view_execution() for parameter details.

`get_data_view_execution_data(data_view_execution_id, **kwargs)`

Get the data from a data_view_execution

See DataViewExecutionsApi.get_data_view_execution_data() for parameter details.

`get_device(device_id, **kwargs)`

Get device details

See DevicesApi.get_device() for parameter details.

`get_facets_api_tasks_reader_facets_facet_field_get(facet_field, **kwargs)`

Get Facets

See TasksApi.get_facets_api_tasks_reader_facets_facet_field_get() for parameter details.

`get_field_change_log(container_type, container_id, field, **kwargs)`

Get change logs by specific field, in reverse chronological order

See ChangeLogApi.get_field_change_log() for parameter details.

`get_file(file_id, **kwargs)`

Get File

See FilesApi.get_file() for parameter details.

`get_file_info(file_id, **kwargs)`

Get Info

See FilesApi.get_file_info() for parameter details.

`get_file_tags(file_id, **kwargs)`

Return a file tags, from any version

See FilesApi.get_file_tags() for parameter details.

`get_file_versions(file_id, **kwargs)`

Get Versions

See FilesApi.get_file_versions() for parameter details.

`get_file_zip_info(file_id, **kwargs)`

Get Zip Info

See FilesApi.get_file_zip_info() for parameter details.

`get_gear(gear_id, **kwargs)`

Retrieve details about a specific gear

See GearsApi.get_gear() for parameter details.

`get_gear_context(gear_id, container_name, container_id, **kwargs)`

Get context values for the given gear and container.

See GearsApi.get_gear_context() for parameter details.

`get_gear_invocation(gear_id, **kwargs)`

Get a schema for invoking a gear

See GearsApi.get_gear_invocation() for parameter details.

`get_gear_series(gear_name, **kwargs)`

Get gear series.

See GearsApi.get_gear_series() for parameter details.

`get_gear_suggest(gear_id, container_name, container_id, **kwargs)`

Get files with input suggestions, parent containers, and child containers for the given container.

See GearsApi.get_gear_suggest() for parameter details.

`get_gear_ticket(ticket_id, **kwargs)`

Retrieve a specific gear ticket

See GearsApi.get_gear_ticket() for parameter details.

`get_group(group_id, **kwargs)`

Get group info

See GroupsApi.get_group() for parameter details.

`get_group_projects(group_id, **kwargs)`

Get all projects in a group

See GroupsApi.get_group_projects() for parameter details.

`get_group_role(group_id, role_id, **kwargs)`

Return the role identified by the RoleId

See GroupsApi.get_group_role() for parameter details.

`get_group_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See GroupsApi.get_group_tag() for parameter details.

`get_group_user_permission(group_id, user_id, **kwargs)`

List a user's permissions for this group.

See GroupsApi.get_group_user_permission() for parameter details.

`get_group_user_permission_template(group_id, user_id, **kwargs)`

List a user's permissions for this group.

See GroupsApi.get_group_user_permission_template() for parameter details.

`get_job(job_id, **kwargs)`

Get job details

See JobsApi.get_job() for parameter details.

`get_job_config(job_id, **kwargs)`

Get a job's config

See JobsApi.get_job_config() for parameter details.

`get_job_detail(job_id, **kwargs)`

Get job container details

See JobsApi.get_job_detail() for parameter details.

`get_job_logs(job_id, **kwargs)`

Get job logs

See JobsApi.get_job_logs() for parameter details.

`get_jobs_stats(**kwargs)`

Get stats about all current jobs

See JobsApi.get_jobs_stats() for parameter details.

`get_jupyterlab_server(jupyterlab_server_id, **kwargs)`

Get jupyterlab server

See JupyterlabServersApi.get_jupyterlab_server() for parameter details.

`get_legacy_usage_report(type, **kwargs)`

Get a usage report for the site grouped by month or project

See ReportsApi.get_legacy_usage_report() for parameter details.

`get_mapped_fields(**kwargs)`

Get fields mapped for search

See DataexplorerApi.get_mapped_fields() for parameter details.

`get_modality(modality_id, **kwargs)`

Get a modality's classification specification

See ModalitiesApi.get_modality() for parameter details.

`get_my_gear_tickets(**kwargs)`

Retrieve all gear tickets for the current user

See GearsApi.get_my_gear_tickets() for parameter details.

`get_next_job(**kwargs)`

Get the next job in the queue

See JobsApi.get_next_job() for parameter details.

`get_project(project_id, **kwargs)`

Get a single project

See ProjectsApi.get_project() for parameter details.

`get_project_acquisitions(project_id, **kwargs)`

List all acquisitions for the given project.

See ProjectsApi.get_project_acquisitions() for parameter details.

`get_project_aet(project_aet, **kwargs)`

Get DIMSE project AET

See DimseApi.get_project_aet() for parameter details.

`get_project_analyses(cid, **kwargs)`

Get analyses for a(n) project.

See ProjectsApi.get_project_analyses() for parameter details.

`get_project_analysis(cid, analysis_id, **kwargs)`

Get an analysis.

See ProjectsApi.get_project_analysis() for parameter details.

`get_project_analysis_output_download_url(project_id, analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See ProjectsApi.get_project_analysis_output_download_ticket() for parameter details.

`get_project_analysis_output_zip_info(project_id, analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See ProjectsApi.get_project_analysis_output_zip_info() for parameter details.

`get_project_delete_status(project_id, **kwargs)`

Get project deletion status

See ProjectsApi.get_project_delete_status() for parameter details.

`get_project_download_url(project_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See ProjectsApi.get_project_download_ticket() for parameter details.

`get_project_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See ProjectsApi.get_project_file_info() for parameter details.

`get_project_file_zip_info(project_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See ProjectsApi.get_project_file_zip_info() for parameter details.

`get_project_note(cid, note_id, **kwargs)`

Get a note of a(n) project.

See ProjectsApi.get_project_note() for parameter details.

`get_project_report(**kwargs)`

Get project report

See ReportsApi.get_project_report() for parameter details.

`get_project_rule(project_id, rule_id, **kwargs)`

Get a project rule.

See ProjectsApi.get_project_rule() for parameter details.

`get_project_rules(project_id, **kwargs)`

List all rules for a project.

See ProjectsApi.get_project_rules() for parameter details.

`get_project_sessions(project_id, **kwargs)`

List all sessions for the given project.

See ProjectsApi.get_project_sessions() for parameter details.

`get_project_settings(project_id, **kwargs)`

Get a(n) project settings

See SettingsApi.get_project_settings() for parameter details.

`get_project_subjects(project_id, **kwargs)`

List all subjects for the given project.

See ProjectsApi.get_project_subjects() for parameter details.

`get_project_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See ProjectsApi.get_project_tag() for parameter details.

`get_project_user_permission(project_id, uid, **kwargs)`

List a user's permissions for this project.

See ProjectsApi.get_project_user_permission() for parameter details.

`get_provider(provider_id, **kwargs)`

Return the provider identified by ProviderId

See SiteApi.get_provider() for parameter details.

`get_provider_config(provider_id, **kwargs)`

Return the configuration for provider identified by ProviderId

See SiteApi.get_provider_config() for parameter details.

`get_providers(**kwargs)`

Return a list of all providers on the site

See SiteApi.get_providers() for parameter details.

`get_reader_task(task_id, **kwargs)`

Get By Id

See TasksApi.get_reader_task() for parameter details.

`get_response(response_id, **kwargs)`

Retrieve a specific response

See FormResponsesApi.get_response() for parameter details.

`get_role(role_id, **kwargs)`

Return the role identified by the RoleId

See RolesApi.get_role() for parameter details.

`get_saved_search(sid, **kwargs)`

Return a saved search query

See DataexplorerApi.get_saved_search() for parameter details.

`get_search_query_suggestions(body, **kwargs)`

Get suggestions for a structured search query

See DataexplorerApi.get_search_query_suggestions() for parameter details.

`get_search_status(**kwargs)`

Get the status of search (Mongo Connector)

See DataexplorerApi.get_search_status() for parameter details.

`get_service_aet(service_aet, **kwargs)`

Get DIMSE service by AET or id

See DimseApi.get_service_aet() for parameter details.

`get_session(session_id, **kwargs)`

Get a single session

See SessionsApi.get_session() for parameter details.

`get_session_acquisitions(session_id, **kwargs)`

List acquisitions in a session

See SessionsApi.get_session_acquisitions() for parameter details.

`get_session_analyses(cid, **kwargs)`

Get analyses for a(n) session.

See SessionsApi.get_session_analyses() for parameter details.

`get_session_analysis(cid, analysis_id, **kwargs)`

Get an analysis.

See SessionsApi.get_session_analysis() for parameter details.

`get_session_analysis_output_download_url(session_id, analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See SessionsApi.get_session_analysis_output_download_ticket() for parameter details.

`get_session_analysis_output_zip_info(session_id, analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See SessionsApi.get_session_analysis_output_zip_info() for parameter details.

`get_session_download_url(session_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See SessionsApi.get_session_download_ticket() for parameter details.

`get_session_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See SessionsApi.get_session_file_info() for parameter details.

`get_session_file_zip_info(session_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See SessionsApi.get_session_file_zip_info() for parameter details.

`get_session_jobs(session_id, **kwargs)`

Return any jobs that use inputs from this session

See SessionsApi.get_session_jobs() for parameter details.

`get_session_note(cid, note_id, **kwargs)`

Get a note of a(n) session.

See SessionsApi.get_session_note() for parameter details.

`get_session_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See SessionsApi.get_session_tag() for parameter details.

`get_site_report(**kwargs)`

Get the site report

See ReportsApi.get_site_report() for parameter details.

`get_site_rule(rule_id, **kwargs)`

Get a site rule.

See SiteApi.get_site_rule() for parameter details.

`get_site_rules(**kwargs)`

List all site rules.

See SiteApi.get_site_rules() for parameter details.

`get_site_settings(**kwargs)`

Return administrative site settings

See SiteApi.get_site_settings() for parameter details.

`get_staffing_pool(pool_id, **kwargs)`

Get By Id

See StaffingPoolsApi.get_staffing_pool() for parameter details.

`get_subject(subject_id, **kwargs)`

Get a single subject

See SubjectsApi.get_subject() for parameter details.

`get_subject_analyses(cid, **kwargs)`

Get analyses for a(n) subject.

See SubjectsApi.get_subject_analyses() for parameter details.

`get_subject_analysis(cid, analysis_id, **kwargs)`

Get an analysis.

See SubjectsApi.get_subject_analysis() for parameter details.

`get_subject_analysis_output_download_url(subject_id, analysis_id, filename, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See SubjectsApi.get_subject_analysis_output_download_ticket() for parameter details.

`get_subject_analysis_output_zip_info(subject_id, analysis_id, filename, **kwargs)`

Retrieve the zip info of a child file by name.

See SubjectsApi.get_subject_analysis_output_zip_info() for parameter details.

`get_subject_download_url(subject_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

Returns a download URL with ticket. See SubjectsApi.get_subject_download_ticket() for parameter details.

`get_subject_file_info(cid, filename, **kwargs)`

Get info for a particular file.

See SubjectsApi.get_subject_file_info() for parameter details.

`get_subject_file_zip_info(subject_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

See SubjectsApi.get_subject_file_zip_info() for parameter details.

`get_subject_note(cid, note_id, **kwargs)`

Get a note of a(n) subject.

See SubjectsApi.get_subject_note() for parameter details.

`get_subject_sessions(subject_id, **kwargs)`

List sessions of a subject

See SubjectsApi.get_subject_sessions() for parameter details.

`get_subject_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

See SubjectsApi.get_subject_tag() for parameter details.

`get_task_parent_container_ids(ids, container_type, **kwargs)`

Get Task Parent Container Ids

See ContainerTasksApi.get_task_parent_container_ids() for parameter details.

`get_task_protocol(protocol_id, **kwargs)`

Get By Id

See ProtocolsApi.get_task_protocol() for parameter details.

`get_tree_graph(**kwargs)`

Get a description of the flywheel hiearchy

See TreeApi.get_tree_graph() for parameter details.

`get_usage_availability(**kwargs)`

Get year/month combinations where report data is available.

See ReportsApi.get_usage_availability() for parameter details.

`get_usage_data_summary(**kwargs)`

Get aggregated usage data

See ReportsApi.get_usage_data_summary() for parameter details.

`get_usage_report(**kwargs)`

Get a usage report for the given month. If no year/month pair is given, the current month will be used.

See ReportsApi.get_usage_report() for parameter details.

`get_user(user_id, **kwargs)`

Get information about the specified user

See UsersApi.get_user() for parameter details.

`get_user_acquisitions(uid, **kwargs)`

Get all acquisitions that belong to the given user.

See UsersApi.get_user_acquisitions() for parameter details.

`get_user_avatar(user_id, **kwargs)`

Get the avatar of the specified user

See UsersApi.get_user_avatar() for parameter details.

`get_user_collections(user_id, **kwargs)`

Get all collections that belong to the given user.

See UsersApi.get_user_collections() for parameter details.

`get_user_groups(uid, **kwargs)`

List all groups the specified user is a member of

See UsersApi.get_user_groups() for parameter details.

`get_user_projects(uid, **kwargs)`

Get all projects that belong to the given user.

See UsersApi.get_user_projects() for parameter details.

`get_user_sessions(uid, **kwargs)`

Get all sessions that belong to the given user.

See UsersApi.get_user_sessions() for parameter details.

`get_version(**kwargs)`

Get server and database schema version info

See ConfigApi.get_version() for parameter details.

`get_view(view_id, **kwargs)`

Return the view identified by ViewId

See ViewsApi.get_view() for parameter details.

`get_views(container_id, **kwargs)`

Return a list of all views belonging to container

See ContainersApi.get_views() for parameter details.

`heartbeat_job(job_id, **kwargs)`

Heartbeat a running job to update its modified timestamp.

See JobsApi.heartbeat_job() for parameter details.

`list_audit_trail_reports(**kwargs)`

List Audit Trail Reports

See AuditTrailApi.list_audit_trail_reports() for parameter details.

`list_task_responses(task_id, **kwargs)`

List all responses for a given task

See FormResponsesApi.list_task_responses() for parameter details.

`lookup(path)`

Perform a path based lookup of a single node in the Flywheel hierarchy.

Parameters:

Name	Type	Description	Default
`path`	`str`	The path to resolve	required

`lookup_path(body, **kwargs)`

Perform path based lookup of a single node in the Flywheel hierarchy

See ResolveApi.lookup_path() for parameter details.

`modify_acquisition(acquisition_id, body, **kwargs)`

Update an acquisition

See AcquisitionsApi.modify_acquisition() for parameter details.

`modify_acquisition_analysis(cid, analysis_id, body, **kwargs)`

Modify an analysis.

See AcquisitionsApi.modify_acquisition_analysis() for parameter details.

`modify_acquisition_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See AcquisitionsApi.modify_acquisition_file() for parameter details.

`modify_acquisition_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See AcquisitionsApi.modify_acquisition_file_classification() for parameter details.

`modify_acquisition_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See AcquisitionsApi.modify_acquisition_file_info() for parameter details.

`modify_acquisition_info(cid, body, **kwargs)`

Update or replace info for a(n) acquisition.

See AcquisitionsApi.modify_acquisition_info() for parameter details.

`modify_acquisition_note(cid, note_id, body, **kwargs)`

Update a note of a(n) acquisition.

See AcquisitionsApi.modify_acquisition_note() for parameter details.

`modify_analysis(analysis_id, body, **kwargs)`

Modify an analysis.

See AnalysesApi.modify_analysis() for parameter details.

`modify_analysis_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See AnalysesApi.modify_analysis_file() for parameter details.

`modify_analysis_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See AnalysesApi.modify_analysis_file_classification() for parameter details.

`modify_analysis_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See AnalysesApi.modify_analysis_file_info() for parameter details.

`modify_analysis_info(container_id, body, **kwargs)`

Update or replace info for a(n) analysis.

See AnalysesApi.modify_analysis_info() for parameter details.

`modify_analysis_note(container_id, note_id, body, **kwargs)`

Update a note of a(n) analysis.

See AnalysesApi.modify_analysis_note() for parameter details.

`modify_audit_trail_report(report_id, body, **kwargs)`

Modify an Audit Trail Report

See AuditTrailApi.modify_audit_trail_report() for parameter details.

`modify_bookmark_list(body, **kwargs)`

Modify Bookmark List

See SiteApi.modify_bookmark_list() for parameter details.

`modify_collection(collection_id, body, **kwargs)`

Update a collection and its contents

See CollectionsApi.modify_collection() for parameter details.

`modify_collection_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See CollectionsApi.modify_collection_file() for parameter details.

`modify_collection_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See CollectionsApi.modify_collection_file_classification() for parameter details.

`modify_collection_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See CollectionsApi.modify_collection_file_info() for parameter details.

`modify_collection_info(cid, body, **kwargs)`

Update or replace info for a(n) collection.

See CollectionsApi.modify_collection_info() for parameter details.

`modify_collection_note(cid, note_id, body, **kwargs)`

Update a note of a(n) collection.

See CollectionsApi.modify_collection_note() for parameter details.

`modify_collection_user_permission(collection_id, user_id, body, **kwargs)`

Update a user's permission for this group.

See CollectionsApi.modify_collection_user_permission() for parameter details.

`modify_container(container_id, body, **kwargs)`

Update a container and its contents

See ContainersApi.modify_container() for parameter details.

`modify_container_analysis(cid, analysis_id, body, **kwargs)`

Modify an analysis.

See ContainersApi.modify_container_analysis() for parameter details.

`modify_container_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See ContainersApi.modify_container_file() for parameter details.

`modify_container_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See ContainersApi.modify_container_file_classification() for parameter details.

`modify_container_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See ContainersApi.modify_container_file_info() for parameter details.

`modify_container_info(cid, body, **kwargs)`

Update or replace info for a(n) container.

See ContainersApi.modify_container_info() for parameter details.

`modify_container_note(cid, note_id, body, **kwargs)`

Update a note of a(n) container.

See ContainersApi.modify_container_note() for parameter details.

`modify_current_user_info(body, **kwargs)`

Update or replace info for the current user.

See UsersApi.modify_current_user_info() for parameter details.

`modify_device(device_id, body, **kwargs)`

Update a device

See DevicesApi.modify_device() for parameter details.

`modify_file_classification(file_id, body, **kwargs)`

Modify Classification

See FilesApi.modify_file_classification() for parameter details.

`modify_file_info(file_id, **kwargs)`

Modify Info

See FilesApi.modify_file_info() for parameter details.

`modify_gear_series(gear_name, body, **kwargs)`

Update a gear series

See GearsApi.modify_gear_series() for parameter details.

`modify_group(group_id, body, **kwargs)`

Update group

See GroupsApi.modify_group() for parameter details.

`modify_group_user_permission(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

See GroupsApi.modify_group_user_permission() for parameter details.

`modify_group_user_permission_template(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

See GroupsApi.modify_group_user_permission_template() for parameter details.

`modify_job(job_id, body, **kwargs)`

Update a job.

See JobsApi.modify_job() for parameter details.

`modify_jupyterlab_server(jupyterlab_server_id, body, **kwargs)`

Update a jupyterlab server

See JupyterlabServersApi.modify_jupyterlab_server() for parameter details.

`modify_project(project_id, body, **kwargs)`

Update a project

See ProjectsApi.modify_project() for parameter details.

`modify_project_analysis(cid, analysis_id, body, **kwargs)`

Modify an analysis.

See ProjectsApi.modify_project_analysis() for parameter details.

`modify_project_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See ProjectsApi.modify_project_file() for parameter details.

`modify_project_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See ProjectsApi.modify_project_file_classification() for parameter details.

`modify_project_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See ProjectsApi.modify_project_file_info() for parameter details.

`modify_project_info(cid, body, **kwargs)`

Update or replace info for a(n) project.

See ProjectsApi.modify_project_info() for parameter details.

`modify_project_note(cid, note_id, body, **kwargs)`

Update a note of a(n) project.

See ProjectsApi.modify_project_note() for parameter details.

`modify_project_rule(project_id, rule_id, body, **kwargs)`

Update a rule on a project.

See ProjectsApi.modify_project_rule() for parameter details.

`modify_project_settings(project_id, body, **kwargs)`

Modify a(n) project settings

See SettingsApi.modify_project_settings() for parameter details.

`modify_project_user_permission(project_id, uid, body, **kwargs)`

Update a user's permission for this project.

See ProjectsApi.modify_project_user_permission() for parameter details.

`modify_provider(provider_id, body, **kwargs)`

Update the provider identified by ProviderId

See SiteApi.modify_provider() for parameter details.

`modify_reader_task(task_id, body, **kwargs)`

Modify

See TasksApi.modify_reader_task() for parameter details.

`modify_role(role_id, body, **kwargs)`

Update the role identified by RoleId

See RolesApi.modify_role() for parameter details.

`modify_session(session_id, body, **kwargs)`

Update a session

See SessionsApi.modify_session() for parameter details.

`modify_session_analysis(cid, analysis_id, body, **kwargs)`

Modify an analysis.

See SessionsApi.modify_session_analysis() for parameter details.

`modify_session_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See SessionsApi.modify_session_file() for parameter details.

`modify_session_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See SessionsApi.modify_session_file_classification() for parameter details.

`modify_session_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See SessionsApi.modify_session_file_info() for parameter details.

`modify_session_info(cid, body, **kwargs)`

Update or replace info for a(n) session.

See SessionsApi.modify_session_info() for parameter details.

`modify_session_note(cid, note_id, body, **kwargs)`

Update a note of a(n) session.

See SessionsApi.modify_session_note() for parameter details.

`modify_site_rule(rule_id, body, **kwargs)`

Update a site rule.

See SiteApi.modify_site_rule() for parameter details.

`modify_site_settings(body, **kwargs)`

Update administrative site settings

See SiteApi.modify_site_settings() for parameter details.

`modify_staffing_pool(pool_id, body, **kwargs)`

Modify

See StaffingPoolsApi.modify_staffing_pool() for parameter details.

`modify_subject(subject_id, body, **kwargs)`

Update a subject

See SubjectsApi.modify_subject() for parameter details.

`modify_subject_analysis(cid, analysis_id, body, **kwargs)`

Modify an analysis.

See SubjectsApi.modify_subject_analysis() for parameter details.

`modify_subject_file(cid, filename, body, **kwargs)`

Modify a file's attributes

See SubjectsApi.modify_subject_file() for parameter details.

`modify_subject_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

See SubjectsApi.modify_subject_file_classification() for parameter details.

`modify_subject_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

See SubjectsApi.modify_subject_file_info() for parameter details.

`modify_subject_info(cid, body, **kwargs)`

Update or replace info for a(n) subject.

See SubjectsApi.modify_subject_info() for parameter details.

`modify_subject_note(cid, note_id, body, **kwargs)`

Update a note of a(n) subject.

See SubjectsApi.modify_subject_note() for parameter details.

`modify_task_protocol(protocol_id, body, **kwargs)`

Modify

See ProtocolsApi.modify_task_protocol() for parameter details.

`modify_user(uid, body, **kwargs)`

Update the specified user

See UsersApi.modify_user() for parameter details.

`modify_view(view_id, body, **kwargs)`

Update the view identified by ViewId

See ViewsApi.modify_view() for parameter details.

`move_file(file_id, body, **kwargs)`

Move and/or rename a file

See FilesApi.move_file() for parameter details.

`parse_search_query(body, **kwargs)`

Parse a structured search query

See DataexplorerApi.parse_search_query() for parameter details.

`prepare_add_gear(body, **kwargs)`

Prepare a gear upload

See GearsApi.prepare_add_gear() for parameter details.

`prepare_complete_job(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

See JobsApi.prepare_complete_job() for parameter details.

`print_view_columns(filter=None, limit=25, file=sys.stdout)`

Print a list of column aliases that can be used in data views.

Parameters:

Name	Type	Description	Default
`filter`	`(str, optional)`	The filter for available columns	`None`
`limit`	`(int, optional)`	The limit for the number of columns to return	`25`
`file`	`file - like`	The file to print to	`stdout`

`project_copy(project_id, body, **kwargs)`

Copy By Reference

See ProjectsApi.project_copy() for parameter details.

`project_packfile_upload(project_id, token, file, **kwargs)`

Add files to an in-progress packfile

See ProjectsApi.project_packfile_upload() for parameter details.

`propose_batch(body, **kwargs)`

Create a batch job proposal and insert it as 'pending'.

See BatchApi.propose_batch() for parameter details.

`publish_task_protocol(protocol_id, **kwargs)`

Publish

See ProtocolsApi.publish_task_protocol() for parameter details.

`put_task_response(task_id, response_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

See FormResponsesApi.put_task_response() for parameter details.

`queue_adhoc(container_id, body, **kwargs)`

Execute an ad-hoc view, returning a reference to the created data view execution.

See ViewsApi.queue_adhoc() for parameter details.

`queue_saved(view_id, container_id, **kwargs)`

Execute a view, returning a reference to the created data view execution.

See ViewsApi.queue_saved() for parameter details.

`read_view_data(view, container_id, decode=True, **kwargs)`

Execute a data view against container, and return a file-like object that can be streamed.

Parameters:

Name	Type	Description	Default
`view`	`str \| DataView`	The view id or DataView object to execute.	required
`container_id`	`str`	The id of the container to execute the view against	required
`decode`	`(bool, optional)`	Whether or not to decode the stream to utf-8 (default is true)	`True`
`kwargs`		Additional arguments to pass to the evaluate_view call. (e.g. format='csv')	`{}`

Returns:

Type	Description
	A file-like object where the contents can be read

`read_view_dataframe(view, container_id, opts=None, **kwargs)`

Execute a data view against container, and return a DataFrame.

NOTE: This requires that the pandas module be installed on the system.

Parameters:

Name	Type	Description	Default
`view`	`str \| DataView`	The view id or DataView object to execute.	required
`container_id`	`str`	The id of the container to execute the view against	required
`opts`	`(dict, optional)`	Additional options to pass to the pandas read_json function	`None`
`kwargs`		Additional arguments to pass to the evaluate_view call.	`{}`

Returns:

Type	Description
	A pandas DataFrame

`reap_jobs(**kwargs)`

Reap stale jobs

See JobsApi.reap_jobs() for parameter details.

`recalc_all_projects(**kwargs)`

Recalculate all sessions against their project templates.

See ProjectsApi.recalc_all_projects() for parameter details.

`recalc_project(project_id, **kwargs)`

Currently does nothing--will eventually calculate if sessions in the project satisfy the template.

See ProjectsApi.recalc_project() for parameter details.

`remove_project_rule(project_id, rule_id, **kwargs)`

Remove a project rule.

See ProjectsApi.remove_project_rule() for parameter details.

`remove_project_template(project_id, **kwargs)`

Remove the session template for a project.

See ProjectsApi.remove_project_template() for parameter details.

`remove_role_from_group(group_id, role_id, **kwargs)`

Remove the role from the group

See GroupsApi.remove_role_from_group() for parameter details.

`remove_site_rule(rule_id, **kwargs)`

Remove a site rule.

See SiteApi.remove_site_rule() for parameter details.

`rename_acquisition_tag(cid, value, body, **kwargs)`

Rename a tag.

See AcquisitionsApi.rename_acquisition_tag() for parameter details.

`rename_analysis_tag(container_id, value, body, **kwargs)`

Rename a tag.

See AnalysesApi.rename_analysis_tag() for parameter details.

`rename_collection_tag(cid, value, body, **kwargs)`

Rename a tag.

See CollectionsApi.rename_collection_tag() for parameter details.

`rename_container_tag(cid, value, body, **kwargs)`

Rename a tag.

See ContainersApi.rename_container_tag() for parameter details.

`rename_group_tag(cid, value, body, **kwargs)`

Rename a tag.

See GroupsApi.rename_group_tag() for parameter details.

`rename_project_tag(cid, value, body, **kwargs)`

Rename a tag.

See ProjectsApi.rename_project_tag() for parameter details.

`rename_session_tag(cid, value, body, **kwargs)`

Rename a tag.

See SessionsApi.rename_session_tag() for parameter details.

`rename_subject_tag(cid, value, body, **kwargs)`

Rename a tag.

See SubjectsApi.rename_subject_tag() for parameter details.

`replace_acquisition_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See AcquisitionsApi.modify_acquisition_file_classification() for parameter details.

`replace_acquisition_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See AcquisitionsApi.modify_acquisition_file_info() for parameter details.

`replace_acquisition_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See AcquisitionsApi.modify_acquisition_info() for parameter details.

`replace_analysis_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See AnalysesApi.modify_analysis_file_classification() for parameter details.

`replace_analysis_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See AnalysesApi.modify_analysis_file_info() for parameter details.

`replace_analysis_info(container_id, body, **kwargs)`

Entirely replace info with the provided fields.

See AnalysesApi.modify_analysis_info() for parameter details.

`replace_collection_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See CollectionsApi.modify_collection_file_classification() for parameter details.

`replace_collection_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See CollectionsApi.modify_collection_file_info() for parameter details.

`replace_collection_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See CollectionsApi.modify_collection_info() for parameter details.

`replace_container_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See ContainersApi.modify_container_file_classification() for parameter details.

`replace_container_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See ContainersApi.modify_container_file_info() for parameter details.

`replace_container_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See ContainersApi.modify_container_info() for parameter details.

`replace_file_info(file_id, **kwargs)`

Replace Info

See FilesApi.replace_file_info() for parameter details.

`replace_gear_permissions(gear_name, body, **kwargs)`

Replace permissions for the given gear

See GearsApi.replace_gear_permissions() for parameter details.

`replace_modality(modality_id, body, **kwargs)`

Replace modality

See ModalitiesApi.replace_modality() for parameter details.

`replace_project_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See ProjectsApi.modify_project_file_classification() for parameter details.

`replace_project_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See ProjectsApi.modify_project_file_info() for parameter details.

`replace_project_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See ProjectsApi.modify_project_info() for parameter details.

`replace_search(sid, body, **kwargs)`

Replace a search query

See DataexplorerApi.replace_search() for parameter details.

`replace_session_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See SessionsApi.modify_session_file_classification() for parameter details.

`replace_session_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See SessionsApi.modify_session_file_info() for parameter details.

`replace_session_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See SessionsApi.modify_session_info() for parameter details.

`replace_subject_file_classification(cid, filename, body, **kwargs)`

Entirely replace classification with the provided fields.

See SubjectsApi.modify_subject_file_classification() for parameter details.

`replace_subject_file_info(cid, filename, body, **kwargs)`

Entirely replace info with the provided fields.

See SubjectsApi.modify_subject_file_info() for parameter details.

`replace_subject_info(cid, body, **kwargs)`

Entirely replace info with the provided fields.

See SubjectsApi.modify_subject_info() for parameter details.

`resolve(path, **kwargs)`

Perform a path based lookup of nodes in the Flywheel hierarchy.

Parameters:

Name	Type	Description	Default
`path`	`str`	The path to resolve	required

`resolve_path(body, **kwargs)`

Perform path based lookup of nodes in the Flywheel hierarchy

See ResolveApi.resolve_path() for parameter details.

`restore_file(file_id, version, evaluate_gear_rules, **kwargs)`

Restore a File

See FilesApi.restore_file() for parameter details.

`retry_job(job_id, **kwargs)`

Retry a job.

See JobsApi.retry_job() for parameter details.

`save_data_view_execution(data_view_execution_id, **kwargs)`

Save a data_view_execution to a project

See DataViewExecutionsApi.save_data_view_execution() for parameter details.

`save_gear(body, **kwargs)`

Report the result of a gear upload and save the ticket

See GearsApi.save_gear() for parameter details.

`save_search(body, **kwargs)`

Save a search query

See DataexplorerApi.save_search() for parameter details.

`save_view_data(view, container_id, dest_file, **kwargs)`

Execute a data view against container, and save the results to disk.

Parameters:

Name	Type	Description	Default
`view`	`str \| DataView`	The view id or DataView object to execute.	required
`container_id`	`str`	The id of the container to execute the view against	required
`dest_file`	`str`	The destination file path	required
`kwargs`		Additional arguments to pass to the evaluate_view call. (e.g. format='csv')	`{}`

`save_view_data_to_container(container_id, body, **kwargs)`

Execute a view, saving data to the target container / file

See ViewsApi.save_view_data_to_container() for parameter details.

`search(body, **kwargs)`

Perform a search query

See DataexplorerApi.search() for parameter details.

`session_copy(session_id, body, **kwargs)`

Smart copy a session

See SessionsApi.session_copy() for parameter details.

`set_acquisition_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See AcquisitionsApi.modify_acquisition_file_classification() for parameter details.

`set_acquisition_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See AcquisitionsApi.modify_acquisition_file_info() for parameter details.

`set_acquisition_info(cid, body, **kwargs)`

Update info with the provided fields.

See AcquisitionsApi.modify_acquisition_info() for parameter details.

`set_analysis_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See AnalysesApi.modify_analysis_file_classification() for parameter details.

`set_analysis_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See AnalysesApi.modify_analysis_file_info() for parameter details.

`set_analysis_info(container_id, body, **kwargs)`

Update info with the provided fields.

See AnalysesApi.modify_analysis_info() for parameter details.

`set_collection_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See CollectionsApi.modify_collection_file_classification() for parameter details.

`set_collection_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See CollectionsApi.modify_collection_file_info() for parameter details.

`set_collection_info(cid, body, **kwargs)`

Update info with the provided fields.

See CollectionsApi.modify_collection_info() for parameter details.

`set_container_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See ContainersApi.modify_container_file_classification() for parameter details.

`set_container_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See ContainersApi.modify_container_file_info() for parameter details.

`set_container_info(cid, body, **kwargs)`

Update info with the provided fields.

See ContainersApi.modify_container_info() for parameter details.

`set_file_tags(file_id, body, **kwargs)`

Set list of tags on a file.

See FilesApi.set_file_tags() for parameter details.

`set_project_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See ProjectsApi.modify_project_file_classification() for parameter details.

`set_project_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See ProjectsApi.modify_project_file_info() for parameter details.

`set_project_info(cid, body, **kwargs)`

Update info with the provided fields.

See ProjectsApi.modify_project_info() for parameter details.

`set_project_template(project_id, body, **kwargs)`

Set the session template for a project.

See ProjectsApi.set_project_template() for parameter details.

`set_session_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See SessionsApi.modify_session_file_classification() for parameter details.

`set_session_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See SessionsApi.modify_session_file_info() for parameter details.

`set_session_info(cid, body, **kwargs)`

Update info with the provided fields.

See SessionsApi.modify_session_info() for parameter details.

`set_subject_file_classification(cid, filename, body, **kwargs)`

Update classification with the provided fields.

See SubjectsApi.modify_subject_file_classification() for parameter details.

`set_subject_file_info(cid, filename, body, **kwargs)`

Update info with the provided fields.

See SubjectsApi.modify_subject_file_info() for parameter details.

`set_subject_info(cid, body, **kwargs)`

Update info with the provided fields.

See SubjectsApi.modify_subject_info() for parameter details.

`set_user_staffing_pools(user_id, body, **kwargs)`

Set User Staffing Pools

See StaffingPoolsApi.set_user_staffing_pools() for parameter details.

`shutdown()`

Release any outstanding resources

`start_batch(batch_id, **kwargs)`

Launch a job.

See BatchApi.start_batch() for parameter details.

`start_project_packfile_upload(project_id, **kwargs)`

Start a packfile upload to project

See ProjectsApi.start_project_packfile_upload() for parameter details.

`subject_copy(subject_id, body, **kwargs)`

Smart copy a subject

See SubjectsApi.subject_copy() for parameter details.

`submit_response(response_id, **kwargs)`

Submit a response. Validate against form schema and lock it

See FormResponsesApi.submit_response() for parameter details.

`sync_user(cid, body, **kwargs)`

Sync a center user to enterprise (Sync service use ONLY)

See UsersApi.sync_user() for parameter details.

`update_custom_filter(custom_filter_id, body, **kwargs)`

Update a custom filter for user

See CustomFiltersApi.update_custom_filter() for parameter details.

`update_device(body, **kwargs)`

Modify a device's type, name, interval, info or set errors.

See DevicesApi.update_device() for parameter details.

`update_job_profile(job_id, body, **kwargs)`

Update profile information on a job. (e.g. machine type, etc)

See JobsApi.update_job_profile() for parameter details.

`update_jobs_priority(body, **kwargs)`

Update a job priority.

See JobsApi.update_jobs_priority() for parameter details.

`update_response(response_id, body, **kwargs)`

Update a response only if not submitted

See FormResponsesApi.update_response() for parameter details.

`upload_by_label(**kwargs)`

Multipart form upload with N file fields, each with their desired filename.

See UploadApi.upload_by_label() for parameter details.

`upload_by_reaper(**kwargs)`

Bottom-up UID matching of Multipart form upload with N file fields, each with their desired filename.

See UploadApi.upload_by_reaper() for parameter details.

`upload_by_uid(**kwargs)`

Multipart form upload with N file fields, each with their desired filename.

See UploadApi.upload_by_uid() for parameter details.

`upload_file_to_acquisition(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) acquisition.

See AcquisitionsApi.upload_file_to_acquisition() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_file_to_collection(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) collection.

See CollectionsApi.upload_file_to_collection() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_file_to_container(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) container.

See ContainersApi.upload_file_to_container() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_file_to_project(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) project.

See ProjectsApi.upload_file_to_project() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_file_to_session(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) session.

See SessionsApi.upload_file_to_session() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_file_to_subject(container_id, file, signed=True, **kwargs)`

Upload a file to a(n) subject.

See SubjectsApi.upload_file_to_subject() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_acquisition_analysis(cid, analysis_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See AcquisitionsApi.upload_output_to_acquisition_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_analysis(container_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See AnalysesApi.upload_output_to_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_container_analysis(cid, analysis_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See ContainersApi.upload_output_to_container_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_project_analysis(cid, analysis_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See ProjectsApi.upload_output_to_project_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_session_analysis(cid, analysis_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See SessionsApi.upload_output_to_session_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_output_to_subject_analysis(cid, analysis_id, file, signed=True, **kwargs)`

Upload an output file to an analysis.

See SubjectsApi.upload_output_to_subject_analysis() for parameter details.

Parameters:

Name	Type	Description	Default
`signed`	`(bool, optional)`	Use signed URL upload if available, defaults to True	`True`

`upload_signed_fs_file(token, body, **kwargs)`

Upload file to local filesystem storage provider

See UploadApi.upload_signed_fs_file() for parameter details.

`upsert_file(body, **kwargs)`

Upsert a File

See FilesApi.upsert_file() for parameter details.

`upsert_project_hierarchy(project_id, body, **kwargs)`

Create or update subject, session and acquisition containers in the project.

See ProjectsApi.upsert_project_hierarchy() for parameter details.

`verify_master_subject_code(code, **kwargs)`

Verify that the given master subject code exists or not

See SubjectsApi.verify_master_subject_code() for parameter details.