flywheel-sdk 21.3.0rc0__py3-none-any.whl → 21.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flywheel/__init__.py +7 -8
- flywheel/api/acquisitions_api.py +1033 -569
- flywheel/api/analyses_api.py +786 -432
- flywheel/api/audit_trail_api.py +78 -51
- flywheel/api/auth_api.py +6 -11
- flywheel/api/batch_api.py +60 -43
- flywheel/api/bulk_api.py +10 -13
- flywheel/api/change_log_api.py +40 -29
- flywheel/api/collections_api.py +740 -410
- flywheel/api/config_api.py +18 -19
- flywheel/api/container_tasks_api.py +14 -15
- flywheel/api/container_type_api.py +14 -15
- flywheel/api/containers_api.py +989 -545
- flywheel/api/custom_filters_api.py +64 -43
- flywheel/api/data_view_executions_api.py +94 -59
- flywheel/api/dataexplorer_api.py +158 -99
- flywheel/api/devices_api.py +132 -83
- flywheel/api/dimse_api.py +72 -51
- flywheel/api/download_api.py +46 -32
- flywheel/api/files_api.py +266 -157
- flywheel/api/form_responses_api.py +100 -63
- flywheel/api/gears_api.py +278 -163
- flywheel/api/groups_api.py +426 -245
- flywheel/api/jobs_api.py +288 -173
- flywheel/api/jupyterlab_servers_api.py +24 -21
- flywheel/api/modalities_api.py +78 -51
- flywheel/api/packfiles_api.py +6 -11
- flywheel/api/projects_api.py +1661 -856
- flywheel/api/protocols_api.py +94 -61
- flywheel/api/reports_api.py +196 -115
- flywheel/api/resolve_api.py +48 -33
- flywheel/api/roles_api.py +82 -53
- flywheel/api/sessions_api.py +1137 -623
- flywheel/api/site_api.py +182 -113
- flywheel/api/staffing_pools_api.py +88 -57
- flywheel/api/subjects_api.py +1095 -603
- flywheel/api/tasks_api.py +108 -69
- flywheel/api/tree_api.py +52 -35
- flywheel/api/uids_api.py +10 -13
- flywheel/api/upload_api.py +162 -95
- flywheel/api/users_api.py +418 -235
- flywheel/api/views_api.py +222 -127
- flywheel/api_client.py +19 -18
- flywheel/configuration.py +2 -9
- flywheel/file_spec.py +0 -7
- flywheel/flywheel.py +818 -4423
- flywheel/gear_context.py +10 -10
- flywheel/models/__init__.py +7 -8
- flywheel/models/access_level.py +0 -7
- flywheel/models/access_permission.py +13 -14
- flywheel/models/access_permission_output.py +13 -14
- flywheel/models/access_permission_update.py +8 -11
- flywheel/models/access_type.py +0 -7
- flywheel/models/accumulator.py +0 -7
- flywheel/models/acquisition.py +0 -7
- flywheel/models/acquisition_container_output.py +0 -7
- flywheel/models/acquisition_copy_input.py +18 -17
- flywheel/models/acquisition_input.py +33 -26
- flywheel/models/acquisition_list_output.py +118 -77
- flywheel/models/acquisition_modify_input.py +33 -26
- flywheel/models/acquisition_node.py +0 -7
- flywheel/models/acquisition_output.py +118 -77
- flywheel/models/acquisition_parents.py +23 -20
- flywheel/models/acquisition_template_options.py +28 -23
- flywheel/models/acquisition_upsert_input.py +48 -35
- flywheel/models/acquisition_upsert_output.py +23 -20
- flywheel/models/action.py +1 -7
- flywheel/models/adhoc_analysis_input.py +23 -20
- flywheel/models/analysis.py +0 -7
- flywheel/models/analysis_container_output.py +0 -7
- flywheel/models/analysis_files_create_ticket_output.py +23 -20
- flywheel/models/analysis_input.py +33 -26
- flywheel/models/analysis_input_legacy.py +0 -7
- flywheel/models/analysis_list_output.py +103 -68
- flywheel/models/analysis_list_output_inflated_job.py +98 -65
- flywheel/models/analysis_modify_input.py +13 -14
- flywheel/models/analysis_node.py +0 -7
- flywheel/models/analysis_output.py +103 -68
- flywheel/models/analysis_output_inflated_job.py +103 -68
- flywheel/models/analysis_parents.py +28 -23
- flywheel/models/analysis_update.py +0 -7
- flywheel/models/api_key_input_with_optional_label.py +13 -14
- flywheel/models/api_key_output.py +33 -26
- flywheel/models/as_storage.py +33 -26
- flywheel/models/assignee.py +13 -14
- flywheel/models/assignee_type.py +0 -7
- flywheel/models/audit_trail_report.py +68 -47
- flywheel/models/audit_trail_report_status.py +0 -7
- flywheel/models/auth0_auth_out.py +38 -29
- flywheel/models/auth0_options_out.py +38 -29
- flywheel/models/auth_out.py +34 -82
- flywheel/models/auth_session_output.py +28 -23
- flywheel/models/avatars.py +18 -17
- flywheel/models/aws_creds.py +13 -14
- flywheel/models/aws_storage.py +43 -32
- flywheel/models/azure_creds.py +13 -14
- flywheel/models/base_aet.py +23 -20
- flywheel/models/base_compute.py +58 -41
- flywheel/models/batch.py +43 -32
- flywheel/models/batch_cancel_output.py +0 -7
- flywheel/models/batch_create_filters.py +18 -17
- flywheel/models/batch_job_analysis_input.py +28 -23
- flywheel/models/batch_jobs_proposal_input.py +0 -7
- flywheel/models/batch_proposal.py +0 -7
- flywheel/models/batch_proposal_detail.py +0 -7
- flywheel/models/batch_proposal_input.py +0 -7
- flywheel/models/body.py +0 -7
- flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
- flywheel/models/body_region.py +0 -7
- flywheel/models/bookmark.py +13 -14
- flywheel/models/bulk_move_input.py +28 -23
- flywheel/models/bulk_move_sessions.py +0 -7
- flywheel/models/callbacks_virus_scan_input.py +0 -7
- flywheel/models/cancelled_batch_output.py +8 -11
- flywheel/models/catalog_list_output.py +53 -38
- flywheel/models/central_out.py +33 -26
- flywheel/models/change.py +80 -39
- flywheel/models/change_log_container_type.py +0 -7
- flywheel/models/change_log_document.py +23 -20
- flywheel/models/change_method.py +1 -7
- flywheel/models/classic_batch_job_output.py +43 -32
- flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
- flywheel/models/classic_batch_proposal_input.py +48 -35
- flywheel/models/classic_batch_proposal_output.py +63 -44
- flywheel/models/classification_add_delete.py +0 -7
- flywheel/models/classification_replace.py +0 -7
- flywheel/models/classification_update_input.py +0 -7
- flywheel/models/cohort.py +0 -7
- flywheel/models/collection.py +0 -7
- flywheel/models/collection_container_output.py +0 -7
- flywheel/models/collection_input.py +18 -17
- flywheel/models/collection_input_with_contents.py +23 -20
- flywheel/models/collection_node.py +13 -14
- flywheel/models/collection_node_level.py +0 -7
- flywheel/models/collection_operation.py +13 -14
- flywheel/models/collection_operation_type.py +0 -7
- flywheel/models/collection_output.py +93 -62
- flywheel/models/collection_with_stats.py +93 -62
- flywheel/models/column.py +28 -23
- flywheel/models/column_type.py +0 -7
- flywheel/models/common_classification.py +3 -8
- flywheel/models/common_deleted_count.py +0 -7
- flywheel/models/common_editions.py +0 -7
- flywheel/models/common_info.py +3 -8
- flywheel/models/common_join_origins.py +0 -7
- flywheel/models/common_key.py +0 -7
- flywheel/models/common_modified_count.py +0 -7
- flywheel/models/common_object_created.py +0 -7
- flywheel/models/common_project_settings.py +0 -7
- flywheel/models/common_settings.py +0 -7
- flywheel/models/complete_multipart_upload_output.py +13 -14
- flywheel/models/complete_s3_multipart_upload_input.py +23 -20
- flywheel/models/config_feature_map.py +0 -7
- flywheel/models/config_out.py +48 -35
- flywheel/models/config_output.py +0 -7
- flywheel/models/config_site_config_output.py +0 -7
- flywheel/models/config_site_settings.py +0 -7
- flywheel/models/config_site_settings_input.py +0 -7
- flywheel/models/conflict_types.py +0 -7
- flywheel/models/container_delete_reason.py +0 -7
- flywheel/models/container_filter.py +13 -14
- flywheel/models/container_id_view_input.py +73 -50
- flywheel/models/container_id_view_input_execute_and_save.py +33 -26
- flywheel/models/container_modify.py +73 -50
- flywheel/models/container_new_output.py +0 -7
- flywheel/models/container_node_min.py +43 -32
- flywheel/models/container_output.py +0 -7
- flywheel/models/container_output_with_files.py +28 -23
- flywheel/models/container_parents.py +33 -26
- flywheel/models/container_pipeline_input.py +73 -50
- flywheel/models/container_project_parents.py +0 -7
- flywheel/models/container_reference.py +13 -14
- flywheel/models/container_reference_with_label.py +18 -17
- flywheel/models/container_session_parents.py +0 -7
- flywheel/models/container_subject_parents.py +0 -7
- flywheel/models/container_type.py +2 -7
- flywheel/models/container_uidcheck.py +23 -20
- flywheel/models/container_update.py +3 -8
- flywheel/models/context_input.py +18 -17
- flywheel/models/copy_filter.py +33 -26
- flywheel/models/copy_status.py +0 -7
- flywheel/models/core_models_api_key_api_key_input.py +13 -14
- flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
- flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
- flywheel/models/core_models_common_source.py +13 -14
- flywheel/models/core_models_jobs_api_key_input.py +13 -14
- flywheel/models/core_models_search_parent_type.py +0 -7
- flywheel/models/core_workflows_form_responses_models_form_parents.py +157 -15
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
- flywheel/models/creds.py +3 -8
- flywheel/models/curator.py +18 -17
- flywheel/models/current_user_output.py +108 -71
- flywheel/models/custom_field.py +61 -44
- flywheel/models/custom_form.py +23 -20
- flywheel/models/cvat_info.py +28 -23
- flywheel/models/cvat_settings.py +28 -23
- flywheel/models/cvat_settings_input.py +28 -23
- flywheel/models/cvat_sync_state.py +0 -7
- flywheel/models/daily_report_usage.py +78 -53
- flywheel/models/data_strategy.py +0 -7
- flywheel/models/data_view.py +0 -7
- flywheel/models/data_view_analysis_file_spec.py +18 -17
- flywheel/models/data_view_analysis_filter_spec.py +18 -17
- flywheel/models/data_view_column_alias.py +38 -29
- flywheel/models/data_view_column_spec.py +28 -23
- flywheel/models/data_view_execution.py +68 -47
- flywheel/models/data_view_execution_state.py +0 -7
- flywheel/models/data_view_file_spec.py +48 -35
- flywheel/models/data_view_group_by.py +8 -11
- flywheel/models/data_view_group_by_column.py +13 -14
- flywheel/models/data_view_name_filter_spec.py +13 -14
- flywheel/models/data_view_output.py +0 -7
- flywheel/models/data_view_save_data_view_input.py +0 -7
- flywheel/models/data_view_zip_filter_spec.py +18 -17
- flywheel/models/default_flywheel_role.py +0 -7
- flywheel/models/deid_log_skip_reason.py +0 -7
- flywheel/models/delete_by_search_query.py +23 -20
- flywheel/models/delete_status.py +25 -0
- flywheel/models/deleted_file.py +73 -50
- flywheel/models/deleted_result.py +50 -19
- flywheel/models/deprecated_action.py +0 -7
- flywheel/models/destination_container_type.py +0 -7
- flywheel/models/device.py +58 -41
- flywheel/models/device_admin_update.py +13 -14
- flywheel/models/device_create.py +18 -17
- flywheel/models/device_self_update.py +28 -23
- flywheel/models/device_status.py +0 -7
- flywheel/models/device_status_entry.py +18 -17
- flywheel/models/device_storage_strategy_update.py +13 -14
- flywheel/models/dimse_project_input.py +0 -7
- flywheel/models/dimse_project_output.py +0 -7
- flywheel/models/dimse_service_input.py +0 -7
- flywheel/models/dimse_service_output.py +0 -7
- flywheel/models/download.py +23 -20
- flywheel/models/download_container_filter.py +8 -11
- flywheel/models/download_container_filter_definition.py +18 -17
- flywheel/models/download_filter.py +18 -17
- flywheel/models/download_filter_definition.py +13 -14
- flywheel/models/download_format.py +0 -7
- flywheel/models/download_input.py +0 -7
- flywheel/models/download_node.py +13 -14
- flywheel/models/download_strategy.py +0 -7
- flywheel/models/download_ticket.py +0 -7
- flywheel/models/download_ticket_stub.py +23 -20
- flywheel/models/download_ticket_with_summary.py +0 -7
- flywheel/models/e_signature.py +23 -20
- flywheel/models/edition.py +8 -11
- flywheel/models/egress_device.py +88 -59
- flywheel/models/egress_device_page.py +18 -17
- flywheel/models/egress_provider.py +53 -38
- flywheel/models/egress_provider_id.py +8 -11
- flywheel/models/exchange_storage.py +23 -20
- flywheel/models/executor_info.py +43 -32
- flywheel/models/export_templates.py +13 -14
- flywheel/models/features.py +457 -307
- flywheel/models/field_change.py +28 -23
- flywheel/models/field_change_log_document.py +23 -20
- flywheel/models/field_type.py +0 -7
- flywheel/models/file.py +188 -119
- flywheel/models/file_classification_delta.py +23 -20
- flywheel/models/file_container_type.py +0 -7
- flywheel/models/file_entry.py +108 -71
- flywheel/models/file_export_templates.py +28 -23
- flywheel/models/file_format.py +0 -7
- flywheel/models/file_gear_info.py +18 -17
- flywheel/models/file_group.py +0 -7
- flywheel/models/file_list_output.py +183 -116
- flywheel/models/file_modify_input.py +13 -14
- flywheel/models/file_move_input.py +18 -17
- flywheel/models/file_node.py +188 -119
- flywheel/models/file_node_min.py +38 -29
- flywheel/models/file_origin.py +28 -23
- flywheel/models/file_output.py +183 -116
- flywheel/models/file_parents.py +33 -26
- flywheel/models/file_reference.py +18 -17
- flywheel/models/file_suggestion.py +23 -20
- flywheel/models/file_template_options.py +33 -26
- flywheel/models/file_upsert_input.py +88 -59
- flywheel/models/file_upsert_origin.py +0 -7
- flywheel/models/file_upsert_output.py +188 -119
- flywheel/models/file_version.py +13 -14
- flywheel/models/file_version_copy_of.py +28 -23
- flywheel/models/file_version_output.py +38 -29
- flywheel/models/file_via.py +23 -20
- flywheel/models/file_zip_entry.py +0 -7
- flywheel/models/file_zip_info.py +0 -7
- flywheel/models/filter.py +43 -32
- flywheel/models/filter_input.py +18 -17
- flywheel/models/filter_values.py +13 -14
- flywheel/models/filter_view.py +0 -7
- flywheel/models/fixed_file_version_input.py +18 -17
- flywheel/models/fixed_input.py +33 -26
- flywheel/models/form_definition.py +8 -11
- flywheel/models/form_response_base.py +33 -26
- flywheel/models/form_response_create.py +13 -14
- flywheel/models/gcp_creds.py +53 -38
- flywheel/models/gcp_storage.py +33 -26
- flywheel/models/gear.py +88 -59
- flywheel/models/gear_category.py +0 -7
- flywheel/models/gear_config.py +3 -8
- flywheel/models/gear_context_input.py +8 -11
- flywheel/models/gear_context_lookup.py +0 -7
- flywheel/models/gear_context_lookup_item.py +0 -7
- flywheel/models/gear_context_value_output.py +28 -23
- flywheel/models/gear_context_value_output_unfound.py +8 -11
- flywheel/models/gear_custom.py +3 -8
- flywheel/models/gear_directive.py +3 -8
- flywheel/models/gear_doc.py +0 -7
- flywheel/models/gear_document.py +38 -29
- flywheel/models/gear_document_input.py +33 -26
- flywheel/models/gear_document_legacy_input.py +33 -26
- flywheel/models/gear_environment.py +3 -8
- flywheel/models/gear_exchange.py +18 -17
- flywheel/models/gear_file_input.py +13 -14
- flywheel/models/gear_id_output.py +8 -11
- flywheel/models/gear_info.py +23 -20
- flywheel/models/gear_input_item.py +18 -17
- flywheel/models/gear_inputs.py +3 -8
- flywheel/models/gear_key_input.py +13 -14
- flywheel/models/gear_manifest.py +93 -62
- flywheel/models/gear_mixin.py +26 -6
- flywheel/models/gear_node.py +43 -32
- flywheel/models/gear_output_configuration.py +8 -11
- flywheel/models/gear_permissions.py +13 -14
- flywheel/models/gear_permissions_input.py +8 -11
- flywheel/models/gear_permissions_type.py +0 -7
- flywheel/models/gear_return_ticket.py +0 -7
- flywheel/models/gear_rule.py +133 -69
- flywheel/models/gear_rule_condition.py +18 -17
- flywheel/models/gear_rule_condition_type.py +0 -7
- flywheel/models/gear_rule_input.py +108 -54
- flywheel/models/gear_rule_modify_input.py +103 -51
- flywheel/models/gear_rule_output.py +133 -69
- flywheel/models/gear_save_submission.py +18 -17
- flywheel/models/gear_series.py +33 -26
- flywheel/models/gear_series_update.py +8 -11
- flywheel/models/gear_suggestion_output.py +33 -26
- flywheel/models/gear_ticket.py +23 -20
- flywheel/models/gear_ticket_output.py +8 -11
- flywheel/models/graph_filter.py +38 -29
- flywheel/models/group.py +0 -7
- flywheel/models/group_by.py +8 -11
- flywheel/models/group_by_column.py +0 -7
- flywheel/models/group_container_output.py +0 -7
- flywheel/models/group_input.py +23 -20
- flywheel/models/group_metadata_input.py +0 -7
- flywheel/models/group_node.py +0 -7
- flywheel/models/group_output.py +63 -44
- flywheel/models/group_report.py +18 -17
- flywheel/models/group_role.py +8 -11
- flywheel/models/group_settings_output.py +23 -20
- flywheel/models/group_update.py +23 -20
- flywheel/models/header_feature.py +0 -7
- flywheel/models/hierarchy_export_templates.py +28 -23
- flywheel/models/http_validation_error.py +8 -11
- flywheel/models/info.py +18 -17
- flywheel/models/info_add_remove.py +0 -7
- flywheel/models/info_container_type.py +0 -7
- flywheel/models/info_replace.py +0 -7
- flywheel/models/info_update_input.py +0 -7
- flywheel/models/ingress_provider.py +33 -26
- flywheel/models/ingress_providers.py +28 -23
- flywheel/models/ingress_site_settings.py +29 -52
- flywheel/models/ingress_update_provider.py +18 -17
- flywheel/models/inline_response200.py +8 -11
- flywheel/models/inline_response2001.py +8 -11
- flywheel/models/inline_response2002.py +8 -11
- flywheel/models/inline_response2003.py +0 -7
- flywheel/models/inline_response2005.py +0 -7
- flywheel/models/input_filter.py +18 -17
- flywheel/models/input_job.py +73 -50
- flywheel/models/input_job_profile.py +28 -23
- flywheel/models/inserted_id.py +8 -11
- flywheel/models/job.py +128 -83
- flywheel/models/job_analysis_input.py +28 -23
- flywheel/models/job_ask.py +33 -26
- flywheel/models/job_ask_response.py +13 -14
- flywheel/models/job_ask_response_job.py +158 -101
- flywheel/models/job_ask_return.py +0 -7
- flywheel/models/job_ask_return_criteria.py +23 -20
- flywheel/models/job_ask_state.py +0 -7
- flywheel/models/job_ask_state_response.py +8 -11
- flywheel/models/job_complete.py +18 -17
- flywheel/models/job_completion_input.py +0 -7
- flywheel/models/job_completion_ticket.py +0 -7
- flywheel/models/job_config.py +3 -8
- flywheel/models/job_config_input.py +28 -23
- flywheel/models/job_config_inputs.py +0 -7
- flywheel/models/job_config_output.py +0 -7
- flywheel/models/job_container_detail.py +0 -7
- flywheel/models/job_destination.py +13 -14
- flywheel/models/job_detail.py +148 -95
- flywheel/models/job_detail_container.py +13 -14
- flywheel/models/job_detail_file_entry.py +13 -14
- flywheel/models/job_detail_group.py +13 -14
- flywheel/models/job_detail_parent_info.py +33 -26
- flywheel/models/job_executor_info.py +43 -32
- flywheel/models/job_file_input.py +23 -20
- flywheel/models/job_file_input_list_output.py +23 -20
- flywheel/models/job_file_object.py +58 -41
- flywheel/models/job_file_object_list_output.py +53 -38
- flywheel/models/job_gear_match.py +0 -7
- flywheel/models/job_inputs_array_item.py +33 -26
- flywheel/models/job_inputs_item.py +23 -20
- flywheel/models/job_inputs_object.py +3 -8
- flywheel/models/job_list_entry.py +0 -7
- flywheel/models/job_list_output.py +158 -101
- flywheel/models/job_list_output_config.py +18 -17
- flywheel/models/job_log.py +13 -14
- flywheel/models/job_log_column.py +0 -7
- flywheel/models/job_log_record.py +13 -14
- flywheel/models/job_modify.py +13 -14
- flywheel/models/job_origin.py +13 -14
- flywheel/models/job_output.py +163 -104
- flywheel/models/job_output_config.py +23 -20
- flywheel/models/job_parents.py +33 -26
- flywheel/models/job_priority.py +0 -7
- flywheel/models/job_priority_update.py +13 -14
- flywheel/models/job_profile.py +53 -38
- flywheel/models/job_profile_input.py +0 -7
- flywheel/models/job_request.py +18 -17
- flywheel/models/job_request_item.py +23 -20
- flywheel/models/job_request_item_type.py +0 -7
- flywheel/models/job_request_target.py +28 -23
- flywheel/models/job_state.py +0 -7
- flywheel/models/job_state_counts.py +0 -7
- flywheel/models/job_stats_by_state.py +0 -7
- flywheel/models/job_ticket_output.py +8 -11
- flywheel/models/job_transition_times.py +23 -20
- flywheel/models/job_version_info.py +3 -8
- flywheel/models/jobs_by_state.py +28 -23
- flywheel/models/jobs_list.py +8 -11
- flywheel/models/join_origin_device.py +8 -11
- flywheel/models/join_origin_job.py +18 -17
- flywheel/models/join_origin_user.py +13 -14
- flywheel/models/join_origins.py +18 -17
- flywheel/models/join_type.py +0 -7
- flywheel/models/jupyterhub_workspace.py +8 -11
- flywheel/models/jupyterlab_server_modify.py +28 -23
- flywheel/models/jupyterlab_server_origin.py +0 -7
- flywheel/models/jupyterlab_server_output.py +0 -7
- flywheel/models/jupyterlab_server_response.py +53 -38
- flywheel/models/jupyterlab_server_update.py +0 -7
- flywheel/models/ldap_sync.py +0 -7
- flywheel/models/ldap_sync_config.py +8 -11
- flywheel/models/ldap_sync_input.py +0 -7
- flywheel/models/ldap_sync_status.py +23 -20
- flywheel/models/legacy_api_key_output.py +28 -23
- flywheel/models/legacy_input.py +23 -20
- flywheel/models/legacy_usage_report.py +33 -26
- flywheel/models/legacys_usage_project_entry.py +13 -14
- flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
- flywheel/models/libs_workflows_models_parent_type.py +0 -7
- flywheel/models/libs_workflows_models_task_status.py +0 -7
- flywheel/models/local_storage.py +18 -17
- flywheel/models/location.py +13 -14
- flywheel/models/locked.py +18 -17
- flywheel/models/master_subject_code_dob_input.py +28 -23
- flywheel/models/master_subject_code_input.py +28 -23
- flywheel/models/master_subject_code_output.py +8 -11
- flywheel/models/matched_acquisition_output.py +73 -50
- flywheel/models/measurement_config.py +222 -0
- flywheel/models/measurement_item_config.py +217 -0
- flywheel/models/mfa_channel.py +0 -7
- flywheel/models/mfa_settings.py +8 -11
- flywheel/models/ml_set_filter.py +13 -14
- flywheel/models/ml_type.py +0 -7
- flywheel/models/modality.py +23 -20
- flywheel/models/modality_input.py +23 -20
- flywheel/models/modality_modify.py +18 -17
- flywheel/models/modality_output.py +28 -23
- flywheel/models/modified_result.py +13 -14
- flywheel/models/modify_user_input.py +63 -44
- flywheel/models/move_conflict.py +33 -26
- flywheel/models/note.py +48 -35
- flywheel/models/note_input.py +8 -11
- flywheel/models/optional_input_policy.py +0 -7
- flywheel/models/order.py +0 -7
- flywheel/models/organ_system.py +0 -7
- flywheel/models/origin.py +13 -14
- flywheel/models/origin_type.py +0 -7
- flywheel/models/orphaned_count.py +8 -11
- flywheel/models/output_user_page.py +18 -17
- flywheel/models/packfile_cleanup_output.py +8 -11
- flywheel/models/packfile_removed_output.py +13 -14
- flywheel/models/page.py +18 -17
- flywheel/models/page_generic_file_output.py +18 -17
- flywheel/models/page_generic_filter.py +18 -17
- flywheel/models/page_generic_form_response_output.py +18 -17
- flywheel/models/page_generic_protocol.py +23 -20
- flywheel/models/page_generic_reader_task_output.py +23 -20
- flywheel/models/page_generic_staffing_pool.py +23 -20
- flywheel/models/parsed_query_response.py +13 -14
- flywheel/models/permission_access_permission.py +0 -7
- flywheel/models/premade_jobs_batch_job_output.py +33 -26
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
- flywheel/models/premade_jobs_batch_proposal.py +38 -29
- flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
- flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
- flywheel/models/project.py +0 -7
- flywheel/models/project_acquisition_upsert_input.py +0 -7
- flywheel/models/project_acquisition_upsert_output.py +0 -7
- flywheel/models/project_aet.py +38 -29
- flywheel/models/project_aet_input.py +23 -20
- flywheel/models/project_catalog_list_output.py +0 -7
- flywheel/models/project_contact.py +13 -14
- flywheel/models/project_container_output.py +2 -7
- flywheel/models/project_copy_input.py +23 -20
- flywheel/models/project_copy_output.py +18 -17
- flywheel/models/project_counters.py +76 -36
- flywheel/models/project_delete_status_output.py +192 -0
- flywheel/models/project_group_info.py +189 -0
- flywheel/models/project_hierarchy_input.py +28 -23
- flywheel/models/project_hierarchy_output.py +18 -17
- flywheel/models/project_hierarchy_upsert_input.py +0 -7
- flywheel/models/project_hierarchy_upsert_output.py +0 -7
- flywheel/models/project_input.py +48 -35
- flywheel/models/project_institution.py +13 -14
- flywheel/models/project_list_output.py +234 -93
- flywheel/models/project_locking_reason.py +0 -7
- flywheel/models/project_modify.py +116 -42
- flywheel/models/project_node.py +2 -7
- flywheel/models/project_output.py +235 -93
- flywheel/models/project_parents.py +8 -11
- flywheel/models/project_report.py +63 -44
- flywheel/models/project_report_list.py +8 -11
- flywheel/models/project_session_upsert_input.py +0 -7
- flywheel/models/project_session_upsert_output.py +0 -7
- flywheel/models/project_settings_input.py +38 -29
- flywheel/models/project_settings_output.py +38 -29
- flywheel/models/project_settings_sharing.py +38 -29
- flywheel/models/project_settings_sharing_input.py +38 -29
- flywheel/models/project_settings_workspaces.py +8 -11
- flywheel/models/project_settings_workspaces_input.py +8 -11
- flywheel/models/project_share_level.py +0 -7
- flywheel/models/project_sharing_settings_project_contact.py +0 -7
- flywheel/models/project_sharing_settings_project_counters.py +0 -7
- flywheel/models/project_sharing_settings_project_institution.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
- flywheel/models/project_sharing_settings_project_stats.py +0 -7
- flywheel/models/project_stats.py +28 -23
- flywheel/models/project_subject_upsert_input.py +0 -7
- flywheel/models/project_subject_upsert_output.py +0 -7
- flywheel/models/project_template.py +13 -14
- flywheel/models/project_template_input.py +13 -14
- flywheel/models/project_template_list_input.py +8 -11
- flywheel/models/project_template_requirement.py +0 -7
- flywheel/models/project_template_session_template.py +0 -7
- flywheel/models/project_upsert_origin.py +0 -7
- flywheel/models/protocol.py +78 -53
- flywheel/models/protocol_e_signature_config.py +13 -14
- flywheel/models/protocol_input.py +43 -32
- flywheel/models/protocol_modify.py +28 -23
- flywheel/models/protocol_status.py +0 -7
- flywheel/models/provider.py +63 -44
- flywheel/models/provider_access_type.py +0 -7
- flywheel/models/provider_class.py +0 -7
- flywheel/models/provider_deletion_status.py +13 -14
- flywheel/models/provider_input.py +0 -7
- flywheel/models/provider_links.py +28 -23
- flywheel/models/provider_type.py +0 -7
- flywheel/models/providers.py +28 -23
- flywheel/models/reader_batch_create.py +63 -44
- flywheel/models/reader_task.py +113 -74
- flywheel/models/reader_task_config.py +49 -18
- flywheel/models/reader_task_create.py +78 -53
- flywheel/models/reader_task_modify.py +33 -26
- flywheel/models/reader_task_output.py +118 -77
- flywheel/models/reader_task_parent_details.py +38 -29
- flywheel/models/report_access_log_context.py +33 -26
- flywheel/models/report_access_log_context_entry.py +13 -14
- flywheel/models/report_access_log_context_file_entry.py +8 -11
- flywheel/models/report_access_log_entry.py +88 -59
- flywheel/models/report_access_log_origin.py +13 -14
- flywheel/models/report_availability_list.py +8 -11
- flywheel/models/report_daily_usage_entry.py +68 -47
- flywheel/models/report_demographics_grid.py +0 -7
- flywheel/models/report_ethnicity_grid.py +23 -20
- flywheel/models/report_gender_count.py +18 -17
- flywheel/models/report_group_report.py +18 -17
- flywheel/models/report_legacy_usage_entry.py +0 -7
- flywheel/models/report_legacy_usage_project_entry.py +0 -7
- flywheel/models/report_project.py +0 -7
- flywheel/models/report_site.py +13 -14
- flywheel/models/report_time_period.py +13 -14
- flywheel/models/report_usage.py +88 -59
- flywheel/models/report_usage_entry.py +0 -7
- flywheel/models/resolve_input.py +8 -11
- flywheel/models/resolve_output.py +13 -14
- flywheel/models/resolver_acquisition_node.py +0 -7
- flywheel/models/resolver_analysis_node.py +0 -7
- flywheel/models/resolver_file_node.py +0 -7
- flywheel/models/resolver_gear_node.py +0 -7
- flywheel/models/resolver_group_node.py +0 -7
- flywheel/models/resolver_input.py +0 -7
- flywheel/models/resolver_node.py +8 -11
- flywheel/models/resolver_output.py +0 -7
- flywheel/models/resolver_project_node.py +0 -7
- flywheel/models/resolver_session_node.py +0 -7
- flywheel/models/resolver_subject_node.py +0 -7
- flywheel/models/role_input.py +13 -14
- flywheel/models/role_output.py +28 -23
- flywheel/models/role_permission.py +13 -14
- flywheel/models/role_permission_output.py +13 -14
- flywheel/models/role_permission_update.py +8 -11
- flywheel/models/role_type.py +0 -7
- flywheel/models/role_update.py +13 -14
- flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
- flywheel/models/roles_group_role_pool_input.py +0 -7
- flywheel/models/roles_role.py +0 -7
- flywheel/models/roles_role_assignment.py +13 -14
- flywheel/models/roles_role_input.py +0 -7
- flywheel/models/rule.py +63 -44
- flywheel/models/rule_any.py +18 -17
- flywheel/models/s3_addressing_style.py +0 -7
- flywheel/models/s3_compat_storage.py +48 -35
- flywheel/models/save_search.py +33 -26
- flywheel/models/save_search_input.py +18 -17
- flywheel/models/save_search_output.py +33 -26
- flywheel/models/save_search_page.py +18 -17
- flywheel/models/save_search_parent.py +13 -14
- flywheel/models/save_search_update.py +13 -14
- flywheel/models/search_acquisition_response.py +23 -20
- flywheel/models/search_analysis_response.py +23 -20
- flywheel/models/search_collection_response.py +23 -20
- flywheel/models/search_file_response.py +33 -26
- flywheel/models/search_group_response.py +13 -14
- flywheel/models/search_parent_acquisition.py +0 -7
- flywheel/models/search_parent_analysis.py +0 -7
- flywheel/models/search_parent_collection.py +0 -7
- flywheel/models/search_parent_project.py +2 -7
- flywheel/models/search_parent_response.py +13 -14
- flywheel/models/search_parent_session.py +0 -7
- flywheel/models/search_parent_subject.py +0 -7
- flywheel/models/search_parse_error.py +23 -20
- flywheel/models/search_parse_search_query_result.py +0 -7
- flywheel/models/search_project_response.py +13 -14
- flywheel/models/search_query.py +38 -29
- flywheel/models/search_query_suggestions.py +0 -7
- flywheel/models/search_response.py +58 -41
- flywheel/models/search_return_type.py +0 -7
- flywheel/models/search_save_search.py +0 -7
- flywheel/models/search_save_search_input.py +0 -7
- flywheel/models/search_save_search_parent.py +0 -7
- flywheel/models/search_save_search_update.py +0 -7
- flywheel/models/search_session_response.py +23 -20
- flywheel/models/search_status.py +8 -11
- flywheel/models/search_structured_search_query.py +0 -7
- flywheel/models/search_subject_response.py +18 -17
- flywheel/models/search_suggestion.py +0 -7
- flywheel/models/select_item.py +13 -14
- flywheel/models/server_state.py +33 -26
- flywheel/models/service_aet.py +33 -26
- flywheel/models/service_aet_input.py +28 -23
- flywheel/models/session.py +0 -7
- flywheel/models/session_container_output.py +0 -7
- flywheel/models/session_copy_input.py +23 -20
- flywheel/models/session_embedded_subject.py +33 -26
- flywheel/models/session_input.py +58 -41
- flywheel/models/session_list_output.py +143 -92
- flywheel/models/session_metadata_input.py +0 -7
- flywheel/models/session_modify.py +63 -44
- flywheel/models/session_node.py +0 -7
- flywheel/models/session_output.py +143 -92
- flywheel/models/session_parents.py +18 -17
- flywheel/models/session_template_options.py +18 -17
- flywheel/models/session_template_recalc_output.py +8 -11
- flywheel/models/session_upsert_input.py +63 -44
- flywheel/models/session_upsert_output.py +23 -20
- flywheel/models/sharing_filter_options.py +43 -32
- flywheel/models/signed_fs_upload_output.py +13 -14
- flywheel/models/signed_url_cleanup_input.py +13 -14
- flywheel/models/signed_url_upload_input.py +13 -14
- flywheel/models/signed_url_upload_output.py +43 -32
- flywheel/models/site.py +93 -62
- flywheel/models/site_report.py +13 -14
- flywheel/models/site_settings.py +48 -35
- flywheel/models/sort.py +13 -14
- flywheel/models/stable_api_key_input.py +0 -7
- flywheel/models/staffing_pool.py +38 -29
- flywheel/models/staffing_pool_create.py +18 -17
- flywheel/models/staffing_pool_list.py +8 -11
- flywheel/models/staffing_pool_modify.py +18 -17
- flywheel/models/state.py +0 -7
- flywheel/models/static_compute.py +18 -17
- flywheel/models/status_transitions.py +23 -20
- flywheel/models/status_type.py +0 -7
- flywheel/models/status_value.py +0 -7
- flywheel/models/storage_strategy.py +0 -7
- flywheel/models/storage_strategy_config.py +13 -14
- flywheel/models/structured_query.py +8 -11
- flywheel/models/structured_query_suggestions.py +13 -14
- flywheel/models/structured_query_value_suggestion.py +23 -20
- flywheel/models/subject.py +0 -7
- flywheel/models/subject_container_output.py +0 -7
- flywheel/models/subject_copy_input.py +18 -17
- flywheel/models/subject_input.py +93 -62
- flywheel/models/subject_modify.py +103 -68
- flywheel/models/subject_node.py +0 -7
- flywheel/models/subject_output.py +163 -104
- flywheel/models/subject_output_for_list.py +163 -104
- flywheel/models/subject_parents.py +13 -14
- flywheel/models/subject_role_permission.py +13 -14
- flywheel/models/subject_state.py +0 -7
- flywheel/models/subject_template_options.py +13 -14
- flywheel/models/subject_upsert_input.py +83 -56
- flywheel/models/subject_upsert_output.py +18 -17
- flywheel/models/sync_user_input.py +38 -29
- flywheel/models/tag.py +8 -11
- flywheel/models/task_assign.py +13 -14
- flywheel/models/task_facet.py +0 -7
- flywheel/models/task_parent_ref.py +23 -20
- flywheel/models/task_parent_ref_input.py +18 -17
- flywheel/models/task_priority.py +0 -7
- flywheel/models/task_submission.py +13 -14
- flywheel/models/therapeutic_area.py +0 -7
- flywheel/models/toolbar_config.py +161 -0
- flywheel/models/transitions.py +28 -23
- flywheel/models/tree_container_request_spec.py +28 -23
- flywheel/models/tree_graph.py +3 -8
- flywheel/models/tree_graph_connection.py +23 -20
- flywheel/models/tree_graph_connections.py +3 -8
- flywheel/models/tree_graph_node.py +8 -11
- flywheel/models/tree_request.py +0 -7
- flywheel/models/tree_response_item.py +3 -8
- flywheel/models/type_str.py +0 -7
- flywheel/models/uid_check_input_acquisitions.py +23 -20
- flywheel/models/uid_check_input_sessions.py +23 -20
- flywheel/models/uid_check_output.py +13 -14
- flywheel/models/upload_complete_s3_multipart_input.py +0 -7
- flywheel/models/upload_complete_s3_multipart_output.py +0 -7
- flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
- flywheel/models/upload_signed_upload_url_input.py +0 -7
- flywheel/models/upload_signed_upload_url_output.py +0 -7
- flywheel/models/upload_ticket_output.py +18 -17
- flywheel/models/upload_token_output.py +8 -11
- flywheel/models/upsert_result.py +0 -7
- flywheel/models/user.py +113 -74
- flywheel/models/user_api_key.py +18 -17
- flywheel/models/user_input.py +63 -44
- flywheel/models/user_jobs.py +18 -17
- flywheel/models/user_jobs_output.py +0 -7
- flywheel/models/user_output.py +0 -7
- flywheel/models/user_output_id.py +8 -11
- flywheel/models/user_preferences.py +3 -8
- flywheel/models/user_wechat.py +3 -8
- flywheel/models/validation_error.py +18 -17
- flywheel/models/validation_rule.py +13 -14
- flywheel/models/version.py +43 -32
- flywheel/models/version_output.py +0 -7
- flywheel/models/view_id_output.py +8 -11
- flywheel/models/view_output.py +58 -41
- flywheel/models/viewer_app.py +48 -35
- flywheel/models/viewer_app_input.py +48 -35
- flywheel/models/viewer_app_type.py +0 -7
- flywheel/models/virus_scan.py +8 -11
- flywheel/models/virus_scan_state.py +0 -7
- flywheel/models/work_in_progress_features.py +3 -8
- flywheel/models/zipfile_info.py +13 -14
- flywheel/models/zipfile_member_info.py +23 -20
- flywheel/partial_reader.py +0 -7
- flywheel/rest.py +0 -7
- flywheel/view_builder.py +2 -1
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
- flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +1 -1
- flywheel/models/google_auth_out.py +0 -299
- flywheel_sdk-21.3.0rc0.dist-info/RECORD +0 -772
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
flywheel/api/sessions_api.py
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
Flywheel
|
|
5
|
-
|
|
6
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
|
|
7
|
-
|
|
8
|
-
OpenAPI spec version: 0.0.1
|
|
9
|
-
|
|
10
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
4
|
"""
|
|
12
5
|
|
|
13
6
|
|
|
@@ -37,9 +30,11 @@ class SessionsApi(object):
|
|
|
37
30
|
Create a session.
|
|
38
31
|
This method makes a synchronous HTTP request by default.
|
|
39
32
|
|
|
40
|
-
:param
|
|
41
|
-
:
|
|
42
|
-
:
|
|
33
|
+
:param body:
|
|
34
|
+
:type body: SessionInput
|
|
35
|
+
:param async_: Perform the request asynchronously
|
|
36
|
+
:type async_: bool, optional
|
|
37
|
+
:rtype: InsertedId
|
|
43
38
|
"""
|
|
44
39
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
45
40
|
kwargs['_return_http_data_only'] = True
|
|
@@ -63,9 +58,11 @@ class SessionsApi(object):
|
|
|
63
58
|
Create a session.
|
|
64
59
|
This method makes a synchronous HTTP request by default.
|
|
65
60
|
|
|
66
|
-
:param
|
|
67
|
-
:
|
|
68
|
-
:
|
|
61
|
+
:param body:
|
|
62
|
+
:type body: SessionInput
|
|
63
|
+
:param async_: Perform the request asynchronously
|
|
64
|
+
:type async_: bool, optional
|
|
65
|
+
:rtype: InsertedId
|
|
69
66
|
"""
|
|
70
67
|
|
|
71
68
|
all_params = ['body',] # noqa: E501
|
|
@@ -145,12 +142,15 @@ class SessionsApi(object):
|
|
|
145
142
|
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
146
143
|
This method makes a synchronous HTTP request by default.
|
|
147
144
|
|
|
148
|
-
:param
|
|
149
|
-
:
|
|
150
|
-
:param
|
|
151
|
-
:
|
|
152
|
-
:param
|
|
153
|
-
:
|
|
145
|
+
:param cid:
|
|
146
|
+
:type cid: str
|
|
147
|
+
:param body:
|
|
148
|
+
:type body: union[AdhocAnalysisInput,JobAnalysisInput]
|
|
149
|
+
:param job: returns job_id instead of analysis.id, defaults to false
|
|
150
|
+
:type job: bool, optional
|
|
151
|
+
:param async_: Perform the request asynchronously
|
|
152
|
+
:type async_: bool, optional
|
|
153
|
+
:rtype: InsertedId
|
|
154
154
|
"""
|
|
155
155
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
156
156
|
kwargs['_return_http_data_only'] = True
|
|
@@ -174,15 +174,18 @@ class SessionsApi(object):
|
|
|
174
174
|
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
175
175
|
This method makes a synchronous HTTP request by default.
|
|
176
176
|
|
|
177
|
-
:param
|
|
178
|
-
:
|
|
179
|
-
:param
|
|
180
|
-
:
|
|
181
|
-
:param
|
|
182
|
-
:
|
|
177
|
+
:param cid:
|
|
178
|
+
:type cid: str
|
|
179
|
+
:param body:
|
|
180
|
+
:type body: union[AdhocAnalysisInput,JobAnalysisInput]
|
|
181
|
+
:param job: returns job_id instead of analysis.id, defaults to false
|
|
182
|
+
:type job: bool, optional
|
|
183
|
+
:param async_: Perform the request asynchronously
|
|
184
|
+
:type async_: bool, optional
|
|
185
|
+
:rtype: InsertedId
|
|
183
186
|
"""
|
|
184
187
|
|
|
185
|
-
all_params = ['cid','body','job',
|
|
188
|
+
all_params = ['cid','body','job',] # noqa: E501
|
|
186
189
|
all_params.append('async_')
|
|
187
190
|
all_params.append('_return_http_data_only')
|
|
188
191
|
all_params.append('_preload_content')
|
|
@@ -215,8 +218,6 @@ class SessionsApi(object):
|
|
|
215
218
|
path_params['cid'] = params['cid'] # noqa: E501
|
|
216
219
|
|
|
217
220
|
query_params = []
|
|
218
|
-
if 'job' in params:
|
|
219
|
-
query_params.append(('job', params['job'])) # noqa: E501
|
|
220
221
|
if 'job' in params:
|
|
221
222
|
query_params.append(('job', params['job'])) # noqa: E501
|
|
222
223
|
else:
|
|
@@ -271,11 +272,15 @@ class SessionsApi(object):
|
|
|
271
272
|
Add a note to a(n) session analysis.
|
|
272
273
|
This method makes a synchronous HTTP request by default.
|
|
273
274
|
|
|
274
|
-
:param
|
|
275
|
-
:
|
|
276
|
-
:param
|
|
277
|
-
:
|
|
278
|
-
:
|
|
275
|
+
:param container_id: 24-char hex id
|
|
276
|
+
:type container_id: str
|
|
277
|
+
:param analysis_id: 24-char hex analysis id
|
|
278
|
+
:type analysis_id: str
|
|
279
|
+
:param body:
|
|
280
|
+
:type body: NoteInput
|
|
281
|
+
:param async_: Perform the request asynchronously
|
|
282
|
+
:type async_: bool, optional
|
|
283
|
+
:rtype: Note
|
|
279
284
|
"""
|
|
280
285
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
281
286
|
kwargs['_return_http_data_only'] = True
|
|
@@ -299,11 +304,15 @@ class SessionsApi(object):
|
|
|
299
304
|
Add a note to a(n) session analysis.
|
|
300
305
|
This method makes a synchronous HTTP request by default.
|
|
301
306
|
|
|
302
|
-
:param
|
|
303
|
-
:
|
|
304
|
-
:param
|
|
305
|
-
:
|
|
306
|
-
:
|
|
307
|
+
:param container_id: 24-char hex id
|
|
308
|
+
:type container_id: str
|
|
309
|
+
:param analysis_id: 24-char hex analysis id
|
|
310
|
+
:type analysis_id: str
|
|
311
|
+
:param body:
|
|
312
|
+
:type body: NoteInput
|
|
313
|
+
:param async_: Perform the request asynchronously
|
|
314
|
+
:type async_: bool, optional
|
|
315
|
+
:rtype: Note
|
|
307
316
|
"""
|
|
308
317
|
|
|
309
318
|
all_params = ['container_id','analysis_id','body',] # noqa: E501
|
|
@@ -395,10 +404,13 @@ class SessionsApi(object):
|
|
|
395
404
|
Add a note to a(n) session.
|
|
396
405
|
This method makes a synchronous HTTP request by default.
|
|
397
406
|
|
|
398
|
-
:param
|
|
399
|
-
:
|
|
400
|
-
:param
|
|
401
|
-
:
|
|
407
|
+
:param container_id:
|
|
408
|
+
:type container_id: str
|
|
409
|
+
:param body:
|
|
410
|
+
:type body: NoteInput
|
|
411
|
+
:param async_: Perform the request asynchronously
|
|
412
|
+
:type async_: bool, optional
|
|
413
|
+
:rtype: Note
|
|
402
414
|
"""
|
|
403
415
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
404
416
|
kwargs['_return_http_data_only'] = True
|
|
@@ -422,10 +434,13 @@ class SessionsApi(object):
|
|
|
422
434
|
Add a note to a(n) session.
|
|
423
435
|
This method makes a synchronous HTTP request by default.
|
|
424
436
|
|
|
425
|
-
:param
|
|
426
|
-
:
|
|
427
|
-
:param
|
|
428
|
-
:
|
|
437
|
+
:param container_id:
|
|
438
|
+
:type container_id: str
|
|
439
|
+
:param body:
|
|
440
|
+
:type body: NoteInput
|
|
441
|
+
:param async_: Perform the request asynchronously
|
|
442
|
+
:type async_: bool, optional
|
|
443
|
+
:rtype: Note
|
|
429
444
|
"""
|
|
430
445
|
|
|
431
446
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -511,10 +526,13 @@ class SessionsApi(object):
|
|
|
511
526
|
Propagates changes to projects, sessions and acquisitions
|
|
512
527
|
This method makes a synchronous HTTP request by default.
|
|
513
528
|
|
|
514
|
-
:param
|
|
515
|
-
:
|
|
516
|
-
:param
|
|
517
|
-
:
|
|
529
|
+
:param cid:
|
|
530
|
+
:type cid: str
|
|
531
|
+
:param body:
|
|
532
|
+
:type body: Tag
|
|
533
|
+
:param async_: Perform the request asynchronously
|
|
534
|
+
:type async_: bool, optional
|
|
535
|
+
:rtype: ModifiedResult
|
|
518
536
|
"""
|
|
519
537
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
520
538
|
kwargs['_return_http_data_only'] = True
|
|
@@ -538,10 +556,13 @@ class SessionsApi(object):
|
|
|
538
556
|
Propagates changes to projects, sessions and acquisitions
|
|
539
557
|
This method makes a synchronous HTTP request by default.
|
|
540
558
|
|
|
541
|
-
:param
|
|
542
|
-
:
|
|
543
|
-
:param
|
|
544
|
-
:
|
|
559
|
+
:param cid:
|
|
560
|
+
:type cid: str
|
|
561
|
+
:param body:
|
|
562
|
+
:type body: Tag
|
|
563
|
+
:param async_: Perform the request asynchronously
|
|
564
|
+
:type async_: bool, optional
|
|
565
|
+
:rtype: ModifiedResult
|
|
545
566
|
"""
|
|
546
567
|
|
|
547
568
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -627,10 +648,13 @@ class SessionsApi(object):
|
|
|
627
648
|
Add multiple tags to a(n) session
|
|
628
649
|
This method makes a synchronous HTTP request by default.
|
|
629
650
|
|
|
630
|
-
:param
|
|
631
|
-
:
|
|
632
|
-
:param
|
|
633
|
-
:
|
|
651
|
+
:param cid:
|
|
652
|
+
:type cid: str
|
|
653
|
+
:param body:
|
|
654
|
+
:type body: list[str]
|
|
655
|
+
:param async_: Perform the request asynchronously
|
|
656
|
+
:type async_: bool, optional
|
|
657
|
+
:rtype: None
|
|
634
658
|
"""
|
|
635
659
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
636
660
|
kwargs['_return_http_data_only'] = True
|
|
@@ -654,10 +678,13 @@ class SessionsApi(object):
|
|
|
654
678
|
Add multiple tags to a(n) session
|
|
655
679
|
This method makes a synchronous HTTP request by default.
|
|
656
680
|
|
|
657
|
-
:param
|
|
658
|
-
:
|
|
659
|
-
:param
|
|
660
|
-
:
|
|
681
|
+
:param cid:
|
|
682
|
+
:type cid: str
|
|
683
|
+
:param body:
|
|
684
|
+
:type body: list[str]
|
|
685
|
+
:param async_: Perform the request asynchronously
|
|
686
|
+
:type async_: bool, optional
|
|
687
|
+
:rtype: None
|
|
661
688
|
"""
|
|
662
689
|
|
|
663
690
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -736,10 +763,13 @@ class SessionsApi(object):
|
|
|
736
763
|
Read-write project permissions are required to delete a session. Admin project permissions are required if the session or it's acquisitions contain data uploaded by sources other than users and jobs.
|
|
737
764
|
This method makes a synchronous HTTP request by default.
|
|
738
765
|
|
|
739
|
-
:param
|
|
740
|
-
:
|
|
741
|
-
:param
|
|
742
|
-
:
|
|
766
|
+
:param session_id:
|
|
767
|
+
:type session_id: str
|
|
768
|
+
:param delete_reason:
|
|
769
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
770
|
+
:param async_: Perform the request asynchronously
|
|
771
|
+
:type async_: bool, optional
|
|
772
|
+
:rtype: DeletedResult
|
|
743
773
|
"""
|
|
744
774
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
745
775
|
kwargs['_return_http_data_only'] = True
|
|
@@ -763,10 +793,13 @@ class SessionsApi(object):
|
|
|
763
793
|
Read-write project permissions are required to delete a session. Admin project permissions are required if the session or it's acquisitions contain data uploaded by sources other than users and jobs.
|
|
764
794
|
This method makes a synchronous HTTP request by default.
|
|
765
795
|
|
|
766
|
-
:param
|
|
767
|
-
:
|
|
768
|
-
:param
|
|
769
|
-
:
|
|
796
|
+
:param session_id:
|
|
797
|
+
:type session_id: str
|
|
798
|
+
:param delete_reason:
|
|
799
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
800
|
+
:param async_: Perform the request asynchronously
|
|
801
|
+
:type async_: bool, optional
|
|
802
|
+
:rtype: DeletedResult
|
|
770
803
|
"""
|
|
771
804
|
|
|
772
805
|
all_params = ['session_id','delete_reason',] # noqa: E501
|
|
@@ -837,11 +870,15 @@ class SessionsApi(object):
|
|
|
837
870
|
Delete an analysis for a container.
|
|
838
871
|
This method makes a synchronous HTTP request by default.
|
|
839
872
|
|
|
840
|
-
:param
|
|
841
|
-
:
|
|
842
|
-
:param
|
|
843
|
-
:
|
|
844
|
-
:
|
|
873
|
+
:param cid:
|
|
874
|
+
:type cid: str
|
|
875
|
+
:param analysis_id:
|
|
876
|
+
:type analysis_id: str
|
|
877
|
+
:param delete_reason: Provide a reason for the deletion
|
|
878
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
879
|
+
:param async_: Perform the request asynchronously
|
|
880
|
+
:type async_: bool, optional
|
|
881
|
+
:rtype: DeletedResult
|
|
845
882
|
"""
|
|
846
883
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
847
884
|
kwargs['_return_http_data_only'] = True
|
|
@@ -865,11 +902,15 @@ class SessionsApi(object):
|
|
|
865
902
|
Delete an analysis for a container.
|
|
866
903
|
This method makes a synchronous HTTP request by default.
|
|
867
904
|
|
|
868
|
-
:param
|
|
869
|
-
:
|
|
870
|
-
:param
|
|
871
|
-
:
|
|
872
|
-
:
|
|
905
|
+
:param cid:
|
|
906
|
+
:type cid: str
|
|
907
|
+
:param analysis_id:
|
|
908
|
+
:type analysis_id: str
|
|
909
|
+
:param delete_reason: Provide a reason for the deletion
|
|
910
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
911
|
+
:param async_: Perform the request asynchronously
|
|
912
|
+
:type async_: bool, optional
|
|
913
|
+
:rtype: DeletedResult
|
|
873
914
|
"""
|
|
874
915
|
|
|
875
916
|
all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
|
|
@@ -946,11 +987,15 @@ class SessionsApi(object):
|
|
|
946
987
|
Remove a note from a(n) session analysis.
|
|
947
988
|
This method makes a synchronous HTTP request by default.
|
|
948
989
|
|
|
949
|
-
:param
|
|
950
|
-
:
|
|
951
|
-
:param
|
|
952
|
-
:
|
|
953
|
-
:
|
|
990
|
+
:param cid: 24-char hex id
|
|
991
|
+
:type cid: str
|
|
992
|
+
:param analysis_id: 24-char hex analysis id
|
|
993
|
+
:type analysis_id: str
|
|
994
|
+
:param note_id: 24-char hex note id
|
|
995
|
+
:type note_id: str
|
|
996
|
+
:param async_: Perform the request asynchronously
|
|
997
|
+
:type async_: bool, optional
|
|
998
|
+
:rtype: DeletedResult
|
|
954
999
|
"""
|
|
955
1000
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
956
1001
|
kwargs['_return_http_data_only'] = True
|
|
@@ -974,11 +1019,15 @@ class SessionsApi(object):
|
|
|
974
1019
|
Remove a note from a(n) session analysis.
|
|
975
1020
|
This method makes a synchronous HTTP request by default.
|
|
976
1021
|
|
|
977
|
-
:param
|
|
978
|
-
:
|
|
979
|
-
:param
|
|
980
|
-
:
|
|
981
|
-
:
|
|
1022
|
+
:param cid: 24-char hex id
|
|
1023
|
+
:type cid: str
|
|
1024
|
+
:param analysis_id: 24-char hex analysis id
|
|
1025
|
+
:type analysis_id: str
|
|
1026
|
+
:param note_id: 24-char hex note id
|
|
1027
|
+
:type note_id: str
|
|
1028
|
+
:param async_: Perform the request asynchronously
|
|
1029
|
+
:type async_: bool, optional
|
|
1030
|
+
:rtype: DeletedResult
|
|
982
1031
|
"""
|
|
983
1032
|
|
|
984
1033
|
all_params = ['cid','analysis_id','note_id',] # noqa: E501
|
|
@@ -1059,12 +1108,17 @@ class SessionsApi(object):
|
|
|
1059
1108
|
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1060
1109
|
This method makes a synchronous HTTP request by default.
|
|
1061
1110
|
|
|
1062
|
-
:param
|
|
1063
|
-
:
|
|
1064
|
-
:param
|
|
1065
|
-
:
|
|
1066
|
-
:param
|
|
1067
|
-
:
|
|
1111
|
+
:param cid:
|
|
1112
|
+
:type cid: str
|
|
1113
|
+
:param filename:
|
|
1114
|
+
:type filename: str
|
|
1115
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
1116
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1117
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
1118
|
+
:type force: bool, optional
|
|
1119
|
+
:param async_: Perform the request asynchronously
|
|
1120
|
+
:type async_: bool, optional
|
|
1121
|
+
:rtype: DeletedResult
|
|
1068
1122
|
"""
|
|
1069
1123
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1070
1124
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1088,12 +1142,17 @@ class SessionsApi(object):
|
|
|
1088
1142
|
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1089
1143
|
This method makes a synchronous HTTP request by default.
|
|
1090
1144
|
|
|
1091
|
-
:param
|
|
1092
|
-
:
|
|
1093
|
-
:param
|
|
1094
|
-
:
|
|
1095
|
-
:param
|
|
1096
|
-
:
|
|
1145
|
+
:param cid:
|
|
1146
|
+
:type cid: str
|
|
1147
|
+
:param filename:
|
|
1148
|
+
:type filename: str
|
|
1149
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
1150
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1151
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
1152
|
+
:type force: bool, optional
|
|
1153
|
+
:param async_: Perform the request asynchronously
|
|
1154
|
+
:type async_: bool, optional
|
|
1155
|
+
:rtype: DeletedResult
|
|
1097
1156
|
"""
|
|
1098
1157
|
|
|
1099
1158
|
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
@@ -1172,10 +1231,13 @@ class SessionsApi(object):
|
|
|
1172
1231
|
Remove a note from a(n) session
|
|
1173
1232
|
This method makes a synchronous HTTP request by default.
|
|
1174
1233
|
|
|
1175
|
-
:param
|
|
1176
|
-
:
|
|
1177
|
-
:param
|
|
1178
|
-
:
|
|
1234
|
+
:param cid:
|
|
1235
|
+
:type cid: str
|
|
1236
|
+
:param note_id:
|
|
1237
|
+
:type note_id: str
|
|
1238
|
+
:param async_: Perform the request asynchronously
|
|
1239
|
+
:type async_: bool, optional
|
|
1240
|
+
:rtype: DeletedResult
|
|
1179
1241
|
"""
|
|
1180
1242
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1181
1243
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1199,10 +1261,13 @@ class SessionsApi(object):
|
|
|
1199
1261
|
Remove a note from a(n) session
|
|
1200
1262
|
This method makes a synchronous HTTP request by default.
|
|
1201
1263
|
|
|
1202
|
-
:param
|
|
1203
|
-
:
|
|
1204
|
-
:param
|
|
1205
|
-
:
|
|
1264
|
+
:param cid:
|
|
1265
|
+
:type cid: str
|
|
1266
|
+
:param note_id:
|
|
1267
|
+
:type note_id: str
|
|
1268
|
+
:param async_: Perform the request asynchronously
|
|
1269
|
+
:type async_: bool, optional
|
|
1270
|
+
:rtype: DeletedResult
|
|
1206
1271
|
"""
|
|
1207
1272
|
|
|
1208
1273
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -1277,10 +1342,13 @@ class SessionsApi(object):
|
|
|
1277
1342
|
Delete a tag
|
|
1278
1343
|
This method makes a synchronous HTTP request by default.
|
|
1279
1344
|
|
|
1280
|
-
:param
|
|
1281
|
-
:
|
|
1282
|
-
:param
|
|
1283
|
-
:
|
|
1345
|
+
:param cid:
|
|
1346
|
+
:type cid: str
|
|
1347
|
+
:param value: The tag to interact with
|
|
1348
|
+
:type value: str
|
|
1349
|
+
:param async_: Perform the request asynchronously
|
|
1350
|
+
:type async_: bool, optional
|
|
1351
|
+
:rtype: DeletedResult
|
|
1284
1352
|
"""
|
|
1285
1353
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1286
1354
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1304,10 +1372,13 @@ class SessionsApi(object):
|
|
|
1304
1372
|
Delete a tag
|
|
1305
1373
|
This method makes a synchronous HTTP request by default.
|
|
1306
1374
|
|
|
1307
|
-
:param
|
|
1308
|
-
:
|
|
1309
|
-
:param
|
|
1310
|
-
:
|
|
1375
|
+
:param cid:
|
|
1376
|
+
:type cid: str
|
|
1377
|
+
:param value: The tag to interact with
|
|
1378
|
+
:type value: str
|
|
1379
|
+
:param async_: Perform the request asynchronously
|
|
1380
|
+
:type async_: bool, optional
|
|
1381
|
+
:rtype: DeletedResult
|
|
1311
1382
|
"""
|
|
1312
1383
|
|
|
1313
1384
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -1382,10 +1453,13 @@ class SessionsApi(object):
|
|
|
1382
1453
|
Delete multiple tags from a(n) session
|
|
1383
1454
|
This method makes a synchronous HTTP request by default.
|
|
1384
1455
|
|
|
1385
|
-
:param
|
|
1386
|
-
:
|
|
1387
|
-
:param
|
|
1388
|
-
:
|
|
1456
|
+
:param cid:
|
|
1457
|
+
:type cid: str
|
|
1458
|
+
:param body:
|
|
1459
|
+
:type body: list[str]
|
|
1460
|
+
:param async_: Perform the request asynchronously
|
|
1461
|
+
:type async_: bool, optional
|
|
1462
|
+
:rtype: None
|
|
1389
1463
|
"""
|
|
1390
1464
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1391
1465
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1409,10 +1483,13 @@ class SessionsApi(object):
|
|
|
1409
1483
|
Delete multiple tags from a(n) session
|
|
1410
1484
|
This method makes a synchronous HTTP request by default.
|
|
1411
1485
|
|
|
1412
|
-
:param
|
|
1413
|
-
:
|
|
1414
|
-
:param
|
|
1415
|
-
:
|
|
1486
|
+
:param cid:
|
|
1487
|
+
:type cid: str
|
|
1488
|
+
:param body:
|
|
1489
|
+
:type body: list[str]
|
|
1490
|
+
:param async_: Perform the request asynchronously
|
|
1491
|
+
:type async_: bool, optional
|
|
1492
|
+
:rtype: None
|
|
1416
1493
|
"""
|
|
1417
1494
|
|
|
1418
1495
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -1491,10 +1568,13 @@ class SessionsApi(object):
|
|
|
1491
1568
|
Delete multiple sessions by ID list
|
|
1492
1569
|
This method makes a synchronous HTTP request by default.
|
|
1493
1570
|
|
|
1494
|
-
:param
|
|
1495
|
-
:
|
|
1496
|
-
:param
|
|
1497
|
-
:
|
|
1571
|
+
:param body: List of IDs to delete
|
|
1572
|
+
:type body: list[str]
|
|
1573
|
+
:param delete_reason:
|
|
1574
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1575
|
+
:param async_: Perform the request asynchronously
|
|
1576
|
+
:type async_: bool, optional
|
|
1577
|
+
:rtype: DeletedResult
|
|
1498
1578
|
"""
|
|
1499
1579
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1500
1580
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1518,10 +1598,13 @@ class SessionsApi(object):
|
|
|
1518
1598
|
Delete multiple sessions by ID list
|
|
1519
1599
|
This method makes a synchronous HTTP request by default.
|
|
1520
1600
|
|
|
1521
|
-
:param
|
|
1522
|
-
:
|
|
1523
|
-
:param
|
|
1524
|
-
:
|
|
1601
|
+
:param body: List of IDs to delete
|
|
1602
|
+
:type body: list[str]
|
|
1603
|
+
:param delete_reason:
|
|
1604
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1605
|
+
:param async_: Perform the request asynchronously
|
|
1606
|
+
:type async_: bool, optional
|
|
1607
|
+
:rtype: DeletedResult
|
|
1525
1608
|
"""
|
|
1526
1609
|
|
|
1527
1610
|
all_params = ['body','delete_reason',] # noqa: E501
|
|
@@ -1596,18 +1679,29 @@ class SessionsApi(object):
|
|
|
1596
1679
|
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1597
1680
|
This method makes a synchronous HTTP request by default.
|
|
1598
1681
|
|
|
1599
|
-
:param
|
|
1600
|
-
:
|
|
1601
|
-
:param
|
|
1602
|
-
:
|
|
1603
|
-
:param
|
|
1604
|
-
:
|
|
1605
|
-
:param
|
|
1606
|
-
:
|
|
1607
|
-
:param
|
|
1608
|
-
:
|
|
1609
|
-
:param
|
|
1610
|
-
:
|
|
1682
|
+
:param session_id: 24-character hex ID
|
|
1683
|
+
:type session_id: str
|
|
1684
|
+
:param file_name: output file name
|
|
1685
|
+
:type file_name: str
|
|
1686
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1687
|
+
:type info: bool, optional
|
|
1688
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1689
|
+
:type member: str, optional
|
|
1690
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1691
|
+
:type view: bool, optional
|
|
1692
|
+
:param version: version of the file to download
|
|
1693
|
+
:type version: int, optional
|
|
1694
|
+
:param hash: file hash for comparison
|
|
1695
|
+
:type hash: str, optional
|
|
1696
|
+
:param range: byte ranges to return
|
|
1697
|
+
:type range: str, optional
|
|
1698
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1699
|
+
:type x_accept_feature: list[str], optional
|
|
1700
|
+
:param dest_file: Destination file path
|
|
1701
|
+
:type dest_file: str
|
|
1702
|
+
:param async_: Perform the request asynchronously
|
|
1703
|
+
:type async_: bool, optional
|
|
1704
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1611
1705
|
"""
|
|
1612
1706
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1613
1707
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1630,17 +1724,27 @@ class SessionsApi(object):
|
|
|
1630
1724
|
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1631
1725
|
This method makes a synchronous HTTP request by default.
|
|
1632
1726
|
|
|
1633
|
-
:param
|
|
1634
|
-
:
|
|
1635
|
-
:param
|
|
1636
|
-
:
|
|
1637
|
-
:param
|
|
1638
|
-
:
|
|
1639
|
-
:param
|
|
1640
|
-
:
|
|
1641
|
-
:param
|
|
1642
|
-
:
|
|
1643
|
-
:
|
|
1727
|
+
:param session_id: 24-character hex ID
|
|
1728
|
+
:type session_id: str
|
|
1729
|
+
:param file_name: output file name
|
|
1730
|
+
:type file_name: str
|
|
1731
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1732
|
+
:type info: bool, optional
|
|
1733
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1734
|
+
:type member: str, optional
|
|
1735
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1736
|
+
:type view: bool, optional
|
|
1737
|
+
:param version: version of the file to download
|
|
1738
|
+
:type version: int, optional
|
|
1739
|
+
:param hash: file hash for comparison
|
|
1740
|
+
:type hash: str, optional
|
|
1741
|
+
:param range: byte ranges to return
|
|
1742
|
+
:type range: str, optional
|
|
1743
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1744
|
+
:type x_accept_feature: list[str], optional
|
|
1745
|
+
:param async_: Perform the request asynchronously
|
|
1746
|
+
:type async_: bool, optional
|
|
1747
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1644
1748
|
"""
|
|
1645
1749
|
|
|
1646
1750
|
all_params = ['session_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1730,18 +1834,29 @@ class SessionsApi(object):
|
|
|
1730
1834
|
Does not work on files whose names contain a forward slash.
|
|
1731
1835
|
This method makes a synchronous HTTP request by default.
|
|
1732
1836
|
|
|
1733
|
-
:param
|
|
1734
|
-
:
|
|
1735
|
-
:param
|
|
1736
|
-
:
|
|
1737
|
-
:param
|
|
1738
|
-
:
|
|
1739
|
-
:param
|
|
1740
|
-
:
|
|
1741
|
-
:param
|
|
1742
|
-
:
|
|
1743
|
-
:param
|
|
1744
|
-
:
|
|
1837
|
+
:param session_id: 24-character hex ID
|
|
1838
|
+
:type session_id: str
|
|
1839
|
+
:param file_name: output file name
|
|
1840
|
+
:type file_name: str
|
|
1841
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1842
|
+
:type ticket: str, optional
|
|
1843
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1844
|
+
:type info: bool, optional
|
|
1845
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1846
|
+
:type member: str, optional
|
|
1847
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1848
|
+
:type view: bool, optional
|
|
1849
|
+
:param version: version of the file to download
|
|
1850
|
+
:type version: int, optional
|
|
1851
|
+
:param hash: file hash for comparison
|
|
1852
|
+
:type hash: str, optional
|
|
1853
|
+
:param range: byte ranges to return
|
|
1854
|
+
:type range: str, optional
|
|
1855
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1856
|
+
:type x_accept_feature: list[str], optional
|
|
1857
|
+
:param async_: Perform the request asynchronously
|
|
1858
|
+
:type async_: bool, optional
|
|
1859
|
+
:rtype: FileZipInfo
|
|
1745
1860
|
"""
|
|
1746
1861
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1747
1862
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1765,18 +1880,29 @@ class SessionsApi(object):
|
|
|
1765
1880
|
Does not work on files whose names contain a forward slash.
|
|
1766
1881
|
This method makes a synchronous HTTP request by default.
|
|
1767
1882
|
|
|
1768
|
-
:param
|
|
1769
|
-
:
|
|
1770
|
-
:param
|
|
1771
|
-
:
|
|
1772
|
-
:param
|
|
1773
|
-
:
|
|
1774
|
-
:param
|
|
1775
|
-
:
|
|
1776
|
-
:param
|
|
1777
|
-
:
|
|
1778
|
-
:param
|
|
1779
|
-
:
|
|
1883
|
+
:param session_id: 24-character hex ID
|
|
1884
|
+
:type session_id: str
|
|
1885
|
+
:param file_name: output file name
|
|
1886
|
+
:type file_name: str
|
|
1887
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1888
|
+
:type ticket: str, optional
|
|
1889
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1890
|
+
:type info: bool, optional
|
|
1891
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1892
|
+
:type member: str, optional
|
|
1893
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1894
|
+
:type view: bool, optional
|
|
1895
|
+
:param version: version of the file to download
|
|
1896
|
+
:type version: int, optional
|
|
1897
|
+
:param hash: file hash for comparison
|
|
1898
|
+
:type hash: str, optional
|
|
1899
|
+
:param range: byte ranges to return
|
|
1900
|
+
:type range: str, optional
|
|
1901
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1902
|
+
:type x_accept_feature: list[str], optional
|
|
1903
|
+
:param async_: Perform the request asynchronously
|
|
1904
|
+
:type async_: bool, optional
|
|
1905
|
+
:rtype: FileZipInfo
|
|
1780
1906
|
"""
|
|
1781
1907
|
|
|
1782
1908
|
all_params = ['session_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1869,18 +1995,29 @@ class SessionsApi(object):
|
|
|
1869
1995
|
|
|
1870
1996
|
This method makes a synchronous HTTP request by default.
|
|
1871
1997
|
|
|
1872
|
-
:param
|
|
1873
|
-
:
|
|
1874
|
-
:param
|
|
1875
|
-
:
|
|
1876
|
-
:param
|
|
1877
|
-
:
|
|
1878
|
-
:param
|
|
1879
|
-
:
|
|
1880
|
-
:param
|
|
1881
|
-
:
|
|
1882
|
-
:param
|
|
1883
|
-
:
|
|
1998
|
+
:param session_id: 24-character hex ID
|
|
1999
|
+
:type session_id: str
|
|
2000
|
+
:param file_name: output file name
|
|
2001
|
+
:type file_name: str
|
|
2002
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
2003
|
+
:type ticket: str, optional
|
|
2004
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2005
|
+
:type info: bool, optional
|
|
2006
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2007
|
+
:type member: str, optional
|
|
2008
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
2009
|
+
:type view: bool, optional
|
|
2010
|
+
:param version: version of the file to download
|
|
2011
|
+
:type version: int, optional
|
|
2012
|
+
:param hash: file hash for comparison
|
|
2013
|
+
:type hash: str, optional
|
|
2014
|
+
:param range: byte ranges to return
|
|
2015
|
+
:type range: str, optional
|
|
2016
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2017
|
+
:type x_accept_feature: list[str], optional
|
|
2018
|
+
:param async_: Perform the request asynchronously
|
|
2019
|
+
:type async_: bool, optional
|
|
2020
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1884
2021
|
"""
|
|
1885
2022
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1886
2023
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1903,18 +2040,29 @@ class SessionsApi(object):
|
|
|
1903
2040
|
|
|
1904
2041
|
This method makes a synchronous HTTP request by default.
|
|
1905
2042
|
|
|
1906
|
-
:param
|
|
1907
|
-
:
|
|
1908
|
-
:param
|
|
1909
|
-
:
|
|
1910
|
-
:param
|
|
1911
|
-
:
|
|
1912
|
-
:param
|
|
1913
|
-
:
|
|
1914
|
-
:param
|
|
1915
|
-
:
|
|
1916
|
-
:param
|
|
1917
|
-
:
|
|
2043
|
+
:param session_id: 24-character hex ID
|
|
2044
|
+
:type session_id: str
|
|
2045
|
+
:param file_name: output file name
|
|
2046
|
+
:type file_name: str
|
|
2047
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
2048
|
+
:type ticket: str, optional
|
|
2049
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2050
|
+
:type info: bool, optional
|
|
2051
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2052
|
+
:type member: str, optional
|
|
2053
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
2054
|
+
:type view: bool, optional
|
|
2055
|
+
:param version: version of the file to download
|
|
2056
|
+
:type version: int, optional
|
|
2057
|
+
:param hash: file hash for comparison
|
|
2058
|
+
:type hash: str, optional
|
|
2059
|
+
:param range: byte ranges to return
|
|
2060
|
+
:type range: str, optional
|
|
2061
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2062
|
+
:type x_accept_feature: list[str], optional
|
|
2063
|
+
:param async_: Perform the request asynchronously
|
|
2064
|
+
:type async_: bool, optional
|
|
2065
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1918
2066
|
"""
|
|
1919
2067
|
|
|
1920
2068
|
all_params = ['session_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -2006,17 +2154,27 @@ class SessionsApi(object):
|
|
|
2006
2154
|
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2007
2155
|
This method makes a synchronous HTTP request by default.
|
|
2008
2156
|
|
|
2009
|
-
:param
|
|
2010
|
-
:
|
|
2011
|
-
:param
|
|
2012
|
-
:
|
|
2013
|
-
:param
|
|
2014
|
-
:
|
|
2015
|
-
:param
|
|
2016
|
-
:
|
|
2017
|
-
:param
|
|
2018
|
-
:
|
|
2019
|
-
:
|
|
2157
|
+
:param session_id: 24-character hex ID
|
|
2158
|
+
:type session_id: str
|
|
2159
|
+
:param analysis_id: 24-char hex analysis id
|
|
2160
|
+
:type analysis_id: str
|
|
2161
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2162
|
+
:type filename: str
|
|
2163
|
+
:param info: get file info only, defaults to false
|
|
2164
|
+
:type info: bool, optional
|
|
2165
|
+
:param member: get zipfile member
|
|
2166
|
+
:type member: str, optional
|
|
2167
|
+
:param view: feature flag for view/download, defaults to false
|
|
2168
|
+
:type view: bool, optional
|
|
2169
|
+
:param range: byte ranges to return
|
|
2170
|
+
:type range: str, optional
|
|
2171
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2172
|
+
:type x_accept_feature: list[str], optional
|
|
2173
|
+
:param dest_file: Destination file path
|
|
2174
|
+
:type dest_file: str
|
|
2175
|
+
:param async_: Perform the request asynchronously
|
|
2176
|
+
:type async_: bool, optional
|
|
2177
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2020
2178
|
"""
|
|
2021
2179
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2022
2180
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2039,16 +2197,25 @@ class SessionsApi(object):
|
|
|
2039
2197
|
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2040
2198
|
This method makes a synchronous HTTP request by default.
|
|
2041
2199
|
|
|
2042
|
-
:param
|
|
2043
|
-
:
|
|
2044
|
-
:param
|
|
2045
|
-
:
|
|
2046
|
-
:param
|
|
2047
|
-
:
|
|
2048
|
-
:param
|
|
2049
|
-
:
|
|
2050
|
-
:param
|
|
2051
|
-
:
|
|
2200
|
+
:param session_id: 24-character hex ID
|
|
2201
|
+
:type session_id: str
|
|
2202
|
+
:param analysis_id: 24-char hex analysis id
|
|
2203
|
+
:type analysis_id: str
|
|
2204
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2205
|
+
:type filename: str
|
|
2206
|
+
:param info: get file info only, defaults to false
|
|
2207
|
+
:type info: bool, optional
|
|
2208
|
+
:param member: get zipfile member
|
|
2209
|
+
:type member: str, optional
|
|
2210
|
+
:param view: feature flag for view/download, defaults to false
|
|
2211
|
+
:type view: bool, optional
|
|
2212
|
+
:param range: byte ranges to return
|
|
2213
|
+
:type range: str, optional
|
|
2214
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2215
|
+
:type x_accept_feature: list[str], optional
|
|
2216
|
+
:param async_: Perform the request asynchronously
|
|
2217
|
+
:type async_: bool, optional
|
|
2218
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2052
2219
|
"""
|
|
2053
2220
|
|
|
2054
2221
|
all_params = ['session_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2140,17 +2307,27 @@ class SessionsApi(object):
|
|
|
2140
2307
|
Does not work on files whose names contain a forward slash.
|
|
2141
2308
|
This method makes a synchronous HTTP request by default.
|
|
2142
2309
|
|
|
2143
|
-
:param
|
|
2144
|
-
:
|
|
2145
|
-
:param
|
|
2146
|
-
:
|
|
2147
|
-
:param
|
|
2148
|
-
:
|
|
2149
|
-
:param
|
|
2150
|
-
:
|
|
2151
|
-
:param
|
|
2152
|
-
:
|
|
2153
|
-
:
|
|
2310
|
+
:param session_id: 24-character hex ID
|
|
2311
|
+
:type session_id: str
|
|
2312
|
+
:param analysis_id: 24-char hex analysis id
|
|
2313
|
+
:type analysis_id: str
|
|
2314
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2315
|
+
:type filename: str
|
|
2316
|
+
:param ticket: 24-char hex ticket id
|
|
2317
|
+
:type ticket: str, optional
|
|
2318
|
+
:param info: get file info only, defaults to false
|
|
2319
|
+
:type info: bool, optional
|
|
2320
|
+
:param member: get zipfile member
|
|
2321
|
+
:type member: str, optional
|
|
2322
|
+
:param view: feature flag for view/download, defaults to false
|
|
2323
|
+
:type view: bool, optional
|
|
2324
|
+
:param range: byte ranges to return
|
|
2325
|
+
:type range: str, optional
|
|
2326
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2327
|
+
:type x_accept_feature: list[str], optional
|
|
2328
|
+
:param async_: Perform the request asynchronously
|
|
2329
|
+
:type async_: bool, optional
|
|
2330
|
+
:rtype: FileZipInfo
|
|
2154
2331
|
"""
|
|
2155
2332
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2156
2333
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2174,17 +2351,27 @@ class SessionsApi(object):
|
|
|
2174
2351
|
Does not work on files whose names contain a forward slash.
|
|
2175
2352
|
This method makes a synchronous HTTP request by default.
|
|
2176
2353
|
|
|
2177
|
-
:param
|
|
2178
|
-
:
|
|
2179
|
-
:param
|
|
2180
|
-
:
|
|
2181
|
-
:param
|
|
2182
|
-
:
|
|
2183
|
-
:param
|
|
2184
|
-
:
|
|
2185
|
-
:param
|
|
2186
|
-
:
|
|
2187
|
-
:
|
|
2354
|
+
:param session_id: 24-character hex ID
|
|
2355
|
+
:type session_id: str
|
|
2356
|
+
:param analysis_id: 24-char hex analysis id
|
|
2357
|
+
:type analysis_id: str
|
|
2358
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2359
|
+
:type filename: str
|
|
2360
|
+
:param ticket: 24-char hex ticket id
|
|
2361
|
+
:type ticket: str, optional
|
|
2362
|
+
:param info: get file info only, defaults to false
|
|
2363
|
+
:type info: bool, optional
|
|
2364
|
+
:param member: get zipfile member
|
|
2365
|
+
:type member: str, optional
|
|
2366
|
+
:param view: feature flag for view/download, defaults to false
|
|
2367
|
+
:type view: bool, optional
|
|
2368
|
+
:param range: byte ranges to return
|
|
2369
|
+
:type range: str, optional
|
|
2370
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2371
|
+
:type x_accept_feature: list[str], optional
|
|
2372
|
+
:param async_: Perform the request asynchronously
|
|
2373
|
+
:type async_: bool, optional
|
|
2374
|
+
:rtype: FileZipInfo
|
|
2188
2375
|
"""
|
|
2189
2376
|
|
|
2190
2377
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2279,17 +2466,27 @@ class SessionsApi(object):
|
|
|
2279
2466
|
|
|
2280
2467
|
This method makes a synchronous HTTP request by default.
|
|
2281
2468
|
|
|
2282
|
-
:param
|
|
2283
|
-
:
|
|
2284
|
-
:param
|
|
2285
|
-
:
|
|
2286
|
-
:param
|
|
2287
|
-
:
|
|
2288
|
-
:param
|
|
2289
|
-
:
|
|
2290
|
-
:param
|
|
2291
|
-
:
|
|
2292
|
-
:
|
|
2469
|
+
:param session_id: 24-character hex ID
|
|
2470
|
+
:type session_id: str
|
|
2471
|
+
:param analysis_id: 24-char hex analysis id
|
|
2472
|
+
:type analysis_id: str
|
|
2473
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2474
|
+
:type filename: str
|
|
2475
|
+
:param ticket: 24-char hex ticket id
|
|
2476
|
+
:type ticket: str, optional
|
|
2477
|
+
:param info: get file info only, defaults to false
|
|
2478
|
+
:type info: bool, optional
|
|
2479
|
+
:param member: get zipfile member
|
|
2480
|
+
:type member: str, optional
|
|
2481
|
+
:param view: feature flag for view/download, defaults to false
|
|
2482
|
+
:type view: bool, optional
|
|
2483
|
+
:param range: byte ranges to return
|
|
2484
|
+
:type range: str, optional
|
|
2485
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2486
|
+
:type x_accept_feature: list[str], optional
|
|
2487
|
+
:param async_: Perform the request asynchronously
|
|
2488
|
+
:type async_: bool, optional
|
|
2489
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2293
2490
|
"""
|
|
2294
2491
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2295
2492
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2312,17 +2509,27 @@ class SessionsApi(object):
|
|
|
2312
2509
|
|
|
2313
2510
|
This method makes a synchronous HTTP request by default.
|
|
2314
2511
|
|
|
2315
|
-
:param
|
|
2316
|
-
:
|
|
2317
|
-
:param
|
|
2318
|
-
:
|
|
2319
|
-
:param
|
|
2320
|
-
:
|
|
2321
|
-
:param
|
|
2322
|
-
:
|
|
2323
|
-
:param
|
|
2324
|
-
:
|
|
2325
|
-
:
|
|
2512
|
+
:param session_id: 24-character hex ID
|
|
2513
|
+
:type session_id: str
|
|
2514
|
+
:param analysis_id: 24-char hex analysis id
|
|
2515
|
+
:type analysis_id: str
|
|
2516
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2517
|
+
:type filename: str
|
|
2518
|
+
:param ticket: 24-char hex ticket id
|
|
2519
|
+
:type ticket: str, optional
|
|
2520
|
+
:param info: get file info only, defaults to false
|
|
2521
|
+
:type info: bool, optional
|
|
2522
|
+
:param member: get zipfile member
|
|
2523
|
+
:type member: str, optional
|
|
2524
|
+
:param view: feature flag for view/download, defaults to false
|
|
2525
|
+
:type view: bool, optional
|
|
2526
|
+
:param range: byte ranges to return
|
|
2527
|
+
:type range: str, optional
|
|
2528
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2529
|
+
:type x_accept_feature: list[str], optional
|
|
2530
|
+
:param async_: Perform the request asynchronously
|
|
2531
|
+
:type async_: bool, optional
|
|
2532
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2326
2533
|
"""
|
|
2327
2534
|
|
|
2328
2535
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2416,17 +2623,27 @@ class SessionsApi(object):
|
|
|
2416
2623
|
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2417
2624
|
This method makes a synchronous HTTP request by default.
|
|
2418
2625
|
|
|
2419
|
-
:param
|
|
2420
|
-
:
|
|
2421
|
-
:param
|
|
2422
|
-
:
|
|
2423
|
-
:param
|
|
2424
|
-
:
|
|
2425
|
-
:param
|
|
2426
|
-
:
|
|
2427
|
-
:param
|
|
2428
|
-
:
|
|
2429
|
-
:
|
|
2626
|
+
:param session_id: 24-character hex ID
|
|
2627
|
+
:type session_id: str
|
|
2628
|
+
:param analysis_id: 24-char hex analysis id
|
|
2629
|
+
:type analysis_id: str
|
|
2630
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2631
|
+
:type filename: str
|
|
2632
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2633
|
+
:type info: bool, optional
|
|
2634
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2635
|
+
:type member: str, optional
|
|
2636
|
+
:param view: feature flag for view/download, defaults to false
|
|
2637
|
+
:type view: bool, optional
|
|
2638
|
+
:param range: byte ranges to return
|
|
2639
|
+
:type range: str, optional
|
|
2640
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2641
|
+
:type x_accept_feature: list[str], optional
|
|
2642
|
+
:param dest_file: Destination file path
|
|
2643
|
+
:type dest_file: str
|
|
2644
|
+
:param async_: Perform the request asynchronously
|
|
2645
|
+
:type async_: bool, optional
|
|
2646
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2430
2647
|
"""
|
|
2431
2648
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2432
2649
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2449,16 +2666,25 @@ class SessionsApi(object):
|
|
|
2449
2666
|
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2450
2667
|
This method makes a synchronous HTTP request by default.
|
|
2451
2668
|
|
|
2452
|
-
:param
|
|
2453
|
-
:
|
|
2454
|
-
:param
|
|
2455
|
-
:
|
|
2456
|
-
:param
|
|
2457
|
-
:
|
|
2458
|
-
:param
|
|
2459
|
-
:
|
|
2460
|
-
:param
|
|
2461
|
-
:
|
|
2669
|
+
:param session_id: 24-character hex ID
|
|
2670
|
+
:type session_id: str
|
|
2671
|
+
:param analysis_id: 24-char hex analysis id
|
|
2672
|
+
:type analysis_id: str
|
|
2673
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2674
|
+
:type filename: str
|
|
2675
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2676
|
+
:type info: bool, optional
|
|
2677
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2678
|
+
:type member: str, optional
|
|
2679
|
+
:param view: feature flag for view/download, defaults to false
|
|
2680
|
+
:type view: bool, optional
|
|
2681
|
+
:param range: byte ranges to return
|
|
2682
|
+
:type range: str, optional
|
|
2683
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2684
|
+
:type x_accept_feature: list[str], optional
|
|
2685
|
+
:param async_: Perform the request asynchronously
|
|
2686
|
+
:type async_: bool, optional
|
|
2687
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2462
2688
|
"""
|
|
2463
2689
|
|
|
2464
2690
|
all_params = ['session_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2550,17 +2776,27 @@ class SessionsApi(object):
|
|
|
2550
2776
|
Does not work on files whose names contain a forward slash.
|
|
2551
2777
|
This method makes a synchronous HTTP request by default.
|
|
2552
2778
|
|
|
2553
|
-
:param
|
|
2554
|
-
:
|
|
2555
|
-
:param
|
|
2556
|
-
:
|
|
2557
|
-
:param
|
|
2558
|
-
:
|
|
2559
|
-
:param
|
|
2560
|
-
:
|
|
2561
|
-
:param
|
|
2562
|
-
:
|
|
2563
|
-
:
|
|
2779
|
+
:param session_id: 24-character hex ID
|
|
2780
|
+
:type session_id: str
|
|
2781
|
+
:param analysis_id: 24-char hex analysis id
|
|
2782
|
+
:type analysis_id: str
|
|
2783
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2784
|
+
:type filename: str
|
|
2785
|
+
:param ticket: ticket id of the outputs to download
|
|
2786
|
+
:type ticket: str, optional
|
|
2787
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2788
|
+
:type info: bool, optional
|
|
2789
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2790
|
+
:type member: str, optional
|
|
2791
|
+
:param view: feature flag for view/download, defaults to false
|
|
2792
|
+
:type view: bool, optional
|
|
2793
|
+
:param range: byte ranges to return
|
|
2794
|
+
:type range: str, optional
|
|
2795
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2796
|
+
:type x_accept_feature: list[str], optional
|
|
2797
|
+
:param async_: Perform the request asynchronously
|
|
2798
|
+
:type async_: bool, optional
|
|
2799
|
+
:rtype: FileZipInfo
|
|
2564
2800
|
"""
|
|
2565
2801
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2566
2802
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2584,17 +2820,27 @@ class SessionsApi(object):
|
|
|
2584
2820
|
Does not work on files whose names contain a forward slash.
|
|
2585
2821
|
This method makes a synchronous HTTP request by default.
|
|
2586
2822
|
|
|
2587
|
-
:param
|
|
2588
|
-
:
|
|
2589
|
-
:param
|
|
2590
|
-
:
|
|
2591
|
-
:param
|
|
2592
|
-
:
|
|
2593
|
-
:param
|
|
2594
|
-
:
|
|
2595
|
-
:param
|
|
2596
|
-
:
|
|
2597
|
-
:
|
|
2823
|
+
:param session_id: 24-character hex ID
|
|
2824
|
+
:type session_id: str
|
|
2825
|
+
:param analysis_id: 24-char hex analysis id
|
|
2826
|
+
:type analysis_id: str
|
|
2827
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2828
|
+
:type filename: str
|
|
2829
|
+
:param ticket: ticket id of the outputs to download
|
|
2830
|
+
:type ticket: str, optional
|
|
2831
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2832
|
+
:type info: bool, optional
|
|
2833
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2834
|
+
:type member: str, optional
|
|
2835
|
+
:param view: feature flag for view/download, defaults to false
|
|
2836
|
+
:type view: bool, optional
|
|
2837
|
+
:param range: byte ranges to return
|
|
2838
|
+
:type range: str, optional
|
|
2839
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2840
|
+
:type x_accept_feature: list[str], optional
|
|
2841
|
+
:param async_: Perform the request asynchronously
|
|
2842
|
+
:type async_: bool, optional
|
|
2843
|
+
:rtype: FileZipInfo
|
|
2598
2844
|
"""
|
|
2599
2845
|
|
|
2600
2846
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2689,17 +2935,27 @@ class SessionsApi(object):
|
|
|
2689
2935
|
|
|
2690
2936
|
This method makes a synchronous HTTP request by default.
|
|
2691
2937
|
|
|
2692
|
-
:param
|
|
2693
|
-
:
|
|
2694
|
-
:param
|
|
2695
|
-
:
|
|
2696
|
-
:param
|
|
2697
|
-
:
|
|
2698
|
-
:param
|
|
2699
|
-
:
|
|
2700
|
-
:param
|
|
2701
|
-
:
|
|
2702
|
-
:
|
|
2938
|
+
:param session_id: 24-character hex ID
|
|
2939
|
+
:type session_id: str
|
|
2940
|
+
:param analysis_id: 24-char hex analysis id
|
|
2941
|
+
:type analysis_id: str
|
|
2942
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2943
|
+
:type filename: str
|
|
2944
|
+
:param ticket: ticket id of the outputs to download
|
|
2945
|
+
:type ticket: str, optional
|
|
2946
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2947
|
+
:type info: bool, optional
|
|
2948
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2949
|
+
:type member: str, optional
|
|
2950
|
+
:param view: feature flag for view/download, defaults to false
|
|
2951
|
+
:type view: bool, optional
|
|
2952
|
+
:param range: byte ranges to return
|
|
2953
|
+
:type range: str, optional
|
|
2954
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2955
|
+
:type x_accept_feature: list[str], optional
|
|
2956
|
+
:param async_: Perform the request asynchronously
|
|
2957
|
+
:type async_: bool, optional
|
|
2958
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2703
2959
|
"""
|
|
2704
2960
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2705
2961
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2722,17 +2978,27 @@ class SessionsApi(object):
|
|
|
2722
2978
|
|
|
2723
2979
|
This method makes a synchronous HTTP request by default.
|
|
2724
2980
|
|
|
2725
|
-
:param
|
|
2726
|
-
:
|
|
2727
|
-
:param
|
|
2728
|
-
:
|
|
2729
|
-
:param
|
|
2730
|
-
:
|
|
2731
|
-
:param
|
|
2732
|
-
:
|
|
2733
|
-
:param
|
|
2734
|
-
:
|
|
2735
|
-
:
|
|
2981
|
+
:param session_id: 24-character hex ID
|
|
2982
|
+
:type session_id: str
|
|
2983
|
+
:param analysis_id: 24-char hex analysis id
|
|
2984
|
+
:type analysis_id: str
|
|
2985
|
+
:param filename: filename to download (get tar of all if empty)
|
|
2986
|
+
:type filename: str
|
|
2987
|
+
:param ticket: ticket id of the outputs to download
|
|
2988
|
+
:type ticket: str, optional
|
|
2989
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
2990
|
+
:type info: bool, optional
|
|
2991
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
2992
|
+
:type member: str, optional
|
|
2993
|
+
:param view: feature flag for view/download, defaults to false
|
|
2994
|
+
:type view: bool, optional
|
|
2995
|
+
:param range: byte ranges to return
|
|
2996
|
+
:type range: str, optional
|
|
2997
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2998
|
+
:type x_accept_feature: list[str], optional
|
|
2999
|
+
:param async_: Perform the request asynchronously
|
|
3000
|
+
:type async_: bool, optional
|
|
3001
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2736
3002
|
"""
|
|
2737
3003
|
|
|
2738
3004
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2826,20 +3092,33 @@ class SessionsApi(object):
|
|
|
2826
3092
|
Finds all sessions.
|
|
2827
3093
|
This method makes a synchronous HTTP request by default.
|
|
2828
3094
|
|
|
2829
|
-
:param
|
|
2830
|
-
:
|
|
2831
|
-
:param
|
|
2832
|
-
:
|
|
2833
|
-
:param
|
|
2834
|
-
:
|
|
2835
|
-
:param
|
|
2836
|
-
:
|
|
2837
|
-
:param
|
|
2838
|
-
:
|
|
2839
|
-
:param
|
|
2840
|
-
:
|
|
2841
|
-
:param
|
|
2842
|
-
:
|
|
3095
|
+
:param exhaustive: Set to return a complete list regardless of permissions, defaults to false
|
|
3096
|
+
:type exhaustive: bool, optional
|
|
3097
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
3098
|
+
:type join_avatars: bool, optional
|
|
3099
|
+
:param join: join file origins
|
|
3100
|
+
:type join: JoinType, optional
|
|
3101
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3102
|
+
:type include_all_info: bool, optional
|
|
3103
|
+
:param user_id:
|
|
3104
|
+
:type user_id: str, optional
|
|
3105
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3106
|
+
:type filter: str, optional
|
|
3107
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3108
|
+
:type sort: str, optional
|
|
3109
|
+
:param limit: The maximum number of entries to return.
|
|
3110
|
+
:type limit: int, optional
|
|
3111
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3112
|
+
:type skip: int, optional
|
|
3113
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3114
|
+
:type page: int, optional
|
|
3115
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3116
|
+
:type after_id: str, optional
|
|
3117
|
+
:param x_accept_feature:, defaults to []
|
|
3118
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3119
|
+
:param async_: Perform the request asynchronously
|
|
3120
|
+
:type async_: bool, optional
|
|
3121
|
+
:rtype: union[Page,list[SessionListOutput]]
|
|
2843
3122
|
"""
|
|
2844
3123
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2845
3124
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2863,20 +3142,33 @@ class SessionsApi(object):
|
|
|
2863
3142
|
Finds all sessions.
|
|
2864
3143
|
This method makes a synchronous HTTP request by default.
|
|
2865
3144
|
|
|
2866
|
-
:param
|
|
2867
|
-
:
|
|
2868
|
-
:param
|
|
2869
|
-
:
|
|
2870
|
-
:param
|
|
2871
|
-
:
|
|
2872
|
-
:param
|
|
2873
|
-
:
|
|
2874
|
-
:param
|
|
2875
|
-
:
|
|
2876
|
-
:param
|
|
2877
|
-
:
|
|
2878
|
-
:param
|
|
2879
|
-
:
|
|
3145
|
+
:param exhaustive: Set to return a complete list regardless of permissions, defaults to false
|
|
3146
|
+
:type exhaustive: bool, optional
|
|
3147
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
3148
|
+
:type join_avatars: bool, optional
|
|
3149
|
+
:param join: join file origins
|
|
3150
|
+
:type join: JoinType, optional
|
|
3151
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3152
|
+
:type include_all_info: bool, optional
|
|
3153
|
+
:param user_id:
|
|
3154
|
+
:type user_id: str, optional
|
|
3155
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3156
|
+
:type filter: str, optional
|
|
3157
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3158
|
+
:type sort: str, optional
|
|
3159
|
+
:param limit: The maximum number of entries to return.
|
|
3160
|
+
:type limit: int, optional
|
|
3161
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3162
|
+
:type skip: int, optional
|
|
3163
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3164
|
+
:type page: int, optional
|
|
3165
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3166
|
+
:type after_id: str, optional
|
|
3167
|
+
:param x_accept_feature:, defaults to []
|
|
3168
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3169
|
+
:param async_: Perform the request asynchronously
|
|
3170
|
+
:type async_: bool, optional
|
|
3171
|
+
:rtype: union[Page,list[SessionListOutput]]
|
|
2880
3172
|
"""
|
|
2881
3173
|
|
|
2882
3174
|
all_params = ['exhaustive','join_avatars','join','include_all_info','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -2964,12 +3256,17 @@ class SessionsApi(object):
|
|
|
2964
3256
|
Get a single session
|
|
2965
3257
|
This method makes a synchronous HTTP request by default.
|
|
2966
3258
|
|
|
2967
|
-
:param
|
|
2968
|
-
:
|
|
2969
|
-
:param
|
|
2970
|
-
:
|
|
2971
|
-
:param
|
|
2972
|
-
:
|
|
3259
|
+
:param session_id:
|
|
3260
|
+
:type session_id: str
|
|
3261
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
3262
|
+
:type join_avatars: bool, optional
|
|
3263
|
+
:param join:
|
|
3264
|
+
:type join: JoinType, optional
|
|
3265
|
+
:param x_accept_feature:, defaults to []
|
|
3266
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3267
|
+
:param async_: Perform the request asynchronously
|
|
3268
|
+
:type async_: bool, optional
|
|
3269
|
+
:rtype: SessionOutput
|
|
2973
3270
|
"""
|
|
2974
3271
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2975
3272
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2993,12 +3290,17 @@ class SessionsApi(object):
|
|
|
2993
3290
|
Get a single session
|
|
2994
3291
|
This method makes a synchronous HTTP request by default.
|
|
2995
3292
|
|
|
2996
|
-
:param
|
|
2997
|
-
:
|
|
2998
|
-
:param
|
|
2999
|
-
:
|
|
3000
|
-
:param
|
|
3001
|
-
:
|
|
3293
|
+
:param session_id:
|
|
3294
|
+
:type session_id: str
|
|
3295
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
3296
|
+
:type join_avatars: bool, optional
|
|
3297
|
+
:param join:
|
|
3298
|
+
:type join: JoinType, optional
|
|
3299
|
+
:param x_accept_feature:, defaults to []
|
|
3300
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3301
|
+
:param async_: Perform the request asynchronously
|
|
3302
|
+
:type async_: bool, optional
|
|
3303
|
+
:rtype: SessionOutput
|
|
3002
3304
|
"""
|
|
3003
3305
|
|
|
3004
3306
|
all_params = ['session_id','join_avatars','join','x_accept_feature',] # noqa: E501
|
|
@@ -3074,20 +3376,33 @@ class SessionsApi(object):
|
|
|
3074
3376
|
Get acquisitions.
|
|
3075
3377
|
This method makes a synchronous HTTP request by default.
|
|
3076
3378
|
|
|
3077
|
-
:param
|
|
3078
|
-
:
|
|
3079
|
-
:param
|
|
3080
|
-
:
|
|
3081
|
-
:param
|
|
3082
|
-
:
|
|
3083
|
-
:param
|
|
3084
|
-
:
|
|
3085
|
-
:param
|
|
3086
|
-
:
|
|
3087
|
-
:param
|
|
3088
|
-
:
|
|
3089
|
-
:param
|
|
3090
|
-
:
|
|
3379
|
+
:param session_id:
|
|
3380
|
+
:type session_id: str
|
|
3381
|
+
:param collection_id:
|
|
3382
|
+
:type collection_id: str, optional
|
|
3383
|
+
:param exhaustive:, defaults to false
|
|
3384
|
+
:type exhaustive: bool, optional
|
|
3385
|
+
:param join:
|
|
3386
|
+
:type join: JoinType, optional
|
|
3387
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3388
|
+
:type include_all_info: bool, optional
|
|
3389
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3390
|
+
:type filter: str, optional
|
|
3391
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3392
|
+
:type sort: str, optional
|
|
3393
|
+
:param limit: The maximum number of entries to return.
|
|
3394
|
+
:type limit: int, optional
|
|
3395
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3396
|
+
:type skip: int, optional
|
|
3397
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3398
|
+
:type page: int, optional
|
|
3399
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3400
|
+
:type after_id: str, optional
|
|
3401
|
+
:param x_accept_feature:, defaults to []
|
|
3402
|
+
:type x_accept_feature: list[str], optional
|
|
3403
|
+
:param async_: Perform the request asynchronously
|
|
3404
|
+
:type async_: bool, optional
|
|
3405
|
+
:rtype: union[list[AcquisitionListOutput],Page]
|
|
3091
3406
|
"""
|
|
3092
3407
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3093
3408
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3111,20 +3426,33 @@ class SessionsApi(object):
|
|
|
3111
3426
|
Get acquisitions.
|
|
3112
3427
|
This method makes a synchronous HTTP request by default.
|
|
3113
3428
|
|
|
3114
|
-
:param
|
|
3115
|
-
:
|
|
3116
|
-
:param
|
|
3117
|
-
:
|
|
3118
|
-
:param
|
|
3119
|
-
:
|
|
3120
|
-
:param
|
|
3121
|
-
:
|
|
3122
|
-
:param
|
|
3123
|
-
:
|
|
3124
|
-
:param
|
|
3125
|
-
:
|
|
3126
|
-
:param
|
|
3127
|
-
:
|
|
3429
|
+
:param session_id:
|
|
3430
|
+
:type session_id: str
|
|
3431
|
+
:param collection_id:
|
|
3432
|
+
:type collection_id: str, optional
|
|
3433
|
+
:param exhaustive:, defaults to false
|
|
3434
|
+
:type exhaustive: bool, optional
|
|
3435
|
+
:param join:
|
|
3436
|
+
:type join: JoinType, optional
|
|
3437
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3438
|
+
:type include_all_info: bool, optional
|
|
3439
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3440
|
+
:type filter: str, optional
|
|
3441
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3442
|
+
:type sort: str, optional
|
|
3443
|
+
:param limit: The maximum number of entries to return.
|
|
3444
|
+
:type limit: int, optional
|
|
3445
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3446
|
+
:type skip: int, optional
|
|
3447
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3448
|
+
:type page: int, optional
|
|
3449
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3450
|
+
:type after_id: str, optional
|
|
3451
|
+
:param x_accept_feature:, defaults to []
|
|
3452
|
+
:type x_accept_feature: list[str], optional
|
|
3453
|
+
:param async_: Perform the request asynchronously
|
|
3454
|
+
:type async_: bool, optional
|
|
3455
|
+
:rtype: union[list[AcquisitionListOutput],Page]
|
|
3128
3456
|
"""
|
|
3129
3457
|
|
|
3130
3458
|
all_params = ['session_id','collection_id','exhaustive','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3216,20 +3544,33 @@ class SessionsApi(object):
|
|
|
3216
3544
|
Returns analyses that directly belong to this resource.
|
|
3217
3545
|
This method makes a synchronous HTTP request by default.
|
|
3218
3546
|
|
|
3219
|
-
:param
|
|
3220
|
-
:
|
|
3221
|
-
:param
|
|
3222
|
-
:
|
|
3223
|
-
:param
|
|
3224
|
-
:
|
|
3225
|
-
:param
|
|
3226
|
-
:
|
|
3227
|
-
:param
|
|
3228
|
-
:
|
|
3229
|
-
:param
|
|
3230
|
-
:
|
|
3231
|
-
:param
|
|
3232
|
-
:
|
|
3547
|
+
:param cid:
|
|
3548
|
+
:type cid: str
|
|
3549
|
+
:param inflate_job:, defaults to false
|
|
3550
|
+
:type inflate_job: bool, optional
|
|
3551
|
+
:param join_avatars:, defaults to false
|
|
3552
|
+
:type join_avatars: bool, optional
|
|
3553
|
+
:param join:
|
|
3554
|
+
:type join: JoinType, optional
|
|
3555
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3556
|
+
:type include_all_info: bool, optional
|
|
3557
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3558
|
+
:type filter: str, optional
|
|
3559
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3560
|
+
:type sort: str, optional
|
|
3561
|
+
:param limit: The maximum number of entries to return.
|
|
3562
|
+
:type limit: int, optional
|
|
3563
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3564
|
+
:type skip: int, optional
|
|
3565
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3566
|
+
:type page: int, optional
|
|
3567
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3568
|
+
:type after_id: str, optional
|
|
3569
|
+
:param x_accept_feature:, defaults to []
|
|
3570
|
+
:type x_accept_feature: list[str], optional
|
|
3571
|
+
:param async_: Perform the request asynchronously
|
|
3572
|
+
:type async_: bool, optional
|
|
3573
|
+
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3233
3574
|
"""
|
|
3234
3575
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3235
3576
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3253,20 +3594,33 @@ class SessionsApi(object):
|
|
|
3253
3594
|
Returns analyses that directly belong to this resource.
|
|
3254
3595
|
This method makes a synchronous HTTP request by default.
|
|
3255
3596
|
|
|
3256
|
-
:param
|
|
3257
|
-
:
|
|
3258
|
-
:param
|
|
3259
|
-
:
|
|
3260
|
-
:param
|
|
3261
|
-
:
|
|
3262
|
-
:param
|
|
3263
|
-
:
|
|
3264
|
-
:param
|
|
3265
|
-
:
|
|
3266
|
-
:param
|
|
3267
|
-
:
|
|
3268
|
-
:param
|
|
3269
|
-
:
|
|
3597
|
+
:param cid:
|
|
3598
|
+
:type cid: str
|
|
3599
|
+
:param inflate_job:, defaults to false
|
|
3600
|
+
:type inflate_job: bool, optional
|
|
3601
|
+
:param join_avatars:, defaults to false
|
|
3602
|
+
:type join_avatars: bool, optional
|
|
3603
|
+
:param join:
|
|
3604
|
+
:type join: JoinType, optional
|
|
3605
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3606
|
+
:type include_all_info: bool, optional
|
|
3607
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3608
|
+
:type filter: str, optional
|
|
3609
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3610
|
+
:type sort: str, optional
|
|
3611
|
+
:param limit: The maximum number of entries to return.
|
|
3612
|
+
:type limit: int, optional
|
|
3613
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3614
|
+
:type skip: int, optional
|
|
3615
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3616
|
+
:type page: int, optional
|
|
3617
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3618
|
+
:type after_id: str, optional
|
|
3619
|
+
:param x_accept_feature:, defaults to []
|
|
3620
|
+
:type x_accept_feature: list[str], optional
|
|
3621
|
+
:param async_: Perform the request asynchronously
|
|
3622
|
+
:type async_: bool, optional
|
|
3623
|
+
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3270
3624
|
"""
|
|
3271
3625
|
|
|
3272
3626
|
all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3358,13 +3712,19 @@ class SessionsApi(object):
|
|
|
3358
3712
|
Get an analysis.
|
|
3359
3713
|
This method makes a synchronous HTTP request by default.
|
|
3360
3714
|
|
|
3361
|
-
:param
|
|
3362
|
-
:
|
|
3363
|
-
:param
|
|
3364
|
-
:
|
|
3365
|
-
:param
|
|
3366
|
-
:
|
|
3367
|
-
:
|
|
3715
|
+
:param cid:
|
|
3716
|
+
:type cid: str
|
|
3717
|
+
:param analysis_id:
|
|
3718
|
+
:type analysis_id: str
|
|
3719
|
+
:param inflate_job: Return job as an object instead of an id, defaults to false
|
|
3720
|
+
:type inflate_job: bool, optional
|
|
3721
|
+
:param join_avatars:, defaults to false
|
|
3722
|
+
:type join_avatars: bool, optional
|
|
3723
|
+
:param join:
|
|
3724
|
+
:type join: JoinType, optional
|
|
3725
|
+
:param async_: Perform the request asynchronously
|
|
3726
|
+
:type async_: bool, optional
|
|
3727
|
+
:rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3368
3728
|
"""
|
|
3369
3729
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3370
3730
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3388,13 +3748,19 @@ class SessionsApi(object):
|
|
|
3388
3748
|
Get an analysis.
|
|
3389
3749
|
This method makes a synchronous HTTP request by default.
|
|
3390
3750
|
|
|
3391
|
-
:param
|
|
3392
|
-
:
|
|
3393
|
-
:param
|
|
3394
|
-
:
|
|
3395
|
-
:param
|
|
3396
|
-
:
|
|
3397
|
-
:
|
|
3751
|
+
:param cid:
|
|
3752
|
+
:type cid: str
|
|
3753
|
+
:param analysis_id:
|
|
3754
|
+
:type analysis_id: str
|
|
3755
|
+
:param inflate_job: Return job as an object instead of an id, defaults to false
|
|
3756
|
+
:type inflate_job: bool, optional
|
|
3757
|
+
:param join_avatars:, defaults to false
|
|
3758
|
+
:type join_avatars: bool, optional
|
|
3759
|
+
:param join:
|
|
3760
|
+
:type join: JoinType, optional
|
|
3761
|
+
:param async_: Perform the request asynchronously
|
|
3762
|
+
:type async_: bool, optional
|
|
3763
|
+
:rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3398
3764
|
"""
|
|
3399
3765
|
|
|
3400
3766
|
all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
|
|
@@ -3475,10 +3841,13 @@ class SessionsApi(object):
|
|
|
3475
3841
|
Get info for a particular file.
|
|
3476
3842
|
This method makes a synchronous HTTP request by default.
|
|
3477
3843
|
|
|
3478
|
-
:param
|
|
3479
|
-
:
|
|
3480
|
-
:param
|
|
3481
|
-
:
|
|
3844
|
+
:param cid: Container Id
|
|
3845
|
+
:type cid: str
|
|
3846
|
+
:param filename:
|
|
3847
|
+
:type filename: str
|
|
3848
|
+
:param async_: Perform the request asynchronously
|
|
3849
|
+
:type async_: bool, optional
|
|
3850
|
+
:rtype: FileOutput
|
|
3482
3851
|
"""
|
|
3483
3852
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3484
3853
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3502,10 +3871,13 @@ class SessionsApi(object):
|
|
|
3502
3871
|
Get info for a particular file.
|
|
3503
3872
|
This method makes a synchronous HTTP request by default.
|
|
3504
3873
|
|
|
3505
|
-
:param
|
|
3506
|
-
:
|
|
3507
|
-
:param
|
|
3508
|
-
:
|
|
3874
|
+
:param cid: Container Id
|
|
3875
|
+
:type cid: str
|
|
3876
|
+
:param filename:
|
|
3877
|
+
:type filename: str
|
|
3878
|
+
:param async_: Perform the request asynchronously
|
|
3879
|
+
:type async_: bool, optional
|
|
3880
|
+
:rtype: FileOutput
|
|
3509
3881
|
"""
|
|
3510
3882
|
|
|
3511
3883
|
all_params = ['cid','filename',] # noqa: E501
|
|
@@ -3580,19 +3952,31 @@ class SessionsApi(object):
|
|
|
3580
3952
|
Gets session jobs.
|
|
3581
3953
|
This method makes a synchronous HTTP request by default.
|
|
3582
3954
|
|
|
3583
|
-
:param
|
|
3584
|
-
:
|
|
3585
|
-
:param
|
|
3586
|
-
:
|
|
3587
|
-
:param
|
|
3588
|
-
:
|
|
3589
|
-
:param
|
|
3590
|
-
:
|
|
3591
|
-
:param
|
|
3592
|
-
:
|
|
3593
|
-
:param
|
|
3594
|
-
:
|
|
3595
|
-
:
|
|
3955
|
+
:param session_id:
|
|
3956
|
+
:type session_id: str
|
|
3957
|
+
:param states: filter results by job state, defaults to []
|
|
3958
|
+
:type states: list[str], optional
|
|
3959
|
+
:param tags: filter results by job tags, defaults to []
|
|
3960
|
+
:type tags: list[str], optional
|
|
3961
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
3962
|
+
:type include_all_info: bool, optional
|
|
3963
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
3964
|
+
:type filter: str, optional
|
|
3965
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3966
|
+
:type sort: str, optional
|
|
3967
|
+
:param limit: The maximum number of entries to return.
|
|
3968
|
+
:type limit: int, optional
|
|
3969
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
3970
|
+
:type skip: int, optional
|
|
3971
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
3972
|
+
:type page: int, optional
|
|
3973
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3974
|
+
:type after_id: str, optional
|
|
3975
|
+
:param x_accept_feature:, defaults to []
|
|
3976
|
+
:type x_accept_feature: list[str], optional
|
|
3977
|
+
:param async_: Perform the request asynchronously
|
|
3978
|
+
:type async_: bool, optional
|
|
3979
|
+
:rtype: union[JobsList,Page]
|
|
3596
3980
|
"""
|
|
3597
3981
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3598
3982
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3616,19 +4000,31 @@ class SessionsApi(object):
|
|
|
3616
4000
|
Gets session jobs.
|
|
3617
4001
|
This method makes a synchronous HTTP request by default.
|
|
3618
4002
|
|
|
3619
|
-
:param
|
|
3620
|
-
:
|
|
3621
|
-
:param
|
|
3622
|
-
:
|
|
3623
|
-
:param
|
|
3624
|
-
:
|
|
3625
|
-
:param
|
|
3626
|
-
:
|
|
3627
|
-
:param
|
|
3628
|
-
:
|
|
3629
|
-
:param
|
|
3630
|
-
:
|
|
3631
|
-
:
|
|
4003
|
+
:param session_id:
|
|
4004
|
+
:type session_id: str
|
|
4005
|
+
:param states: filter results by job state, defaults to []
|
|
4006
|
+
:type states: list[str], optional
|
|
4007
|
+
:param tags: filter results by job tags, defaults to []
|
|
4008
|
+
:type tags: list[str], optional
|
|
4009
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
4010
|
+
:type include_all_info: bool, optional
|
|
4011
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
4012
|
+
:type filter: str, optional
|
|
4013
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
4014
|
+
:type sort: str, optional
|
|
4015
|
+
:param limit: The maximum number of entries to return.
|
|
4016
|
+
:type limit: int, optional
|
|
4017
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
4018
|
+
:type skip: int, optional
|
|
4019
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
4020
|
+
:type page: int, optional
|
|
4021
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
4022
|
+
:type after_id: str, optional
|
|
4023
|
+
:param x_accept_feature:, defaults to []
|
|
4024
|
+
:type x_accept_feature: list[str], optional
|
|
4025
|
+
:param async_: Perform the request asynchronously
|
|
4026
|
+
:type async_: bool, optional
|
|
4027
|
+
:rtype: union[JobsList,Page]
|
|
3632
4028
|
"""
|
|
3633
4029
|
|
|
3634
4030
|
all_params = ['session_id','states','tags','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3720,10 +4116,13 @@ class SessionsApi(object):
|
|
|
3720
4116
|
Get a note of a(n) session
|
|
3721
4117
|
This method makes a synchronous HTTP request by default.
|
|
3722
4118
|
|
|
3723
|
-
:param
|
|
3724
|
-
:
|
|
3725
|
-
:param
|
|
3726
|
-
:
|
|
4119
|
+
:param cid:
|
|
4120
|
+
:type cid: str
|
|
4121
|
+
:param note_id:
|
|
4122
|
+
:type note_id: str
|
|
4123
|
+
:param async_: Perform the request asynchronously
|
|
4124
|
+
:type async_: bool, optional
|
|
4125
|
+
:rtype: Note
|
|
3727
4126
|
"""
|
|
3728
4127
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3729
4128
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3747,10 +4146,13 @@ class SessionsApi(object):
|
|
|
3747
4146
|
Get a note of a(n) session
|
|
3748
4147
|
This method makes a synchronous HTTP request by default.
|
|
3749
4148
|
|
|
3750
|
-
:param
|
|
3751
|
-
:
|
|
3752
|
-
:param
|
|
3753
|
-
:
|
|
4149
|
+
:param cid:
|
|
4150
|
+
:type cid: str
|
|
4151
|
+
:param note_id:
|
|
4152
|
+
:type note_id: str
|
|
4153
|
+
:param async_: Perform the request asynchronously
|
|
4154
|
+
:type async_: bool, optional
|
|
4155
|
+
:rtype: Note
|
|
3754
4156
|
"""
|
|
3755
4157
|
|
|
3756
4158
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -3825,10 +4227,13 @@ class SessionsApi(object):
|
|
|
3825
4227
|
Get the value of a tag, by name
|
|
3826
4228
|
This method makes a synchronous HTTP request by default.
|
|
3827
4229
|
|
|
3828
|
-
:param
|
|
3829
|
-
:
|
|
3830
|
-
:param
|
|
3831
|
-
:
|
|
4230
|
+
:param cid:
|
|
4231
|
+
:type cid: str
|
|
4232
|
+
:param value: The tag to interact with
|
|
4233
|
+
:type value: str
|
|
4234
|
+
:param async_: Perform the request asynchronously
|
|
4235
|
+
:type async_: bool, optional
|
|
4236
|
+
:rtype: str
|
|
3832
4237
|
"""
|
|
3833
4238
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3834
4239
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3852,10 +4257,13 @@ class SessionsApi(object):
|
|
|
3852
4257
|
Get the value of a tag, by name
|
|
3853
4258
|
This method makes a synchronous HTTP request by default.
|
|
3854
4259
|
|
|
3855
|
-
:param
|
|
3856
|
-
:
|
|
3857
|
-
:param
|
|
3858
|
-
:
|
|
4260
|
+
:param cid:
|
|
4261
|
+
:type cid: str
|
|
4262
|
+
:param value: The tag to interact with
|
|
4263
|
+
:type value: str
|
|
4264
|
+
:param async_: Perform the request asynchronously
|
|
4265
|
+
:type async_: bool, optional
|
|
4266
|
+
:rtype: str
|
|
3859
4267
|
"""
|
|
3860
4268
|
|
|
3861
4269
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -3930,10 +4338,13 @@ class SessionsApi(object):
|
|
|
3930
4338
|
Modify a session.
|
|
3931
4339
|
This method makes a synchronous HTTP request by default.
|
|
3932
4340
|
|
|
3933
|
-
:param
|
|
3934
|
-
:
|
|
3935
|
-
:param
|
|
3936
|
-
:
|
|
4341
|
+
:param session_id:
|
|
4342
|
+
:type session_id: str
|
|
4343
|
+
:param body:
|
|
4344
|
+
:type body: SessionModify
|
|
4345
|
+
:param async_: Perform the request asynchronously
|
|
4346
|
+
:type async_: bool, optional
|
|
4347
|
+
:rtype: ModifiedResult
|
|
3937
4348
|
"""
|
|
3938
4349
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3939
4350
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3957,10 +4368,13 @@ class SessionsApi(object):
|
|
|
3957
4368
|
Modify a session.
|
|
3958
4369
|
This method makes a synchronous HTTP request by default.
|
|
3959
4370
|
|
|
3960
|
-
:param
|
|
3961
|
-
:
|
|
3962
|
-
:param
|
|
3963
|
-
:
|
|
4371
|
+
:param session_id:
|
|
4372
|
+
:type session_id: str
|
|
4373
|
+
:param body:
|
|
4374
|
+
:type body: SessionModify
|
|
4375
|
+
:param async_: Perform the request asynchronously
|
|
4376
|
+
:type async_: bool, optional
|
|
4377
|
+
:rtype: ModifiedResult
|
|
3964
4378
|
"""
|
|
3965
4379
|
|
|
3966
4380
|
all_params = ['session_id','body',] # noqa: E501
|
|
@@ -4046,11 +4460,15 @@ class SessionsApi(object):
|
|
|
4046
4460
|
Modify an analysis.
|
|
4047
4461
|
This method makes a synchronous HTTP request by default.
|
|
4048
4462
|
|
|
4049
|
-
:param
|
|
4050
|
-
:
|
|
4051
|
-
:param
|
|
4052
|
-
:
|
|
4053
|
-
:
|
|
4463
|
+
:param cid:
|
|
4464
|
+
:type cid: str
|
|
4465
|
+
:param analysis_id:
|
|
4466
|
+
:type analysis_id: str
|
|
4467
|
+
:param body:
|
|
4468
|
+
:type body: AnalysisModifyInput
|
|
4469
|
+
:param async_: Perform the request asynchronously
|
|
4470
|
+
:type async_: bool, optional
|
|
4471
|
+
:rtype: ModifiedResult
|
|
4054
4472
|
"""
|
|
4055
4473
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4056
4474
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4074,11 +4492,15 @@ class SessionsApi(object):
|
|
|
4074
4492
|
Modify an analysis.
|
|
4075
4493
|
This method makes a synchronous HTTP request by default.
|
|
4076
4494
|
|
|
4077
|
-
:param
|
|
4078
|
-
:
|
|
4079
|
-
:param
|
|
4080
|
-
:
|
|
4081
|
-
:
|
|
4495
|
+
:param cid:
|
|
4496
|
+
:type cid: str
|
|
4497
|
+
:param analysis_id:
|
|
4498
|
+
:type analysis_id: str
|
|
4499
|
+
:param body:
|
|
4500
|
+
:type body: AnalysisModifyInput
|
|
4501
|
+
:param async_: Perform the request asynchronously
|
|
4502
|
+
:type async_: bool, optional
|
|
4503
|
+
:rtype: ModifiedResult
|
|
4082
4504
|
"""
|
|
4083
4505
|
|
|
4084
4506
|
all_params = ['cid','analysis_id','body',] # noqa: E501
|
|
@@ -4170,11 +4592,15 @@ class SessionsApi(object):
|
|
|
4170
4592
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4171
4593
|
This method makes a synchronous HTTP request by default.
|
|
4172
4594
|
|
|
4173
|
-
:param
|
|
4174
|
-
:
|
|
4175
|
-
:param
|
|
4176
|
-
:
|
|
4177
|
-
:
|
|
4595
|
+
:param cid:
|
|
4596
|
+
:type cid: str
|
|
4597
|
+
:param filename:
|
|
4598
|
+
:type filename: str
|
|
4599
|
+
:param body:
|
|
4600
|
+
:type body: FileModifyInput
|
|
4601
|
+
:param async_: Perform the request asynchronously
|
|
4602
|
+
:type async_: bool, optional
|
|
4603
|
+
:rtype: ModifiedResult
|
|
4178
4604
|
"""
|
|
4179
4605
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4180
4606
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4198,11 +4624,15 @@ class SessionsApi(object):
|
|
|
4198
4624
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4199
4625
|
This method makes a synchronous HTTP request by default.
|
|
4200
4626
|
|
|
4201
|
-
:param
|
|
4202
|
-
:
|
|
4203
|
-
:param
|
|
4204
|
-
:
|
|
4205
|
-
:
|
|
4627
|
+
:param cid:
|
|
4628
|
+
:type cid: str
|
|
4629
|
+
:param filename:
|
|
4630
|
+
:type filename: str
|
|
4631
|
+
:param body:
|
|
4632
|
+
:type body: FileModifyInput
|
|
4633
|
+
:param async_: Perform the request asynchronously
|
|
4634
|
+
:type async_: bool, optional
|
|
4635
|
+
:rtype: ModifiedResult
|
|
4206
4636
|
"""
|
|
4207
4637
|
|
|
4208
4638
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4294,11 +4724,15 @@ class SessionsApi(object):
|
|
|
4294
4724
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4295
4725
|
This method makes a synchronous HTTP request by default.
|
|
4296
4726
|
|
|
4297
|
-
:param
|
|
4298
|
-
:
|
|
4299
|
-
:param
|
|
4300
|
-
:
|
|
4301
|
-
:
|
|
4727
|
+
:param cid:
|
|
4728
|
+
:type cid: str
|
|
4729
|
+
:param filename:
|
|
4730
|
+
:type filename: str
|
|
4731
|
+
:param body:
|
|
4732
|
+
:type body: FileClassificationDelta
|
|
4733
|
+
:param async_: Perform the request asynchronously
|
|
4734
|
+
:type async_: bool, optional
|
|
4735
|
+
:rtype: ModifiedResult
|
|
4302
4736
|
"""
|
|
4303
4737
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4304
4738
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4322,11 +4756,15 @@ class SessionsApi(object):
|
|
|
4322
4756
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4323
4757
|
This method makes a synchronous HTTP request by default.
|
|
4324
4758
|
|
|
4325
|
-
:param
|
|
4326
|
-
:
|
|
4327
|
-
:param
|
|
4328
|
-
:
|
|
4329
|
-
:
|
|
4759
|
+
:param cid:
|
|
4760
|
+
:type cid: str
|
|
4761
|
+
:param filename:
|
|
4762
|
+
:type filename: str
|
|
4763
|
+
:param body:
|
|
4764
|
+
:type body: FileClassificationDelta
|
|
4765
|
+
:param async_: Perform the request asynchronously
|
|
4766
|
+
:type async_: bool, optional
|
|
4767
|
+
:rtype: ModifiedResult
|
|
4330
4768
|
"""
|
|
4331
4769
|
|
|
4332
4770
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4418,11 +4856,15 @@ class SessionsApi(object):
|
|
|
4418
4856
|
Modify and return the file 'info' field
|
|
4419
4857
|
This method makes a synchronous HTTP request by default.
|
|
4420
4858
|
|
|
4421
|
-
:param
|
|
4422
|
-
:
|
|
4423
|
-
:param
|
|
4424
|
-
:
|
|
4425
|
-
:
|
|
4859
|
+
:param cid:
|
|
4860
|
+
:type cid: str
|
|
4861
|
+
:param filename:
|
|
4862
|
+
:type filename: str
|
|
4863
|
+
:param body:
|
|
4864
|
+
:type body: Info
|
|
4865
|
+
:param async_: Perform the request asynchronously
|
|
4866
|
+
:type async_: bool, optional
|
|
4867
|
+
:rtype: ModifiedResult
|
|
4426
4868
|
"""
|
|
4427
4869
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4428
4870
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4446,11 +4888,15 @@ class SessionsApi(object):
|
|
|
4446
4888
|
Modify and return the file 'info' field
|
|
4447
4889
|
This method makes a synchronous HTTP request by default.
|
|
4448
4890
|
|
|
4449
|
-
:param
|
|
4450
|
-
:
|
|
4451
|
-
:param
|
|
4452
|
-
:
|
|
4453
|
-
:
|
|
4891
|
+
:param cid:
|
|
4892
|
+
:type cid: str
|
|
4893
|
+
:param filename:
|
|
4894
|
+
:type filename: str
|
|
4895
|
+
:param body:
|
|
4896
|
+
:type body: Info
|
|
4897
|
+
:param async_: Perform the request asynchronously
|
|
4898
|
+
:type async_: bool, optional
|
|
4899
|
+
:rtype: ModifiedResult
|
|
4454
4900
|
"""
|
|
4455
4901
|
|
|
4456
4902
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4542,10 +4988,13 @@ class SessionsApi(object):
|
|
|
4542
4988
|
Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4543
4989
|
This method makes a synchronous HTTP request by default.
|
|
4544
4990
|
|
|
4545
|
-
:param
|
|
4546
|
-
:
|
|
4547
|
-
:param
|
|
4548
|
-
:
|
|
4991
|
+
:param cid:
|
|
4992
|
+
:type cid: str
|
|
4993
|
+
:param body:
|
|
4994
|
+
:type body: Info
|
|
4995
|
+
:param async_: Perform the request asynchronously
|
|
4996
|
+
:type async_: bool, optional
|
|
4997
|
+
:rtype: ModifiedResult
|
|
4549
4998
|
"""
|
|
4550
4999
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4551
5000
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4569,10 +5018,13 @@ class SessionsApi(object):
|
|
|
4569
5018
|
Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4570
5019
|
This method makes a synchronous HTTP request by default.
|
|
4571
5020
|
|
|
4572
|
-
:param
|
|
4573
|
-
:
|
|
4574
|
-
:param
|
|
4575
|
-
:
|
|
5021
|
+
:param cid:
|
|
5022
|
+
:type cid: str
|
|
5023
|
+
:param body:
|
|
5024
|
+
:type body: Info
|
|
5025
|
+
:param async_: Perform the request asynchronously
|
|
5026
|
+
:type async_: bool, optional
|
|
5027
|
+
:rtype: ModifiedResult
|
|
4576
5028
|
"""
|
|
4577
5029
|
|
|
4578
5030
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -4658,11 +5110,15 @@ class SessionsApi(object):
|
|
|
4658
5110
|
Update a note of a(n) session
|
|
4659
5111
|
This method makes a synchronous HTTP request by default.
|
|
4660
5112
|
|
|
4661
|
-
:param
|
|
4662
|
-
:
|
|
4663
|
-
:param
|
|
4664
|
-
:
|
|
4665
|
-
:
|
|
5113
|
+
:param cid:
|
|
5114
|
+
:type cid: str
|
|
5115
|
+
:param note_id:
|
|
5116
|
+
:type note_id: str
|
|
5117
|
+
:param body:
|
|
5118
|
+
:type body: NoteInput
|
|
5119
|
+
:param async_: Perform the request asynchronously
|
|
5120
|
+
:type async_: bool, optional
|
|
5121
|
+
:rtype: int
|
|
4666
5122
|
"""
|
|
4667
5123
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4668
5124
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4686,11 +5142,15 @@ class SessionsApi(object):
|
|
|
4686
5142
|
Update a note of a(n) session
|
|
4687
5143
|
This method makes a synchronous HTTP request by default.
|
|
4688
5144
|
|
|
4689
|
-
:param
|
|
4690
|
-
:
|
|
4691
|
-
:param
|
|
4692
|
-
:
|
|
4693
|
-
:
|
|
5145
|
+
:param cid:
|
|
5146
|
+
:type cid: str
|
|
5147
|
+
:param note_id:
|
|
5148
|
+
:type note_id: str
|
|
5149
|
+
:param body:
|
|
5150
|
+
:type body: NoteInput
|
|
5151
|
+
:param async_: Perform the request asynchronously
|
|
5152
|
+
:type async_: bool, optional
|
|
5153
|
+
:rtype: int
|
|
4694
5154
|
"""
|
|
4695
5155
|
|
|
4696
5156
|
all_params = ['cid','note_id','body',] # noqa: E501
|
|
@@ -4782,11 +5242,15 @@ class SessionsApi(object):
|
|
|
4782
5242
|
Rename a tag
|
|
4783
5243
|
This method makes a synchronous HTTP request by default.
|
|
4784
5244
|
|
|
4785
|
-
:param
|
|
4786
|
-
:
|
|
4787
|
-
:param
|
|
4788
|
-
:
|
|
4789
|
-
:
|
|
5245
|
+
:param cid:
|
|
5246
|
+
:type cid: str
|
|
5247
|
+
:param value: The tag to interact with
|
|
5248
|
+
:type value: str
|
|
5249
|
+
:param body:
|
|
5250
|
+
:type body: Tag
|
|
5251
|
+
:param async_: Perform the request asynchronously
|
|
5252
|
+
:type async_: bool, optional
|
|
5253
|
+
:rtype: str
|
|
4790
5254
|
"""
|
|
4791
5255
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4792
5256
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4810,11 +5274,15 @@ class SessionsApi(object):
|
|
|
4810
5274
|
Rename a tag
|
|
4811
5275
|
This method makes a synchronous HTTP request by default.
|
|
4812
5276
|
|
|
4813
|
-
:param
|
|
4814
|
-
:
|
|
4815
|
-
:param
|
|
4816
|
-
:
|
|
4817
|
-
:
|
|
5277
|
+
:param cid:
|
|
5278
|
+
:type cid: str
|
|
5279
|
+
:param value: The tag to interact with
|
|
5280
|
+
:type value: str
|
|
5281
|
+
:param body:
|
|
5282
|
+
:type body: Tag
|
|
5283
|
+
:param async_: Perform the request asynchronously
|
|
5284
|
+
:type async_: bool, optional
|
|
5285
|
+
:rtype: str
|
|
4818
5286
|
"""
|
|
4819
5287
|
|
|
4820
5288
|
all_params = ['cid','value','body',] # noqa: E501
|
|
@@ -4906,10 +5374,13 @@ class SessionsApi(object):
|
|
|
4906
5374
|
Smart copy a session
|
|
4907
5375
|
This method makes a synchronous HTTP request by default.
|
|
4908
5376
|
|
|
4909
|
-
:param
|
|
4910
|
-
:
|
|
4911
|
-
:param
|
|
4912
|
-
:
|
|
5377
|
+
:param session_id:
|
|
5378
|
+
:type session_id: str
|
|
5379
|
+
:param body:
|
|
5380
|
+
:type body: SessionCopyInput
|
|
5381
|
+
:param async_: Perform the request asynchronously
|
|
5382
|
+
:type async_: bool, optional
|
|
5383
|
+
:rtype: Session
|
|
4913
5384
|
"""
|
|
4914
5385
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4915
5386
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4933,10 +5404,13 @@ class SessionsApi(object):
|
|
|
4933
5404
|
Smart copy a session
|
|
4934
5405
|
This method makes a synchronous HTTP request by default.
|
|
4935
5406
|
|
|
4936
|
-
:param
|
|
4937
|
-
:
|
|
4938
|
-
:param
|
|
4939
|
-
:
|
|
5407
|
+
:param session_id:
|
|
5408
|
+
:type session_id: str
|
|
5409
|
+
:param body:
|
|
5410
|
+
:type body: SessionCopyInput
|
|
5411
|
+
:param async_: Perform the request asynchronously
|
|
5412
|
+
:type async_: bool, optional
|
|
5413
|
+
:rtype: Session
|
|
4940
5414
|
"""
|
|
4941
5415
|
|
|
4942
5416
|
all_params = ['session_id','body',] # noqa: E501
|
|
@@ -5022,18 +5496,29 @@ class SessionsApi(object):
|
|
|
5022
5496
|
Upload a file to a(n) session.
|
|
5023
5497
|
This method makes a synchronous HTTP request by default.
|
|
5024
5498
|
|
|
5025
|
-
:param
|
|
5026
|
-
:
|
|
5027
|
-
:param
|
|
5028
|
-
:
|
|
5029
|
-
:param
|
|
5030
|
-
:
|
|
5031
|
-
:param
|
|
5032
|
-
:
|
|
5033
|
-
:param
|
|
5034
|
-
:
|
|
5035
|
-
:param
|
|
5036
|
-
:
|
|
5499
|
+
:param container_id:
|
|
5500
|
+
:type container_id: str
|
|
5501
|
+
:param file: The file to upload
|
|
5502
|
+
:type file: str
|
|
5503
|
+
:param preserve_metadata:, defaults to false
|
|
5504
|
+
:type preserve_metadata: bool, optional
|
|
5505
|
+
:param ticket:
|
|
5506
|
+
:type ticket: str, optional
|
|
5507
|
+
:param id:
|
|
5508
|
+
:type id: str, optional
|
|
5509
|
+
:param level:
|
|
5510
|
+
:type level: ContainerType, optional
|
|
5511
|
+
:param job:
|
|
5512
|
+
:type job: str, optional
|
|
5513
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5514
|
+
:type metadata: object, optional
|
|
5515
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
5516
|
+
:type x_accept_feature: list[str], optional
|
|
5517
|
+
:param content_type:
|
|
5518
|
+
:type content_type: str, optional
|
|
5519
|
+
:param async_: Perform the request asynchronously
|
|
5520
|
+
:type async_: bool, optional
|
|
5521
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
5037
5522
|
"""
|
|
5038
5523
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5039
5524
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5057,18 +5542,29 @@ class SessionsApi(object):
|
|
|
5057
5542
|
Upload a file to a(n) session.
|
|
5058
5543
|
This method makes a synchronous HTTP request by default.
|
|
5059
5544
|
|
|
5060
|
-
:param
|
|
5061
|
-
:
|
|
5062
|
-
:param
|
|
5063
|
-
:
|
|
5064
|
-
:param
|
|
5065
|
-
:
|
|
5066
|
-
:param
|
|
5067
|
-
:
|
|
5068
|
-
:param
|
|
5069
|
-
:
|
|
5070
|
-
:param
|
|
5071
|
-
:
|
|
5545
|
+
:param container_id:
|
|
5546
|
+
:type container_id: str
|
|
5547
|
+
:param file: The file to upload
|
|
5548
|
+
:type file: str
|
|
5549
|
+
:param preserve_metadata:, defaults to false
|
|
5550
|
+
:type preserve_metadata: bool, optional
|
|
5551
|
+
:param ticket:
|
|
5552
|
+
:type ticket: str, optional
|
|
5553
|
+
:param id:
|
|
5554
|
+
:type id: str, optional
|
|
5555
|
+
:param level:
|
|
5556
|
+
:type level: ContainerType, optional
|
|
5557
|
+
:param job:
|
|
5558
|
+
:type job: str, optional
|
|
5559
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5560
|
+
:type metadata: object, optional
|
|
5561
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
5562
|
+
:type x_accept_feature: list[str], optional
|
|
5563
|
+
:param content_type:
|
|
5564
|
+
:type content_type: str, optional
|
|
5565
|
+
:param async_: Perform the request asynchronously
|
|
5566
|
+
:type async_: bool, optional
|
|
5567
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
5072
5568
|
"""
|
|
5073
5569
|
|
|
5074
5570
|
all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|
|
@@ -5164,16 +5660,25 @@ class SessionsApi(object):
|
|
|
5164
5660
|
Upload an output file to an analysis
|
|
5165
5661
|
This method makes a synchronous HTTP request by default.
|
|
5166
5662
|
|
|
5167
|
-
:param
|
|
5168
|
-
:
|
|
5169
|
-
:param
|
|
5170
|
-
:
|
|
5171
|
-
:param
|
|
5172
|
-
:
|
|
5173
|
-
:param
|
|
5174
|
-
:
|
|
5175
|
-
:param
|
|
5176
|
-
:
|
|
5663
|
+
:param cid:
|
|
5664
|
+
:type cid: str
|
|
5665
|
+
:param analysis_id:
|
|
5666
|
+
:type analysis_id: str
|
|
5667
|
+
:param file: The file to upload
|
|
5668
|
+
:type file: str
|
|
5669
|
+
:param ticket:
|
|
5670
|
+
:type ticket: str, optional
|
|
5671
|
+
:param id:
|
|
5672
|
+
:type id: str, optional
|
|
5673
|
+
:param level:
|
|
5674
|
+
:type level: ContainerType, optional
|
|
5675
|
+
:param job:
|
|
5676
|
+
:type job: str, optional
|
|
5677
|
+
:param content_type:
|
|
5678
|
+
:type content_type: str, optional
|
|
5679
|
+
:param async_: Perform the request asynchronously
|
|
5680
|
+
:type async_: bool, optional
|
|
5681
|
+
:rtype: list[FileOutput]
|
|
5177
5682
|
"""
|
|
5178
5683
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5179
5684
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5197,16 +5702,25 @@ class SessionsApi(object):
|
|
|
5197
5702
|
Upload an output file to an analysis
|
|
5198
5703
|
This method makes a synchronous HTTP request by default.
|
|
5199
5704
|
|
|
5200
|
-
:param
|
|
5201
|
-
:
|
|
5202
|
-
:param
|
|
5203
|
-
:
|
|
5204
|
-
:param
|
|
5205
|
-
:
|
|
5206
|
-
:param
|
|
5207
|
-
:
|
|
5208
|
-
:param
|
|
5209
|
-
:
|
|
5705
|
+
:param cid:
|
|
5706
|
+
:type cid: str
|
|
5707
|
+
:param analysis_id:
|
|
5708
|
+
:type analysis_id: str
|
|
5709
|
+
:param file: The file to upload
|
|
5710
|
+
:type file: str
|
|
5711
|
+
:param ticket:
|
|
5712
|
+
:type ticket: str, optional
|
|
5713
|
+
:param id:
|
|
5714
|
+
:type id: str, optional
|
|
5715
|
+
:param level:
|
|
5716
|
+
:type level: ContainerType, optional
|
|
5717
|
+
:param job:
|
|
5718
|
+
:type job: str, optional
|
|
5719
|
+
:param content_type:
|
|
5720
|
+
:type content_type: str, optional
|
|
5721
|
+
:param async_: Perform the request asynchronously
|
|
5722
|
+
:type async_: bool, optional
|
|
5723
|
+
:rtype: list[FileOutput]
|
|
5210
5724
|
"""
|
|
5211
5725
|
|
|
5212
5726
|
all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
|