Skip to content
Flywheel SDK Documentation
common_editions
Initializing search
Flywheel SDK Documentation
Home
Getting Started
Core Concepts
Core Concepts
Hierarchy
Containers
File Upload/Download
Finders
Metadata
Copy
Data Views
Client Configuration
Advanced Usage
Advanced Usage
Performance Optimization
Reloading and Caching
Low-Level API Access
Advanced Search
Bulk Container Creation
Bulk Metadata Updates
Bulk File Operations
Bulk Move Sessions
Running Gears in Batch
Gear Concepts
Gear Concepts
Gears
Jobs
Analyses
Clinical Concepts
Clinical Concepts
Protocols
Reader Tasks
Form Responses
Staffing Pools
Admin Concepts
Admin Concepts
Groups
Users
Roles
Permissions
Site Settings
External Storage
UI Extensions
Gear Rules
Modality and Classification Schema
Access Log
Audit Trail
Usage Reporting
Archive
Archive
Getting Started (archive)
Starting Examples
Core Concepts
Core Concepts
Containers and Hierarchy
Data Model
Data Views (archive)
Usage
Usage
Examples
SDK Gears
Python SDK with R
Quick Reference
API Reference
API Reference
flywheel
flywheel
api
api
acquisitions_api
analyses_api
audit_trail_api
auth_api
batch_api
bulk_api
change_log_api
collections_api
config_api
container_tasks_api
container_type_api
containers_api
custom_filters_api
data_view_executions_api
dataexplorer_api
devices_api
dimse_api
download_api
files_api
form_responses_api
gears_api
groups_api
jobs_api
jupyterlab_servers_api
modalities_api
packfile_api
projects_api
protocols_api
reports_api
resolve_api
roles_api
sessions_api
settings_api
site_api
staffing_pools_api
subjects_api
tasks_api
tree_api
uids_api
upload_api
users_api
views_api
api_client
client
configuration
drone_login
file_spec
finder
flywheel
gear_context
models
models
access_level
access_permission
access_permission_output
access_permission_update
access_type
accumulator
acquisition
acquisition_container_output
acquisition_copy_input
acquisition_input
acquisition_list_output
acquisition_modify_input
acquisition_node
acquisition_output
acquisition_parents
acquisition_template_options
acquisition_upsert_input
acquisition_upsert_output
action
adhoc_analysis_input
adjudication_batch_create
adjudication_decision
adjudication_decision_modify
adjudication_state
adjudication_task_create
adjudication_workflow
analysis
analysis_container_output
analysis_files_create_ticket_output
analysis_input
analysis_input_legacy
analysis_list_output
analysis_list_output_inflated_job
analysis_modify_input
analysis_node
analysis_output
analysis_output_inflated_job
analysis_parents
analysis_update
annotation_delete_reason
api_key_input_with_optional_label
api_key_output
as_storage
assignee
assignee_type
assistant_chat
audit_trail_report
audit_trail_report_status
auth0_auth_out
auth0_options_out
auth_out
auth_session_output
aws_creds
aws_storage
azure_creds
base_aet
base_compute
batch
batch_cancel_output
batch_create_filters
batch_job_analysis_input
batch_jobs_proposal_input
batch_proposal
batch_proposal_detail
batch_proposal_input
body
body_regenerate_key_api_devices_device_id_key_post
body_region
bookmark
bulk_move_input
bulk_move_sessions
callbacks_virus_scan_input
cancelled_batch_output
catalog_list_output
central_out
change
change_log_container_type
change_log_document
change_method
classic_batch_job_output
classic_batch_job_output_inflated_jobs
classic_batch_proposal_input
classic_batch_proposal_output
classification_add_delete
classification_replace
classification_update_input
cohort
collection
collection_container_output
collection_input
collection_input_with_contents
collection_node
collection_node_level
collection_operation
collection_operation_type
collection_output
collection_with_stats
column
column_type
common_classification
common_deleted_count
common_editions
common_info
common_join_origins
common_key
common_modified_count
common_object_created
common_project_settings
common_settings
complete_multipart_upload_output
complete_s3_multipart_upload_input
config_feature_map
config_out
config_output
config_site_config_output
config_site_settings
config_site_settings_input
conflict_types
container_delete_reason
container_filter
container_id_view_input
container_id_view_input_execute_and_save
container_modify
container_new_output
container_node_min
container_output
container_output_with_files
container_parents
container_pipeline_input
container_project_parents
container_reference
container_reference_with_label
container_session_parents
container_subject_parents
container_type
container_uidcheck
container_update
context_input
copy_filter
copy_status
core_models_api_key_api_key_input
core_models_audit_trail_create_report_input
core_models_audit_trail_modify_report_input
core_models_common_source
core_models_jobs_api_key_input
core_models_search_parent_type
core_workflows_form_responses_models_form_parents
core_workflows_form_responses_models_form_response_output
core_workflows_reader_models_reader_task_parents
creds
curator
current_user_output
custom_field
custom_form
cvat_info
cvat_settings
cvat_settings_input
cvat_sync_state
daily_report_usage
data_strategy
data_view
data_view_analysis_file_spec
data_view_analysis_filter_spec
data_view_column_alias
data_view_column_spec
data_view_execution
data_view_execution_state
data_view_file_spec
data_view_group_by
data_view_group_by_column
data_view_name_filter_spec
data_view_output
data_view_save_data_view_input
data_view_zip_filter_spec
default_flywheel_role
deid_log_skip_reason
delete_by_search_query
delete_status
deleted_file
deleted_result
deprecated_action
destination_container_type
device
device_admin_update
device_create
device_self_update
device_status
device_status_entry
device_storage_strategy_update
dimse_project_input
dimse_project_output
dimse_service_input
dimse_service_output
download
download_container_filter
download_container_filter_definition
download_filter
download_filter_definition
download_format
download_input
download_node
download_strategy
download_ticket
download_ticket_stub
download_ticket_with_summary
e_signature
edition
egress_device
egress_device_page
egress_provider
egress_provider_id
exchange_storage
executor_info
export_templates
features
field_change
field_change_log_document
field_type
file
file_browser_config
file_browser_scope
file_classification_delta
file_create_input
file_entry
file_export_templates
file_format
file_gear_info
file_group
file_list_output
file_modify_input
file_move_input
file_node
file_node_min
file_origin
file_output
file_parents
file_reference
file_suggestion
file_template_options
file_upsert_input
file_upsert_origin
file_upsert_output
file_version
file_version_copy_of
file_version_output
file_via
file_zip_entry
file_zip_info
filter
filter_input
filter_values
filter_view
fixed_file_version_input
fixed_input
form_definition
form_response_base
form_response_create
gcp_creds
gcp_storage
gear
gear_category
gear_config
gear_context_input
gear_context_lookup
gear_context_lookup_item
gear_context_value_output
gear_context_value_output_unfound
gear_custom
gear_directive
gear_doc
gear_document
gear_document_input
gear_document_legacy_input
gear_environment
gear_exchange
gear_file_input
gear_id_output
gear_info
gear_input_item
gear_inputs
gear_invocation
gear_key_input
gear_manifest
gear_mixin
gear_node
gear_output_configuration
gear_permissions
gear_permissions_input
gear_permissions_type
gear_return_ticket
gear_rule
gear_rule_condition
gear_rule_condition_type
gear_rule_input
gear_rule_modify_input
gear_rule_output
gear_save_submission
gear_series
gear_series_update
gear_suggestion_output
gear_ticket
gear_ticket_output
graph_filter
group
group_by
group_by_column
group_container_output
group_input
group_metadata_input
group_node
group_output
group_report
group_role
group_settings_output
group_update
header_feature
hierarchy_export_templates
http_validation_error
info
info_add_remove
info_container_type
info_replace
info_update_input
ingress_provider
ingress_providers
ingress_site_settings
ingress_update_provider
inline_response200
inline_response2001
inline_response2002
inline_response2003
inline_response2005
input_filter
input_job
input_job_profile
inserted_id
job
job_analysis_input
job_ask
job_ask_response
job_ask_response_job
job_ask_return
job_ask_return_criteria
job_ask_state
job_ask_state_response
job_complete
job_completion_input
job_completion_ticket
job_config
job_config_input
job_config_inputs
job_config_output
job_container_detail
job_destination
job_detail
job_detail_container
job_detail_file_entry
job_detail_group
job_detail_parent_info
job_executor_info
job_file_input
job_file_input_list_output
job_file_object
job_file_object_list_output
job_gear_match
job_inputs_array_item
job_inputs_item
job_inputs_object
job_list_entry
job_list_output
job_list_output_config
job_log
job_log_column
job_log_record
job_modify
job_origin
job_output
job_output_config
job_parents
job_priority
job_priority_update
job_profile
job_profile_input
job_request
job_request_item
job_request_item_type
job_request_target
job_state
job_state_counts
job_stats_by_state
job_ticket_output
job_transition_times
job_version_info
jobs_by_state
jobs_list
join_origin_device
join_origin_job
join_origin_user
join_origins
join_type
jupyterhub_workspace
jupyterlab_server_modify
jupyterlab_server_origin
jupyterlab_server_output
jupyterlab_server_response
jupyterlab_server_update
ldap_sync
ldap_sync_config
ldap_sync_input
ldap_sync_status
legacy_api_key_output
legacy_input
legacy_usage_report
legacys_usage_project_entry
libs_viewer_config_models_viewer_config
libs_workflows_models_parent_type
libs_workflows_models_task_status
local_storage
location
locked
master_subject_code_dob_input
master_subject_code_input
master_subject_code_output
matched_acquisition_output
matched_session_output
measurement_config
measurement_item_config
mfa_channel
mfa_settings
mixins
ml_set_filter
ml_type
modality
modality_input
modality_modify
modality_output
modified_result
modify_user_input
move_conflict
note
note_input
optional_input_policy
order
organ_system
origin
origin_type
orphaned_count
output_user_page
packfile_cleanup_output
packfile_removed_output
page
page_generic_file_output
page_generic_filter
page_generic_form_response_output
page_generic_reader_task_output
page_generic_staffing_pool
page_generic_union_generic_valid_protocol_generic_generic_wip_protocol_generic
page_generic_usage_summary_item
parsed_query_response
permission_access_permission
premade_jobs_batch_job_output
premade_jobs_batch_job_output_inflated_jobs
premade_jobs_batch_proposal
premade_jobs_batch_proposal_detail
premade_jobs_batch_proposal_input
project
project_acquisition_upsert_input
project_acquisition_upsert_output
project_aet
project_aet_input
project_catalog_list_output
project_contact
project_container_output
project_copy_input
project_copy_output
project_counters
project_delete_status_output
project_group_info
project_hierarchy_input
project_hierarchy_output
project_hierarchy_upsert_input
project_hierarchy_upsert_output
project_input
project_institution
project_list_output
project_locking_reason
project_modify
project_node
project_output
project_parents
project_report
project_report_list
project_session_upsert_input
project_session_upsert_output
project_settings_input
project_settings_output
project_settings_sharing
project_settings_sharing_input
project_settings_workspaces
project_settings_workspaces_input
project_share_level
project_sharing_settings_project_contact
project_sharing_settings_project_counters
project_sharing_settings_project_institution
project_sharing_settings_project_settings_input
project_sharing_settings_project_settings_output
project_sharing_settings_project_settings_sharing
project_sharing_settings_project_settings_sharing_input
project_sharing_settings_project_stats
project_stats
project_subject_upsert_input
project_subject_upsert_output
project_template
project_template_input
project_template_list_input
project_template_requirement
project_template_session_template
project_upsert_origin
protocol_e_signature_config
protocol_status
protocol_valid_input
protocol_valid_modify
protocol_wip_input
protocol_wip_modify
provider
provider_access_type
provider_class
provider_deletion_status
provider_input
provider_links
provider_type
providers
reader_batch_create
reader_task
reader_task_config
reader_task_create
reader_task_modify
reader_task_output
reader_task_parent_details
report_access_log_context
report_access_log_context_entry
report_access_log_context_file_entry
report_access_log_entry
report_access_log_origin
report_availability_list
report_daily_usage_entry
report_demographics_grid
report_ethnicity_grid
report_gender_count
report_group_report
report_legacy_usage_entry
report_legacy_usage_project_entry
report_project
report_site
report_time_period
report_usage
report_usage_entry
resolve_input
resolve_output
resolver_acquisition_node
resolver_analysis_node
resolver_file_node
resolver_gear_node
resolver_group_node
resolver_input
resolver_node
resolver_output
resolver_project_node
resolver_session_node
resolver_subject_node
role_input
role_output
role_permission
role_permission_output
role_permission_update
role_type
role_update
roles_backwards_compatible_role_assignment
roles_group_role_pool_input
roles_role
roles_role_assignment
roles_role_input
rule
rule_any
s3_addressing_style
s3_compat_storage
save_search
save_search_input
save_search_output
save_search_page
save_search_parent
save_search_update
search_acquisition_response
search_analysis_response
search_collection_response
search_file_response
search_group_response
search_parent_acquisition
search_parent_analysis
search_parent_collection
search_parent_project
search_parent_response
search_parent_session
search_parent_subject
search_parse_error
search_parse_search_query_result
search_project_response
search_query
search_query_suggestions
search_response
search_return_type
search_save_search
search_save_search_input
search_save_search_parent
search_save_search_update
search_session_response
search_status
search_structured_search_query
search_subject_response
search_suggestion
select_item
server_state
service_aet
service_aet_input
session
session_container_output
session_copy_input
session_embedded_subject
session_input
session_list_output
session_metadata_input
session_modify
session_node
session_output
session_parents
session_template_options
session_template_recalc_output
session_upsert_input
session_upsert_output
sharing_filter_options
signed_fs_upload_output
signed_url_cleanup_input
signed_url_upload_input
signed_url_upload_output
single_workflow
site
site_report
site_settings
sort
stable_api_key_input
staffing_pool
staffing_pool_create
staffing_pool_list
staffing_pool_modify
state
static_compute
status_transitions
status_type
status_value
storage_strategy
storage_strategy_config
structured_query
structured_query_suggestions
structured_query_value_suggestion
subject
subject_container_output
subject_copy_input
subject_input
subject_modify
subject_node
subject_output
subject_output_for_list
subject_parents
subject_role_permission
subject_state
subject_template_options
subject_upsert_input
subject_upsert_output
sync_user_input
tag
tag_match_mode
task_assign
task_facet
task_parent_ref
task_parent_ref_input
task_priority
task_submission
therapeutic_area
toolbar_config
transitions
tree_container_request_spec
tree_graph
tree_graph_connection
tree_graph_connections
tree_graph_node
tree_request
tree_response_item
trigger_field
type_str
uid_check_input_acquisitions
uid_check_input_sessions
uid_check_output
upload_complete_s3_multipart_input
upload_complete_s3_multipart_output
upload_signed_fs_file_upload_output
upload_signed_upload_url_input
upload_signed_upload_url_output
upload_ticket_output
upload_token_output
upsert_result
usage_summary_item
user
user_api_key
user_input
user_jobs
user_jobs_output
user_output
user_output_id
user_preferences
valid_protocol
validation_error
validation_rule
version
version_output
view_id_output
view_output
viewer_app
viewer_app_input
viewer_app_type
virus_scan
virus_scan_state
wip_protocol
work_in_progress_features
zipfile_info
zipfile_member_info
partial_reader
rest
util
view_builder
flywheel.models.common_editions
Back to top