flywheel-sdk 21.4.0__py3-none-any.whl → 21.4.0rc0__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/api/acquisitions_api.py +562 -1033
- flywheel/api/analyses_api.py +425 -786
- flywheel/api/audit_trail_api.py +44 -78
- flywheel/api/auth_api.py +4 -6
- flywheel/api/batch_api.py +36 -60
- flywheel/api/bulk_api.py +6 -10
- flywheel/api/change_log_api.py +22 -40
- flywheel/api/collections_api.py +403 -740
- flywheel/api/config_api.py +12 -18
- flywheel/api/container_tasks_api.py +8 -14
- flywheel/api/container_type_api.py +8 -14
- flywheel/api/containers_api.py +538 -989
- flywheel/api/custom_filters_api.py +36 -64
- flywheel/api/data_view_executions_api.py +52 -94
- flywheel/api/dataexplorer_api.py +90 -158
- flywheel/api/devices_api.py +76 -132
- flywheel/api/dimse_api.py +44 -72
- flywheel/api/download_api.py +25 -46
- flywheel/api/files_api.py +150 -266
- flywheel/api/form_responses_api.py +56 -100
- flywheel/api/gears_api.py +156 -278
- flywheel/api/groups_api.py +238 -426
- flywheel/api/jobs_api.py +166 -288
- flywheel/api/jupyterlab_servers_api.py +14 -24
- flywheel/api/modalities_api.py +44 -78
- flywheel/api/packfiles_api.py +4 -6
- flywheel/api/projects_api.py +854 -1565
- flywheel/api/protocols_api.py +54 -94
- flywheel/api/reports_api.py +108 -196
- flywheel/api/resolve_api.py +26 -48
- flywheel/api/roles_api.py +46 -82
- flywheel/api/sessions_api.py +616 -1137
- flywheel/api/site_api.py +106 -182
- flywheel/api/staffing_pools_api.py +50 -88
- flywheel/api/subjects_api.py +596 -1095
- flywheel/api/tasks_api.py +62 -108
- flywheel/api/tree_api.py +28 -52
- flywheel/api/uids_api.py +6 -10
- flywheel/api/upload_api.py +88 -162
- flywheel/api/users_api.py +228 -418
- flywheel/api/views_api.py +120 -222
- flywheel/api_client.py +1 -1
- flywheel/configuration.py +2 -2
- flywheel/flywheel.py +4422 -811
- flywheel/models/access_permission.py +7 -13
- flywheel/models/access_permission_output.py +7 -13
- flywheel/models/access_permission_update.py +4 -8
- flywheel/models/acquisition_copy_input.py +10 -18
- flywheel/models/acquisition_input.py +19 -33
- flywheel/models/acquisition_list_output.py +70 -118
- flywheel/models/acquisition_modify_input.py +19 -33
- flywheel/models/acquisition_output.py +70 -118
- flywheel/models/acquisition_parents.py +13 -23
- flywheel/models/acquisition_template_options.py +16 -28
- flywheel/models/acquisition_upsert_input.py +28 -48
- flywheel/models/acquisition_upsert_output.py +13 -23
- flywheel/models/adhoc_analysis_input.py +13 -23
- flywheel/models/analysis_files_create_ticket_output.py +13 -23
- flywheel/models/analysis_input.py +19 -33
- flywheel/models/analysis_list_output.py +61 -103
- flywheel/models/analysis_list_output_inflated_job.py +58 -98
- flywheel/models/analysis_modify_input.py +7 -13
- flywheel/models/analysis_output.py +61 -103
- flywheel/models/analysis_output_inflated_job.py +61 -103
- flywheel/models/analysis_parents.py +16 -28
- flywheel/models/api_key_input_with_optional_label.py +7 -13
- flywheel/models/api_key_output.py +19 -33
- flywheel/models/as_storage.py +19 -33
- flywheel/models/assignee.py +7 -13
- flywheel/models/audit_trail_report.py +40 -68
- flywheel/models/auth0_auth_out.py +22 -38
- flywheel/models/auth0_options_out.py +22 -38
- flywheel/models/auth_out.py +19 -33
- flywheel/models/auth_session_output.py +16 -28
- flywheel/models/avatars.py +10 -18
- flywheel/models/aws_creds.py +7 -13
- flywheel/models/aws_storage.py +25 -43
- flywheel/models/azure_creds.py +7 -13
- flywheel/models/base_aet.py +13 -23
- flywheel/models/base_compute.py +34 -58
- flywheel/models/batch.py +25 -43
- flywheel/models/batch_create_filters.py +10 -18
- flywheel/models/batch_job_analysis_input.py +16 -28
- flywheel/models/bookmark.py +7 -13
- flywheel/models/bulk_move_input.py +16 -28
- flywheel/models/cancelled_batch_output.py +4 -8
- flywheel/models/catalog_list_output.py +31 -53
- flywheel/models/central_out.py +19 -33
- flywheel/models/change.py +31 -53
- flywheel/models/change_log_document.py +13 -23
- flywheel/models/classic_batch_job_output.py +25 -43
- flywheel/models/classic_batch_job_output_inflated_jobs.py +28 -48
- flywheel/models/classic_batch_proposal_input.py +28 -48
- flywheel/models/classic_batch_proposal_output.py +37 -63
- flywheel/models/collection_input.py +10 -18
- flywheel/models/collection_input_with_contents.py +13 -23
- flywheel/models/collection_node.py +7 -13
- flywheel/models/collection_operation.py +7 -13
- flywheel/models/collection_output.py +55 -93
- flywheel/models/collection_with_stats.py +55 -93
- flywheel/models/column.py +16 -28
- flywheel/models/common_classification.py +1 -3
- flywheel/models/common_info.py +1 -3
- flywheel/models/complete_multipart_upload_output.py +7 -13
- flywheel/models/complete_s3_multipart_upload_input.py +13 -23
- flywheel/models/config_out.py +28 -48
- flywheel/models/container_filter.py +7 -13
- flywheel/models/container_id_view_input.py +43 -73
- flywheel/models/container_id_view_input_execute_and_save.py +19 -33
- flywheel/models/container_modify.py +43 -73
- flywheel/models/container_node_min.py +25 -43
- flywheel/models/container_output_with_files.py +16 -28
- flywheel/models/container_parents.py +19 -33
- flywheel/models/container_pipeline_input.py +43 -73
- flywheel/models/container_reference.py +7 -13
- flywheel/models/container_reference_with_label.py +10 -18
- flywheel/models/container_uidcheck.py +13 -23
- flywheel/models/container_update.py +1 -3
- flywheel/models/context_input.py +10 -18
- flywheel/models/copy_filter.py +19 -33
- flywheel/models/core_models_api_key_api_key_input.py +7 -13
- flywheel/models/core_models_audit_trail_create_report_input.py +16 -28
- flywheel/models/core_models_audit_trail_modify_report_input.py +4 -8
- flywheel/models/core_models_common_source.py +7 -13
- flywheel/models/core_models_jobs_api_key_input.py +7 -13
- flywheel/models/core_workflows_form_responses_models_form_parents.py +19 -33
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +34 -58
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +19 -33
- flywheel/models/creds.py +1 -3
- flywheel/models/curator.py +10 -18
- flywheel/models/current_user_output.py +64 -108
- flywheel/models/custom_field.py +34 -58
- flywheel/models/custom_form.py +13 -23
- flywheel/models/cvat_info.py +16 -28
- flywheel/models/cvat_settings.py +16 -28
- flywheel/models/cvat_settings_input.py +16 -28
- flywheel/models/daily_report_usage.py +46 -78
- flywheel/models/data_view_analysis_file_spec.py +10 -18
- flywheel/models/data_view_analysis_filter_spec.py +10 -18
- flywheel/models/data_view_column_alias.py +22 -38
- flywheel/models/data_view_column_spec.py +16 -28
- flywheel/models/data_view_execution.py +40 -68
- flywheel/models/data_view_file_spec.py +28 -48
- flywheel/models/data_view_group_by.py +4 -8
- flywheel/models/data_view_group_by_column.py +7 -13
- flywheel/models/data_view_name_filter_spec.py +7 -13
- flywheel/models/data_view_zip_filter_spec.py +10 -18
- flywheel/models/delete_by_search_query.py +13 -23
- flywheel/models/deleted_file.py +43 -73
- flywheel/models/deleted_result.py +10 -18
- flywheel/models/device.py +34 -58
- flywheel/models/device_admin_update.py +7 -13
- flywheel/models/device_create.py +10 -18
- flywheel/models/device_self_update.py +16 -28
- flywheel/models/device_status_entry.py +10 -18
- flywheel/models/device_storage_strategy_update.py +7 -13
- flywheel/models/download.py +13 -23
- flywheel/models/download_container_filter.py +4 -8
- flywheel/models/download_container_filter_definition.py +10 -18
- flywheel/models/download_filter.py +10 -18
- flywheel/models/download_filter_definition.py +7 -13
- flywheel/models/download_node.py +7 -13
- flywheel/models/download_ticket_stub.py +13 -23
- flywheel/models/e_signature.py +13 -23
- flywheel/models/edition.py +4 -8
- flywheel/models/egress_device.py +52 -88
- flywheel/models/egress_device_page.py +10 -18
- flywheel/models/egress_provider.py +31 -53
- flywheel/models/egress_provider_id.py +4 -8
- flywheel/models/exchange_storage.py +13 -23
- flywheel/models/executor_info.py +25 -43
- flywheel/models/export_templates.py +7 -13
- flywheel/models/features.py +193 -323
- flywheel/models/field_change.py +16 -28
- flywheel/models/field_change_log_document.py +13 -23
- flywheel/models/file.py +112 -188
- flywheel/models/file_classification_delta.py +13 -23
- flywheel/models/file_entry.py +64 -108
- flywheel/models/file_export_templates.py +16 -28
- flywheel/models/file_gear_info.py +10 -18
- flywheel/models/file_list_output.py +109 -183
- flywheel/models/file_modify_input.py +7 -13
- flywheel/models/file_move_input.py +10 -18
- flywheel/models/file_node.py +112 -188
- flywheel/models/file_node_min.py +22 -38
- flywheel/models/file_origin.py +16 -28
- flywheel/models/file_output.py +109 -183
- flywheel/models/file_parents.py +19 -33
- flywheel/models/file_reference.py +10 -18
- flywheel/models/file_suggestion.py +13 -23
- flywheel/models/file_template_options.py +19 -33
- flywheel/models/file_upsert_input.py +52 -88
- flywheel/models/file_upsert_output.py +112 -188
- flywheel/models/file_version.py +7 -13
- flywheel/models/file_version_copy_of.py +16 -28
- flywheel/models/file_version_output.py +22 -38
- flywheel/models/file_via.py +13 -23
- flywheel/models/filter.py +25 -43
- flywheel/models/filter_input.py +10 -18
- flywheel/models/filter_values.py +7 -13
- flywheel/models/fixed_file_version_input.py +10 -18
- flywheel/models/fixed_input.py +19 -33
- flywheel/models/form_definition.py +4 -8
- flywheel/models/form_response_base.py +19 -33
- flywheel/models/form_response_create.py +7 -13
- flywheel/models/gcp_creds.py +31 -53
- flywheel/models/gcp_storage.py +19 -33
- flywheel/models/gear.py +52 -88
- flywheel/models/gear_config.py +1 -3
- flywheel/models/gear_context_input.py +4 -8
- flywheel/models/gear_context_value_output.py +16 -28
- flywheel/models/gear_context_value_output_unfound.py +4 -8
- flywheel/models/gear_custom.py +1 -3
- flywheel/models/gear_directive.py +1 -3
- flywheel/models/gear_document.py +22 -38
- flywheel/models/gear_document_input.py +19 -33
- flywheel/models/gear_document_legacy_input.py +19 -33
- flywheel/models/gear_environment.py +1 -3
- flywheel/models/gear_exchange.py +10 -18
- flywheel/models/gear_file_input.py +7 -13
- flywheel/models/gear_id_output.py +4 -8
- flywheel/models/gear_info.py +13 -23
- flywheel/models/gear_input_item.py +10 -18
- flywheel/models/gear_inputs.py +1 -3
- flywheel/models/gear_key_input.py +7 -13
- flywheel/models/gear_manifest.py +55 -93
- flywheel/models/gear_node.py +25 -43
- flywheel/models/gear_output_configuration.py +4 -8
- flywheel/models/gear_permissions.py +7 -13
- flywheel/models/gear_permissions_input.py +4 -8
- flywheel/models/gear_rule.py +61 -103
- flywheel/models/gear_rule_condition.py +10 -18
- flywheel/models/gear_rule_input.py +46 -78
- flywheel/models/gear_rule_modify_input.py +43 -73
- flywheel/models/gear_rule_output.py +61 -103
- flywheel/models/gear_save_submission.py +10 -18
- flywheel/models/gear_series.py +19 -33
- flywheel/models/gear_series_update.py +4 -8
- flywheel/models/gear_suggestion_output.py +19 -33
- flywheel/models/gear_ticket.py +13 -23
- flywheel/models/gear_ticket_output.py +4 -8
- flywheel/models/graph_filter.py +22 -38
- flywheel/models/group_by.py +4 -8
- flywheel/models/group_input.py +13 -23
- flywheel/models/group_output.py +37 -63
- flywheel/models/group_report.py +10 -18
- flywheel/models/group_role.py +4 -8
- flywheel/models/group_settings_output.py +13 -23
- flywheel/models/group_update.py +13 -23
- flywheel/models/hierarchy_export_templates.py +16 -28
- flywheel/models/http_validation_error.py +4 -8
- flywheel/models/info.py +10 -18
- flywheel/models/ingress_provider.py +19 -33
- flywheel/models/ingress_providers.py +16 -28
- flywheel/models/ingress_site_settings.py +16 -28
- flywheel/models/ingress_update_provider.py +10 -18
- flywheel/models/inline_response200.py +4 -8
- flywheel/models/inline_response2001.py +4 -8
- flywheel/models/inline_response2002.py +4 -8
- flywheel/models/input_filter.py +10 -18
- flywheel/models/input_job.py +43 -73
- flywheel/models/input_job_profile.py +16 -28
- flywheel/models/inserted_id.py +4 -8
- flywheel/models/job.py +76 -128
- flywheel/models/job_analysis_input.py +16 -28
- flywheel/models/job_ask.py +19 -33
- flywheel/models/job_ask_response.py +7 -13
- flywheel/models/job_ask_response_job.py +94 -158
- flywheel/models/job_ask_return_criteria.py +13 -23
- flywheel/models/job_ask_state_response.py +4 -8
- flywheel/models/job_complete.py +10 -18
- flywheel/models/job_config.py +1 -3
- flywheel/models/job_config_input.py +16 -28
- flywheel/models/job_destination.py +7 -13
- flywheel/models/job_detail.py +88 -148
- flywheel/models/job_detail_container.py +7 -13
- flywheel/models/job_detail_file_entry.py +7 -13
- flywheel/models/job_detail_group.py +7 -13
- flywheel/models/job_detail_parent_info.py +19 -33
- flywheel/models/job_executor_info.py +25 -43
- flywheel/models/job_file_input.py +13 -23
- flywheel/models/job_file_input_list_output.py +13 -23
- flywheel/models/job_file_object.py +34 -58
- flywheel/models/job_file_object_list_output.py +31 -53
- flywheel/models/job_inputs_array_item.py +19 -33
- flywheel/models/job_inputs_item.py +13 -23
- flywheel/models/job_inputs_object.py +1 -3
- flywheel/models/job_list_output.py +94 -158
- flywheel/models/job_list_output_config.py +10 -18
- flywheel/models/job_log.py +7 -13
- flywheel/models/job_log_record.py +7 -13
- flywheel/models/job_modify.py +7 -13
- flywheel/models/job_origin.py +7 -13
- flywheel/models/job_output.py +97 -163
- flywheel/models/job_output_config.py +13 -23
- flywheel/models/job_parents.py +19 -33
- flywheel/models/job_priority_update.py +7 -13
- flywheel/models/job_profile.py +31 -53
- flywheel/models/job_request.py +10 -18
- flywheel/models/job_request_item.py +13 -23
- flywheel/models/job_request_target.py +16 -28
- flywheel/models/job_ticket_output.py +4 -8
- flywheel/models/job_transition_times.py +13 -23
- flywheel/models/job_version_info.py +1 -3
- flywheel/models/jobs_by_state.py +16 -28
- flywheel/models/jobs_list.py +4 -8
- flywheel/models/join_origin_device.py +4 -8
- flywheel/models/join_origin_job.py +10 -18
- flywheel/models/join_origin_user.py +7 -13
- flywheel/models/join_origins.py +10 -18
- flywheel/models/jupyterhub_workspace.py +4 -8
- flywheel/models/jupyterlab_server_modify.py +16 -28
- flywheel/models/jupyterlab_server_response.py +31 -53
- flywheel/models/ldap_sync_config.py +4 -8
- flywheel/models/ldap_sync_status.py +13 -23
- flywheel/models/legacy_api_key_output.py +16 -28
- flywheel/models/legacy_input.py +13 -23
- flywheel/models/legacy_usage_report.py +19 -33
- flywheel/models/legacys_usage_project_entry.py +7 -13
- flywheel/models/libs_viewer_config_models_viewer_config.py +7 -13
- flywheel/models/local_storage.py +10 -18
- flywheel/models/location.py +7 -13
- flywheel/models/locked.py +10 -18
- flywheel/models/master_subject_code_dob_input.py +16 -28
- flywheel/models/master_subject_code_input.py +16 -28
- flywheel/models/master_subject_code_output.py +4 -8
- flywheel/models/matched_acquisition_output.py +43 -73
- flywheel/models/measurement_config.py +10 -18
- flywheel/models/measurement_item_config.py +10 -18
- flywheel/models/mfa_settings.py +4 -8
- flywheel/models/ml_set_filter.py +7 -13
- flywheel/models/modality.py +13 -23
- flywheel/models/modality_input.py +13 -23
- flywheel/models/modality_modify.py +10 -18
- flywheel/models/modality_output.py +16 -28
- flywheel/models/modified_result.py +7 -13
- flywheel/models/modify_user_input.py +37 -63
- flywheel/models/move_conflict.py +19 -33
- flywheel/models/note.py +28 -48
- flywheel/models/note_input.py +4 -8
- flywheel/models/origin.py +7 -13
- flywheel/models/orphaned_count.py +4 -8
- flywheel/models/output_user_page.py +10 -18
- flywheel/models/packfile_cleanup_output.py +4 -8
- flywheel/models/packfile_removed_output.py +7 -13
- flywheel/models/page.py +10 -18
- flywheel/models/page_generic_file_output.py +10 -18
- flywheel/models/page_generic_filter.py +10 -18
- flywheel/models/page_generic_form_response_output.py +10 -18
- flywheel/models/page_generic_protocol.py +13 -23
- flywheel/models/page_generic_reader_task_output.py +13 -23
- flywheel/models/page_generic_staffing_pool.py +13 -23
- flywheel/models/parsed_query_response.py +7 -13
- flywheel/models/premade_jobs_batch_job_output.py +19 -33
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +19 -33
- flywheel/models/premade_jobs_batch_proposal.py +22 -38
- flywheel/models/premade_jobs_batch_proposal_detail.py +4 -8
- flywheel/models/premade_jobs_batch_proposal_input.py +4 -8
- flywheel/models/project_aet.py +22 -38
- flywheel/models/project_aet_input.py +13 -23
- flywheel/models/project_contact.py +7 -13
- flywheel/models/project_copy_input.py +13 -23
- flywheel/models/project_copy_output.py +10 -18
- flywheel/models/project_counters.py +28 -48
- flywheel/models/project_delete_status_output.py +7 -13
- flywheel/models/project_group_info.py +7 -13
- flywheel/models/project_hierarchy_input.py +16 -28
- flywheel/models/project_hierarchy_output.py +10 -18
- flywheel/models/project_input.py +28 -48
- flywheel/models/project_institution.py +7 -13
- flywheel/models/project_list_output.py +94 -158
- flywheel/models/project_modify.py +37 -63
- flywheel/models/project_output.py +94 -158
- flywheel/models/project_parents.py +4 -8
- flywheel/models/project_report.py +37 -63
- flywheel/models/project_report_list.py +4 -8
- flywheel/models/project_settings_input.py +22 -38
- flywheel/models/project_settings_output.py +22 -38
- flywheel/models/project_settings_sharing.py +22 -38
- flywheel/models/project_settings_sharing_input.py +22 -38
- flywheel/models/project_settings_workspaces.py +4 -8
- flywheel/models/project_settings_workspaces_input.py +4 -8
- flywheel/models/project_stats.py +16 -28
- flywheel/models/project_template.py +7 -13
- flywheel/models/project_template_input.py +7 -13
- flywheel/models/project_template_list_input.py +4 -8
- flywheel/models/protocol.py +46 -78
- flywheel/models/protocol_e_signature_config.py +7 -13
- flywheel/models/protocol_input.py +25 -43
- flywheel/models/protocol_modify.py +16 -28
- flywheel/models/provider.py +37 -63
- flywheel/models/provider_deletion_status.py +7 -13
- flywheel/models/provider_links.py +16 -28
- flywheel/models/providers.py +16 -28
- flywheel/models/reader_batch_create.py +37 -63
- flywheel/models/reader_task.py +67 -113
- flywheel/models/reader_task_config.py +10 -18
- flywheel/models/reader_task_create.py +46 -78
- flywheel/models/reader_task_modify.py +19 -33
- flywheel/models/reader_task_output.py +70 -118
- flywheel/models/reader_task_parent_details.py +22 -38
- flywheel/models/report_access_log_context.py +19 -33
- flywheel/models/report_access_log_context_entry.py +7 -13
- flywheel/models/report_access_log_context_file_entry.py +4 -8
- flywheel/models/report_access_log_entry.py +52 -88
- flywheel/models/report_access_log_origin.py +7 -13
- flywheel/models/report_availability_list.py +4 -8
- flywheel/models/report_daily_usage_entry.py +40 -68
- flywheel/models/report_ethnicity_grid.py +13 -23
- flywheel/models/report_gender_count.py +10 -18
- flywheel/models/report_group_report.py +10 -18
- flywheel/models/report_site.py +7 -13
- flywheel/models/report_time_period.py +7 -13
- flywheel/models/report_usage.py +52 -88
- flywheel/models/resolve_input.py +4 -8
- flywheel/models/resolve_output.py +7 -13
- flywheel/models/resolver_node.py +4 -8
- flywheel/models/role_input.py +7 -13
- flywheel/models/role_output.py +16 -28
- flywheel/models/role_permission.py +7 -13
- flywheel/models/role_permission_output.py +7 -13
- flywheel/models/role_permission_update.py +4 -8
- flywheel/models/role_update.py +7 -13
- flywheel/models/roles_role_assignment.py +7 -13
- flywheel/models/rule.py +37 -63
- flywheel/models/rule_any.py +10 -18
- flywheel/models/s3_compat_storage.py +28 -48
- flywheel/models/save_search.py +19 -33
- flywheel/models/save_search_input.py +10 -18
- flywheel/models/save_search_output.py +19 -33
- flywheel/models/save_search_page.py +10 -18
- flywheel/models/save_search_parent.py +7 -13
- flywheel/models/save_search_update.py +7 -13
- flywheel/models/search_acquisition_response.py +13 -23
- flywheel/models/search_analysis_response.py +13 -23
- flywheel/models/search_collection_response.py +13 -23
- flywheel/models/search_file_response.py +19 -33
- flywheel/models/search_group_response.py +7 -13
- flywheel/models/search_parent_response.py +7 -13
- flywheel/models/search_parse_error.py +13 -23
- flywheel/models/search_project_response.py +7 -13
- flywheel/models/search_query.py +22 -38
- flywheel/models/search_response.py +34 -58
- flywheel/models/search_session_response.py +13 -23
- flywheel/models/search_status.py +4 -8
- flywheel/models/search_subject_response.py +10 -18
- flywheel/models/select_item.py +7 -13
- flywheel/models/server_state.py +19 -33
- flywheel/models/service_aet.py +19 -33
- flywheel/models/service_aet_input.py +16 -28
- flywheel/models/session_copy_input.py +13 -23
- flywheel/models/session_embedded_subject.py +19 -33
- flywheel/models/session_input.py +34 -58
- flywheel/models/session_list_output.py +85 -143
- flywheel/models/session_modify.py +37 -63
- flywheel/models/session_output.py +85 -143
- flywheel/models/session_parents.py +10 -18
- flywheel/models/session_template_options.py +10 -18
- flywheel/models/session_template_recalc_output.py +4 -8
- flywheel/models/session_upsert_input.py +37 -63
- flywheel/models/session_upsert_output.py +13 -23
- flywheel/models/sharing_filter_options.py +25 -43
- flywheel/models/signed_fs_upload_output.py +7 -13
- flywheel/models/signed_url_cleanup_input.py +7 -13
- flywheel/models/signed_url_upload_input.py +7 -13
- flywheel/models/signed_url_upload_output.py +25 -43
- flywheel/models/site.py +55 -93
- flywheel/models/site_report.py +7 -13
- flywheel/models/site_settings.py +28 -48
- flywheel/models/sort.py +7 -13
- flywheel/models/staffing_pool.py +22 -38
- flywheel/models/staffing_pool_create.py +10 -18
- flywheel/models/staffing_pool_list.py +4 -8
- flywheel/models/staffing_pool_modify.py +10 -18
- flywheel/models/static_compute.py +10 -18
- flywheel/models/status_transitions.py +13 -23
- flywheel/models/storage_strategy_config.py +7 -13
- flywheel/models/structured_query.py +4 -8
- flywheel/models/structured_query_suggestions.py +7 -13
- flywheel/models/structured_query_value_suggestion.py +13 -23
- flywheel/models/subject_copy_input.py +10 -18
- flywheel/models/subject_input.py +55 -93
- flywheel/models/subject_modify.py +61 -103
- flywheel/models/subject_output.py +97 -163
- flywheel/models/subject_output_for_list.py +97 -163
- flywheel/models/subject_parents.py +7 -13
- flywheel/models/subject_role_permission.py +7 -13
- flywheel/models/subject_template_options.py +7 -13
- flywheel/models/subject_upsert_input.py +49 -83
- flywheel/models/subject_upsert_output.py +10 -18
- flywheel/models/sync_user_input.py +22 -38
- flywheel/models/tag.py +4 -8
- flywheel/models/task_assign.py +7 -13
- flywheel/models/task_parent_ref.py +13 -23
- flywheel/models/task_parent_ref_input.py +10 -18
- flywheel/models/task_submission.py +7 -13
- flywheel/models/toolbar_config.py +4 -8
- flywheel/models/transitions.py +16 -28
- flywheel/models/tree_container_request_spec.py +16 -28
- flywheel/models/tree_graph.py +1 -3
- flywheel/models/tree_graph_connection.py +13 -23
- flywheel/models/tree_graph_connections.py +1 -3
- flywheel/models/tree_graph_node.py +4 -8
- flywheel/models/tree_response_item.py +1 -3
- flywheel/models/uid_check_input_acquisitions.py +13 -23
- flywheel/models/uid_check_input_sessions.py +13 -23
- flywheel/models/uid_check_output.py +7 -13
- flywheel/models/upload_ticket_output.py +10 -18
- flywheel/models/upload_token_output.py +4 -8
- flywheel/models/user.py +67 -113
- flywheel/models/user_api_key.py +10 -18
- flywheel/models/user_input.py +37 -63
- flywheel/models/user_jobs.py +10 -18
- flywheel/models/user_output_id.py +4 -8
- flywheel/models/user_preferences.py +1 -3
- flywheel/models/user_wechat.py +1 -3
- flywheel/models/validation_error.py +10 -18
- flywheel/models/validation_rule.py +7 -13
- flywheel/models/version.py +25 -43
- flywheel/models/view_id_output.py +4 -8
- flywheel/models/view_output.py +34 -58
- flywheel/models/viewer_app.py +28 -48
- flywheel/models/viewer_app_input.py +28 -48
- flywheel/models/virus_scan.py +4 -8
- flywheel/models/work_in_progress_features.py +1 -3
- flywheel/models/zipfile_info.py +7 -13
- flywheel/models/zipfile_member_info.py +13 -23
- {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/METADATA +1 -1
- flywheel_sdk-21.4.0rc0.dist-info/RECORD +778 -0
- flywheel_sdk-21.4.0.dist-info/RECORD +0 -778
- {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/WHEEL +0 -0
- {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/licenses/LICENSE.txt +0 -0
flywheel/api/sessions_api.py
CHANGED
|
@@ -30,11 +30,9 @@ class SessionsApi(object):
|
|
|
30
30
|
Create a session.
|
|
31
31
|
This method makes a synchronous HTTP request by default.
|
|
32
32
|
|
|
33
|
-
:param body:
|
|
34
|
-
:
|
|
35
|
-
:
|
|
36
|
-
:type async_: bool, optional
|
|
37
|
-
:rtype: InsertedId
|
|
33
|
+
:param SessionInput body: (required)
|
|
34
|
+
:param bool async_: Perform the request asynchronously
|
|
35
|
+
:return: InsertedId
|
|
38
36
|
"""
|
|
39
37
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
40
38
|
kwargs['_return_http_data_only'] = True
|
|
@@ -58,11 +56,9 @@ class SessionsApi(object):
|
|
|
58
56
|
Create a session.
|
|
59
57
|
This method makes a synchronous HTTP request by default.
|
|
60
58
|
|
|
61
|
-
:param body:
|
|
62
|
-
:
|
|
63
|
-
:
|
|
64
|
-
:type async_: bool, optional
|
|
65
|
-
:rtype: InsertedId
|
|
59
|
+
:param SessionInput body: (required)
|
|
60
|
+
:param bool async_: Perform the request asynchronously
|
|
61
|
+
:return: InsertedId
|
|
66
62
|
"""
|
|
67
63
|
|
|
68
64
|
all_params = ['body',] # noqa: E501
|
|
@@ -142,15 +138,12 @@ class SessionsApi(object):
|
|
|
142
138
|
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.
|
|
143
139
|
This method makes a synchronous HTTP request by default.
|
|
144
140
|
|
|
145
|
-
:param cid:
|
|
146
|
-
:
|
|
147
|
-
:param
|
|
148
|
-
:
|
|
149
|
-
:param
|
|
150
|
-
:
|
|
151
|
-
:param async_: Perform the request asynchronously
|
|
152
|
-
:type async_: bool, optional
|
|
153
|
-
:rtype: InsertedId
|
|
141
|
+
:param str cid: (required)
|
|
142
|
+
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
143
|
+
:param bool job: returns job_id instead of analysis.id
|
|
144
|
+
:param bool job: returns job_id instead of analysis.id
|
|
145
|
+
:param bool async_: Perform the request asynchronously
|
|
146
|
+
:return: InsertedId
|
|
154
147
|
"""
|
|
155
148
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
156
149
|
kwargs['_return_http_data_only'] = True
|
|
@@ -174,18 +167,15 @@ class SessionsApi(object):
|
|
|
174
167
|
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
168
|
This method makes a synchronous HTTP request by default.
|
|
176
169
|
|
|
177
|
-
:param cid:
|
|
178
|
-
:
|
|
179
|
-
:param
|
|
180
|
-
:
|
|
181
|
-
:param
|
|
182
|
-
:
|
|
183
|
-
:param async_: Perform the request asynchronously
|
|
184
|
-
:type async_: bool, optional
|
|
185
|
-
:rtype: InsertedId
|
|
170
|
+
:param str cid: (required)
|
|
171
|
+
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
172
|
+
:param bool job: returns job_id instead of analysis.id
|
|
173
|
+
:param bool job: returns job_id instead of analysis.id
|
|
174
|
+
:param bool async_: Perform the request asynchronously
|
|
175
|
+
:return: InsertedId
|
|
186
176
|
"""
|
|
187
177
|
|
|
188
|
-
all_params = ['cid','body','job',] # noqa: E501
|
|
178
|
+
all_params = ['cid','body','job','job',] # noqa: E501
|
|
189
179
|
all_params.append('async_')
|
|
190
180
|
all_params.append('_return_http_data_only')
|
|
191
181
|
all_params.append('_preload_content')
|
|
@@ -218,6 +208,8 @@ class SessionsApi(object):
|
|
|
218
208
|
path_params['cid'] = params['cid'] # noqa: E501
|
|
219
209
|
|
|
220
210
|
query_params = []
|
|
211
|
+
if 'job' in params:
|
|
212
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
221
213
|
if 'job' in params:
|
|
222
214
|
query_params.append(('job', params['job'])) # noqa: E501
|
|
223
215
|
else:
|
|
@@ -272,15 +264,11 @@ class SessionsApi(object):
|
|
|
272
264
|
Add a note to a(n) session analysis.
|
|
273
265
|
This method makes a synchronous HTTP request by default.
|
|
274
266
|
|
|
275
|
-
:param container_id: 24-char hex id
|
|
276
|
-
:
|
|
277
|
-
:param
|
|
278
|
-
:
|
|
279
|
-
:
|
|
280
|
-
:type body: NoteInput
|
|
281
|
-
:param async_: Perform the request asynchronously
|
|
282
|
-
:type async_: bool, optional
|
|
283
|
-
:rtype: Note
|
|
267
|
+
:param str container_id: 24-char hex id (required)
|
|
268
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
269
|
+
:param NoteInput body: (required)
|
|
270
|
+
:param bool async_: Perform the request asynchronously
|
|
271
|
+
:return: Note
|
|
284
272
|
"""
|
|
285
273
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
286
274
|
kwargs['_return_http_data_only'] = True
|
|
@@ -304,15 +292,11 @@ class SessionsApi(object):
|
|
|
304
292
|
Add a note to a(n) session analysis.
|
|
305
293
|
This method makes a synchronous HTTP request by default.
|
|
306
294
|
|
|
307
|
-
:param container_id: 24-char hex id
|
|
308
|
-
:
|
|
309
|
-
:param
|
|
310
|
-
:
|
|
311
|
-
:
|
|
312
|
-
:type body: NoteInput
|
|
313
|
-
:param async_: Perform the request asynchronously
|
|
314
|
-
:type async_: bool, optional
|
|
315
|
-
:rtype: Note
|
|
295
|
+
:param str container_id: 24-char hex id (required)
|
|
296
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
297
|
+
:param NoteInput body: (required)
|
|
298
|
+
:param bool async_: Perform the request asynchronously
|
|
299
|
+
:return: Note
|
|
316
300
|
"""
|
|
317
301
|
|
|
318
302
|
all_params = ['container_id','analysis_id','body',] # noqa: E501
|
|
@@ -404,13 +388,10 @@ class SessionsApi(object):
|
|
|
404
388
|
Add a note to a(n) session.
|
|
405
389
|
This method makes a synchronous HTTP request by default.
|
|
406
390
|
|
|
407
|
-
:param container_id:
|
|
408
|
-
:
|
|
409
|
-
:param
|
|
410
|
-
:
|
|
411
|
-
:param async_: Perform the request asynchronously
|
|
412
|
-
:type async_: bool, optional
|
|
413
|
-
:rtype: Note
|
|
391
|
+
:param str container_id: (required)
|
|
392
|
+
:param NoteInput body: (required)
|
|
393
|
+
:param bool async_: Perform the request asynchronously
|
|
394
|
+
:return: Note
|
|
414
395
|
"""
|
|
415
396
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
416
397
|
kwargs['_return_http_data_only'] = True
|
|
@@ -434,13 +415,10 @@ class SessionsApi(object):
|
|
|
434
415
|
Add a note to a(n) session.
|
|
435
416
|
This method makes a synchronous HTTP request by default.
|
|
436
417
|
|
|
437
|
-
:param container_id:
|
|
438
|
-
:
|
|
439
|
-
:param
|
|
440
|
-
:
|
|
441
|
-
:param async_: Perform the request asynchronously
|
|
442
|
-
:type async_: bool, optional
|
|
443
|
-
:rtype: Note
|
|
418
|
+
:param str container_id: (required)
|
|
419
|
+
:param NoteInput body: (required)
|
|
420
|
+
:param bool async_: Perform the request asynchronously
|
|
421
|
+
:return: Note
|
|
444
422
|
"""
|
|
445
423
|
|
|
446
424
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -526,13 +504,10 @@ class SessionsApi(object):
|
|
|
526
504
|
Propagates changes to projects, sessions and acquisitions
|
|
527
505
|
This method makes a synchronous HTTP request by default.
|
|
528
506
|
|
|
529
|
-
:param cid:
|
|
530
|
-
:
|
|
531
|
-
:param
|
|
532
|
-
:
|
|
533
|
-
:param async_: Perform the request asynchronously
|
|
534
|
-
:type async_: bool, optional
|
|
535
|
-
:rtype: ModifiedResult
|
|
507
|
+
:param str cid: (required)
|
|
508
|
+
:param Tag body: (required)
|
|
509
|
+
:param bool async_: Perform the request asynchronously
|
|
510
|
+
:return: ModifiedResult
|
|
536
511
|
"""
|
|
537
512
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
538
513
|
kwargs['_return_http_data_only'] = True
|
|
@@ -556,13 +531,10 @@ class SessionsApi(object):
|
|
|
556
531
|
Propagates changes to projects, sessions and acquisitions
|
|
557
532
|
This method makes a synchronous HTTP request by default.
|
|
558
533
|
|
|
559
|
-
:param cid:
|
|
560
|
-
:
|
|
561
|
-
:param
|
|
562
|
-
:
|
|
563
|
-
:param async_: Perform the request asynchronously
|
|
564
|
-
:type async_: bool, optional
|
|
565
|
-
:rtype: ModifiedResult
|
|
534
|
+
:param str cid: (required)
|
|
535
|
+
:param Tag body: (required)
|
|
536
|
+
:param bool async_: Perform the request asynchronously
|
|
537
|
+
:return: ModifiedResult
|
|
566
538
|
"""
|
|
567
539
|
|
|
568
540
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -648,13 +620,10 @@ class SessionsApi(object):
|
|
|
648
620
|
Add multiple tags to a(n) session
|
|
649
621
|
This method makes a synchronous HTTP request by default.
|
|
650
622
|
|
|
651
|
-
:param cid:
|
|
652
|
-
:
|
|
653
|
-
:param
|
|
654
|
-
:
|
|
655
|
-
:param async_: Perform the request asynchronously
|
|
656
|
-
:type async_: bool, optional
|
|
657
|
-
:rtype: None
|
|
623
|
+
:param str cid: (required)
|
|
624
|
+
:param list[str] body: (required)
|
|
625
|
+
:param bool async_: Perform the request asynchronously
|
|
626
|
+
:return: None
|
|
658
627
|
"""
|
|
659
628
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
660
629
|
kwargs['_return_http_data_only'] = True
|
|
@@ -678,13 +647,10 @@ class SessionsApi(object):
|
|
|
678
647
|
Add multiple tags to a(n) session
|
|
679
648
|
This method makes a synchronous HTTP request by default.
|
|
680
649
|
|
|
681
|
-
:param cid:
|
|
682
|
-
:
|
|
683
|
-
:param
|
|
684
|
-
:
|
|
685
|
-
:param async_: Perform the request asynchronously
|
|
686
|
-
:type async_: bool, optional
|
|
687
|
-
:rtype: None
|
|
650
|
+
:param str cid: (required)
|
|
651
|
+
:param list[str] body: (required)
|
|
652
|
+
:param bool async_: Perform the request asynchronously
|
|
653
|
+
:return: None
|
|
688
654
|
"""
|
|
689
655
|
|
|
690
656
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -763,13 +729,10 @@ class SessionsApi(object):
|
|
|
763
729
|
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
730
|
This method makes a synchronous HTTP request by default.
|
|
765
731
|
|
|
766
|
-
:param session_id:
|
|
767
|
-
:
|
|
768
|
-
:param
|
|
769
|
-
:
|
|
770
|
-
:param async_: Perform the request asynchronously
|
|
771
|
-
:type async_: bool, optional
|
|
772
|
-
:rtype: DeletedResult
|
|
732
|
+
:param str session_id: (required)
|
|
733
|
+
:param ContainerDeleteReason delete_reason:
|
|
734
|
+
:param bool async_: Perform the request asynchronously
|
|
735
|
+
:return: DeletedResult
|
|
773
736
|
"""
|
|
774
737
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
775
738
|
kwargs['_return_http_data_only'] = True
|
|
@@ -793,13 +756,10 @@ class SessionsApi(object):
|
|
|
793
756
|
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.
|
|
794
757
|
This method makes a synchronous HTTP request by default.
|
|
795
758
|
|
|
796
|
-
:param session_id:
|
|
797
|
-
:
|
|
798
|
-
:param
|
|
799
|
-
:
|
|
800
|
-
:param async_: Perform the request asynchronously
|
|
801
|
-
:type async_: bool, optional
|
|
802
|
-
:rtype: DeletedResult
|
|
759
|
+
:param str session_id: (required)
|
|
760
|
+
:param ContainerDeleteReason delete_reason:
|
|
761
|
+
:param bool async_: Perform the request asynchronously
|
|
762
|
+
:return: DeletedResult
|
|
803
763
|
"""
|
|
804
764
|
|
|
805
765
|
all_params = ['session_id','delete_reason',] # noqa: E501
|
|
@@ -870,15 +830,11 @@ class SessionsApi(object):
|
|
|
870
830
|
Delete an analysis for a container.
|
|
871
831
|
This method makes a synchronous HTTP request by default.
|
|
872
832
|
|
|
873
|
-
:param cid:
|
|
874
|
-
:
|
|
875
|
-
:param
|
|
876
|
-
:
|
|
877
|
-
:
|
|
878
|
-
:type delete_reason: ContainerDeleteReason, optional
|
|
879
|
-
:param async_: Perform the request asynchronously
|
|
880
|
-
:type async_: bool, optional
|
|
881
|
-
:rtype: DeletedResult
|
|
833
|
+
:param str cid: (required)
|
|
834
|
+
:param str analysis_id: (required)
|
|
835
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
836
|
+
:param bool async_: Perform the request asynchronously
|
|
837
|
+
:return: DeletedResult
|
|
882
838
|
"""
|
|
883
839
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
884
840
|
kwargs['_return_http_data_only'] = True
|
|
@@ -902,15 +858,11 @@ class SessionsApi(object):
|
|
|
902
858
|
Delete an analysis for a container.
|
|
903
859
|
This method makes a synchronous HTTP request by default.
|
|
904
860
|
|
|
905
|
-
:param cid:
|
|
906
|
-
:
|
|
907
|
-
:param
|
|
908
|
-
:
|
|
909
|
-
:
|
|
910
|
-
:type delete_reason: ContainerDeleteReason, optional
|
|
911
|
-
:param async_: Perform the request asynchronously
|
|
912
|
-
:type async_: bool, optional
|
|
913
|
-
:rtype: DeletedResult
|
|
861
|
+
:param str cid: (required)
|
|
862
|
+
:param str analysis_id: (required)
|
|
863
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
864
|
+
:param bool async_: Perform the request asynchronously
|
|
865
|
+
:return: DeletedResult
|
|
914
866
|
"""
|
|
915
867
|
|
|
916
868
|
all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
|
|
@@ -987,15 +939,11 @@ class SessionsApi(object):
|
|
|
987
939
|
Remove a note from a(n) session analysis.
|
|
988
940
|
This method makes a synchronous HTTP request by default.
|
|
989
941
|
|
|
990
|
-
:param cid: 24-char hex id
|
|
991
|
-
:
|
|
992
|
-
:param
|
|
993
|
-
:
|
|
994
|
-
:
|
|
995
|
-
:type note_id: str
|
|
996
|
-
:param async_: Perform the request asynchronously
|
|
997
|
-
:type async_: bool, optional
|
|
998
|
-
:rtype: DeletedResult
|
|
942
|
+
:param str cid: 24-char hex id (required)
|
|
943
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
944
|
+
:param str note_id: 24-char hex note id (required)
|
|
945
|
+
:param bool async_: Perform the request asynchronously
|
|
946
|
+
:return: DeletedResult
|
|
999
947
|
"""
|
|
1000
948
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1001
949
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1019,15 +967,11 @@ class SessionsApi(object):
|
|
|
1019
967
|
Remove a note from a(n) session analysis.
|
|
1020
968
|
This method makes a synchronous HTTP request by default.
|
|
1021
969
|
|
|
1022
|
-
:param cid: 24-char hex id
|
|
1023
|
-
:
|
|
1024
|
-
:param
|
|
1025
|
-
:
|
|
1026
|
-
:
|
|
1027
|
-
:type note_id: str
|
|
1028
|
-
:param async_: Perform the request asynchronously
|
|
1029
|
-
:type async_: bool, optional
|
|
1030
|
-
:rtype: DeletedResult
|
|
970
|
+
:param str cid: 24-char hex id (required)
|
|
971
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
972
|
+
:param str note_id: 24-char hex note id (required)
|
|
973
|
+
:param bool async_: Perform the request asynchronously
|
|
974
|
+
:return: DeletedResult
|
|
1031
975
|
"""
|
|
1032
976
|
|
|
1033
977
|
all_params = ['cid','analysis_id','note_id',] # noqa: E501
|
|
@@ -1108,17 +1052,12 @@ class SessionsApi(object):
|
|
|
1108
1052
|
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.
|
|
1109
1053
|
This method makes a synchronous HTTP request by default.
|
|
1110
1054
|
|
|
1111
|
-
:param cid:
|
|
1112
|
-
:
|
|
1113
|
-
:param
|
|
1114
|
-
:
|
|
1115
|
-
:param
|
|
1116
|
-
:
|
|
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
|
|
1055
|
+
:param str cid: (required)
|
|
1056
|
+
:param str filename: (required)
|
|
1057
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1058
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1059
|
+
:param bool async_: Perform the request asynchronously
|
|
1060
|
+
:return: DeletedResult
|
|
1122
1061
|
"""
|
|
1123
1062
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1124
1063
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1142,17 +1081,12 @@ class SessionsApi(object):
|
|
|
1142
1081
|
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.
|
|
1143
1082
|
This method makes a synchronous HTTP request by default.
|
|
1144
1083
|
|
|
1145
|
-
:param cid:
|
|
1146
|
-
:
|
|
1147
|
-
:param
|
|
1148
|
-
:
|
|
1149
|
-
:param
|
|
1150
|
-
:
|
|
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
|
|
1084
|
+
:param str cid: (required)
|
|
1085
|
+
:param str filename: (required)
|
|
1086
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1087
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1088
|
+
:param bool async_: Perform the request asynchronously
|
|
1089
|
+
:return: DeletedResult
|
|
1156
1090
|
"""
|
|
1157
1091
|
|
|
1158
1092
|
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
@@ -1231,13 +1165,10 @@ class SessionsApi(object):
|
|
|
1231
1165
|
Remove a note from a(n) session
|
|
1232
1166
|
This method makes a synchronous HTTP request by default.
|
|
1233
1167
|
|
|
1234
|
-
:param cid:
|
|
1235
|
-
:
|
|
1236
|
-
:param
|
|
1237
|
-
:
|
|
1238
|
-
:param async_: Perform the request asynchronously
|
|
1239
|
-
:type async_: bool, optional
|
|
1240
|
-
:rtype: DeletedResult
|
|
1168
|
+
:param str cid: (required)
|
|
1169
|
+
:param str note_id: (required)
|
|
1170
|
+
:param bool async_: Perform the request asynchronously
|
|
1171
|
+
:return: DeletedResult
|
|
1241
1172
|
"""
|
|
1242
1173
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1243
1174
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1261,13 +1192,10 @@ class SessionsApi(object):
|
|
|
1261
1192
|
Remove a note from a(n) session
|
|
1262
1193
|
This method makes a synchronous HTTP request by default.
|
|
1263
1194
|
|
|
1264
|
-
:param cid:
|
|
1265
|
-
:
|
|
1266
|
-
:param
|
|
1267
|
-
:
|
|
1268
|
-
:param async_: Perform the request asynchronously
|
|
1269
|
-
:type async_: bool, optional
|
|
1270
|
-
:rtype: DeletedResult
|
|
1195
|
+
:param str cid: (required)
|
|
1196
|
+
:param str note_id: (required)
|
|
1197
|
+
:param bool async_: Perform the request asynchronously
|
|
1198
|
+
:return: DeletedResult
|
|
1271
1199
|
"""
|
|
1272
1200
|
|
|
1273
1201
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -1342,13 +1270,10 @@ class SessionsApi(object):
|
|
|
1342
1270
|
Delete a tag
|
|
1343
1271
|
This method makes a synchronous HTTP request by default.
|
|
1344
1272
|
|
|
1345
|
-
:param cid:
|
|
1346
|
-
:
|
|
1347
|
-
:param
|
|
1348
|
-
:
|
|
1349
|
-
:param async_: Perform the request asynchronously
|
|
1350
|
-
:type async_: bool, optional
|
|
1351
|
-
:rtype: DeletedResult
|
|
1273
|
+
:param str cid: (required)
|
|
1274
|
+
:param str value: The tag to interact with (required)
|
|
1275
|
+
:param bool async_: Perform the request asynchronously
|
|
1276
|
+
:return: DeletedResult
|
|
1352
1277
|
"""
|
|
1353
1278
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1354
1279
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1372,13 +1297,10 @@ class SessionsApi(object):
|
|
|
1372
1297
|
Delete a tag
|
|
1373
1298
|
This method makes a synchronous HTTP request by default.
|
|
1374
1299
|
|
|
1375
|
-
:param cid:
|
|
1376
|
-
:
|
|
1377
|
-
:param
|
|
1378
|
-
:
|
|
1379
|
-
:param async_: Perform the request asynchronously
|
|
1380
|
-
:type async_: bool, optional
|
|
1381
|
-
:rtype: DeletedResult
|
|
1300
|
+
:param str cid: (required)
|
|
1301
|
+
:param str value: The tag to interact with (required)
|
|
1302
|
+
:param bool async_: Perform the request asynchronously
|
|
1303
|
+
:return: DeletedResult
|
|
1382
1304
|
"""
|
|
1383
1305
|
|
|
1384
1306
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -1453,13 +1375,10 @@ class SessionsApi(object):
|
|
|
1453
1375
|
Delete multiple tags from a(n) session
|
|
1454
1376
|
This method makes a synchronous HTTP request by default.
|
|
1455
1377
|
|
|
1456
|
-
:param cid:
|
|
1457
|
-
:
|
|
1458
|
-
:param
|
|
1459
|
-
:
|
|
1460
|
-
:param async_: Perform the request asynchronously
|
|
1461
|
-
:type async_: bool, optional
|
|
1462
|
-
:rtype: None
|
|
1378
|
+
:param str cid: (required)
|
|
1379
|
+
:param list[str] body: (required)
|
|
1380
|
+
:param bool async_: Perform the request asynchronously
|
|
1381
|
+
:return: None
|
|
1463
1382
|
"""
|
|
1464
1383
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1465
1384
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1483,13 +1402,10 @@ class SessionsApi(object):
|
|
|
1483
1402
|
Delete multiple tags from a(n) session
|
|
1484
1403
|
This method makes a synchronous HTTP request by default.
|
|
1485
1404
|
|
|
1486
|
-
:param cid:
|
|
1487
|
-
:
|
|
1488
|
-
:param
|
|
1489
|
-
:
|
|
1490
|
-
:param async_: Perform the request asynchronously
|
|
1491
|
-
:type async_: bool, optional
|
|
1492
|
-
:rtype: None
|
|
1405
|
+
:param str cid: (required)
|
|
1406
|
+
:param list[str] body: (required)
|
|
1407
|
+
:param bool async_: Perform the request asynchronously
|
|
1408
|
+
:return: None
|
|
1493
1409
|
"""
|
|
1494
1410
|
|
|
1495
1411
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -1568,13 +1484,10 @@ class SessionsApi(object):
|
|
|
1568
1484
|
Delete multiple sessions by ID list
|
|
1569
1485
|
This method makes a synchronous HTTP request by default.
|
|
1570
1486
|
|
|
1571
|
-
:param body: List of IDs to delete
|
|
1572
|
-
:
|
|
1573
|
-
:param
|
|
1574
|
-
:
|
|
1575
|
-
:param async_: Perform the request asynchronously
|
|
1576
|
-
:type async_: bool, optional
|
|
1577
|
-
:rtype: DeletedResult
|
|
1487
|
+
:param list[str] body: List of IDs to delete (required)
|
|
1488
|
+
:param ContainerDeleteReason delete_reason:
|
|
1489
|
+
:param bool async_: Perform the request asynchronously
|
|
1490
|
+
:return: DeletedResult
|
|
1578
1491
|
"""
|
|
1579
1492
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1580
1493
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1598,13 +1511,10 @@ class SessionsApi(object):
|
|
|
1598
1511
|
Delete multiple sessions by ID list
|
|
1599
1512
|
This method makes a synchronous HTTP request by default.
|
|
1600
1513
|
|
|
1601
|
-
:param body: List of IDs to delete
|
|
1602
|
-
:
|
|
1603
|
-
:param
|
|
1604
|
-
:
|
|
1605
|
-
:param async_: Perform the request asynchronously
|
|
1606
|
-
:type async_: bool, optional
|
|
1607
|
-
:rtype: DeletedResult
|
|
1514
|
+
:param list[str] body: List of IDs to delete (required)
|
|
1515
|
+
:param ContainerDeleteReason delete_reason:
|
|
1516
|
+
:param bool async_: Perform the request asynchronously
|
|
1517
|
+
:return: DeletedResult
|
|
1608
1518
|
"""
|
|
1609
1519
|
|
|
1610
1520
|
all_params = ['body','delete_reason',] # noqa: E501
|
|
@@ -1679,29 +1589,18 @@ class SessionsApi(object):
|
|
|
1679
1589
|
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.
|
|
1680
1590
|
This method makes a synchronous HTTP request by default.
|
|
1681
1591
|
|
|
1682
|
-
:param session_id: 24-character hex ID
|
|
1683
|
-
:
|
|
1684
|
-
:param
|
|
1685
|
-
:
|
|
1686
|
-
:param
|
|
1687
|
-
:
|
|
1688
|
-
:param
|
|
1689
|
-
:
|
|
1690
|
-
:param
|
|
1691
|
-
:
|
|
1692
|
-
:param
|
|
1693
|
-
:
|
|
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]
|
|
1592
|
+
:param str session_id: 24-character hex ID (required)
|
|
1593
|
+
:param str file_name: output file name (required)
|
|
1594
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1595
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1596
|
+
:param bool 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\"
|
|
1597
|
+
:param int version: version of the file to download
|
|
1598
|
+
:param str hash: file hash for comparison
|
|
1599
|
+
:param str range: byte ranges to return
|
|
1600
|
+
:param list[str] x_accept_feature: redirect header
|
|
1601
|
+
:param str dest_file: Destination file path
|
|
1602
|
+
:param bool async_: Perform the request asynchronously
|
|
1603
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1705
1604
|
"""
|
|
1706
1605
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1707
1606
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1724,27 +1623,17 @@ class SessionsApi(object):
|
|
|
1724
1623
|
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.
|
|
1725
1624
|
This method makes a synchronous HTTP request by default.
|
|
1726
1625
|
|
|
1727
|
-
:param session_id: 24-character hex ID
|
|
1728
|
-
:
|
|
1729
|
-
:param
|
|
1730
|
-
:
|
|
1731
|
-
:param
|
|
1732
|
-
:
|
|
1733
|
-
:param
|
|
1734
|
-
:
|
|
1735
|
-
:param
|
|
1736
|
-
:
|
|
1737
|
-
:
|
|
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]
|
|
1626
|
+
:param str session_id: 24-character hex ID (required)
|
|
1627
|
+
:param str file_name: output file name (required)
|
|
1628
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1629
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1630
|
+
:param bool 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\"
|
|
1631
|
+
:param int version: version of the file to download
|
|
1632
|
+
:param str hash: file hash for comparison
|
|
1633
|
+
:param str range: byte ranges to return
|
|
1634
|
+
:param list[str] x_accept_feature: redirect header
|
|
1635
|
+
:param bool async_: Perform the request asynchronously
|
|
1636
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1748
1637
|
"""
|
|
1749
1638
|
|
|
1750
1639
|
all_params = ['session_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1834,29 +1723,18 @@ class SessionsApi(object):
|
|
|
1834
1723
|
Does not work on files whose names contain a forward slash.
|
|
1835
1724
|
This method makes a synchronous HTTP request by default.
|
|
1836
1725
|
|
|
1837
|
-
:param session_id: 24-character hex ID
|
|
1838
|
-
:
|
|
1839
|
-
:param
|
|
1840
|
-
:
|
|
1841
|
-
:param
|
|
1842
|
-
:
|
|
1843
|
-
:param
|
|
1844
|
-
:
|
|
1845
|
-
:param
|
|
1846
|
-
:
|
|
1847
|
-
:param
|
|
1848
|
-
:
|
|
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
|
|
1726
|
+
:param str session_id: 24-character hex ID (required)
|
|
1727
|
+
:param str file_name: output file name (required)
|
|
1728
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1729
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1730
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1731
|
+
:param bool 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\"
|
|
1732
|
+
:param int version: version of the file to download
|
|
1733
|
+
:param str hash: file hash for comparison
|
|
1734
|
+
:param str range: byte ranges to return
|
|
1735
|
+
:param list[str] x_accept_feature: redirect header
|
|
1736
|
+
:param bool async_: Perform the request asynchronously
|
|
1737
|
+
:return: FileZipInfo
|
|
1860
1738
|
"""
|
|
1861
1739
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1862
1740
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1880,29 +1758,18 @@ class SessionsApi(object):
|
|
|
1880
1758
|
Does not work on files whose names contain a forward slash.
|
|
1881
1759
|
This method makes a synchronous HTTP request by default.
|
|
1882
1760
|
|
|
1883
|
-
:param session_id: 24-character hex ID
|
|
1884
|
-
:
|
|
1885
|
-
:param
|
|
1886
|
-
:
|
|
1887
|
-
:param
|
|
1888
|
-
:
|
|
1889
|
-
:param
|
|
1890
|
-
:
|
|
1891
|
-
:param
|
|
1892
|
-
:
|
|
1893
|
-
:param
|
|
1894
|
-
:
|
|
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
|
|
1761
|
+
:param str session_id: 24-character hex ID (required)
|
|
1762
|
+
:param str file_name: output file name (required)
|
|
1763
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1764
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1765
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1766
|
+
:param bool 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\"
|
|
1767
|
+
:param int version: version of the file to download
|
|
1768
|
+
:param str hash: file hash for comparison
|
|
1769
|
+
:param str range: byte ranges to return
|
|
1770
|
+
:param list[str] x_accept_feature: redirect header
|
|
1771
|
+
:param bool async_: Perform the request asynchronously
|
|
1772
|
+
:return: FileZipInfo
|
|
1906
1773
|
"""
|
|
1907
1774
|
|
|
1908
1775
|
all_params = ['session_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1995,29 +1862,18 @@ class SessionsApi(object):
|
|
|
1995
1862
|
|
|
1996
1863
|
This method makes a synchronous HTTP request by default.
|
|
1997
1864
|
|
|
1998
|
-
:param session_id: 24-character hex ID
|
|
1999
|
-
:
|
|
2000
|
-
:param
|
|
2001
|
-
:
|
|
2002
|
-
:param
|
|
2003
|
-
:
|
|
2004
|
-
:param
|
|
2005
|
-
:
|
|
2006
|
-
:param
|
|
2007
|
-
:
|
|
2008
|
-
:param
|
|
2009
|
-
:
|
|
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]
|
|
1865
|
+
:param str session_id: 24-character hex ID (required)
|
|
1866
|
+
:param str file_name: output file name (required)
|
|
1867
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1868
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1869
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1870
|
+
:param bool 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\"
|
|
1871
|
+
:param int version: version of the file to download
|
|
1872
|
+
:param str hash: file hash for comparison
|
|
1873
|
+
:param str range: byte ranges to return
|
|
1874
|
+
:param list[str] x_accept_feature: redirect header
|
|
1875
|
+
:param bool async_: Perform the request asynchronously
|
|
1876
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2021
1877
|
"""
|
|
2022
1878
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2023
1879
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2040,29 +1896,18 @@ class SessionsApi(object):
|
|
|
2040
1896
|
|
|
2041
1897
|
This method makes a synchronous HTTP request by default.
|
|
2042
1898
|
|
|
2043
|
-
:param session_id: 24-character hex ID
|
|
2044
|
-
:
|
|
2045
|
-
:param
|
|
2046
|
-
:
|
|
2047
|
-
:param
|
|
2048
|
-
:
|
|
2049
|
-
:param
|
|
2050
|
-
:
|
|
2051
|
-
:param
|
|
2052
|
-
:
|
|
2053
|
-
:param
|
|
2054
|
-
:
|
|
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]
|
|
1899
|
+
:param str session_id: 24-character hex ID (required)
|
|
1900
|
+
:param str file_name: output file name (required)
|
|
1901
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1902
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1903
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1904
|
+
:param bool 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\"
|
|
1905
|
+
:param int version: version of the file to download
|
|
1906
|
+
:param str hash: file hash for comparison
|
|
1907
|
+
:param str range: byte ranges to return
|
|
1908
|
+
:param list[str] x_accept_feature: redirect header
|
|
1909
|
+
:param bool async_: Perform the request asynchronously
|
|
1910
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2066
1911
|
"""
|
|
2067
1912
|
|
|
2068
1913
|
all_params = ['session_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -2154,27 +1999,17 @@ class SessionsApi(object):
|
|
|
2154
1999
|
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.
|
|
2155
2000
|
This method makes a synchronous HTTP request by default.
|
|
2156
2001
|
|
|
2157
|
-
:param session_id: 24-character hex ID
|
|
2158
|
-
:
|
|
2159
|
-
:param
|
|
2160
|
-
:
|
|
2161
|
-
:param
|
|
2162
|
-
:
|
|
2163
|
-
:param
|
|
2164
|
-
:
|
|
2165
|
-
:param
|
|
2166
|
-
:
|
|
2167
|
-
:
|
|
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]
|
|
2002
|
+
:param str session_id: 24-character hex ID (required)
|
|
2003
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2004
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2005
|
+
:param bool info: get file info only
|
|
2006
|
+
:param str member: get zipfile member
|
|
2007
|
+
:param bool view: feature flag for view/download
|
|
2008
|
+
:param str range: byte ranges to return
|
|
2009
|
+
:param list[str] x_accept_feature: redirect header
|
|
2010
|
+
:param str dest_file: Destination file path
|
|
2011
|
+
:param bool async_: Perform the request asynchronously
|
|
2012
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2178
2013
|
"""
|
|
2179
2014
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2180
2015
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2197,25 +2032,16 @@ class SessionsApi(object):
|
|
|
2197
2032
|
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.
|
|
2198
2033
|
This method makes a synchronous HTTP request by default.
|
|
2199
2034
|
|
|
2200
|
-
:param session_id: 24-character hex ID
|
|
2201
|
-
:
|
|
2202
|
-
:param
|
|
2203
|
-
:
|
|
2204
|
-
:param
|
|
2205
|
-
:
|
|
2206
|
-
:param
|
|
2207
|
-
:
|
|
2208
|
-
:param
|
|
2209
|
-
:
|
|
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]
|
|
2035
|
+
:param str session_id: 24-character hex ID (required)
|
|
2036
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2037
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2038
|
+
:param bool info: get file info only
|
|
2039
|
+
:param str member: get zipfile member
|
|
2040
|
+
:param bool view: feature flag for view/download
|
|
2041
|
+
:param str range: byte ranges to return
|
|
2042
|
+
:param list[str] x_accept_feature: redirect header
|
|
2043
|
+
:param bool async_: Perform the request asynchronously
|
|
2044
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2219
2045
|
"""
|
|
2220
2046
|
|
|
2221
2047
|
all_params = ['session_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2307,27 +2133,17 @@ class SessionsApi(object):
|
|
|
2307
2133
|
Does not work on files whose names contain a forward slash.
|
|
2308
2134
|
This method makes a synchronous HTTP request by default.
|
|
2309
2135
|
|
|
2310
|
-
:param session_id: 24-character hex ID
|
|
2311
|
-
:
|
|
2312
|
-
:param
|
|
2313
|
-
:
|
|
2314
|
-
:param
|
|
2315
|
-
:
|
|
2316
|
-
:param
|
|
2317
|
-
:
|
|
2318
|
-
:param
|
|
2319
|
-
:
|
|
2320
|
-
:
|
|
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
|
|
2136
|
+
:param str session_id: 24-character hex ID (required)
|
|
2137
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2138
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2139
|
+
:param str ticket: 24-char hex ticket id
|
|
2140
|
+
:param bool info: get file info only
|
|
2141
|
+
:param str member: get zipfile member
|
|
2142
|
+
:param bool view: feature flag for view/download
|
|
2143
|
+
:param str range: byte ranges to return
|
|
2144
|
+
:param list[str] x_accept_feature: redirect header
|
|
2145
|
+
:param bool async_: Perform the request asynchronously
|
|
2146
|
+
:return: FileZipInfo
|
|
2331
2147
|
"""
|
|
2332
2148
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2333
2149
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2351,27 +2167,17 @@ class SessionsApi(object):
|
|
|
2351
2167
|
Does not work on files whose names contain a forward slash.
|
|
2352
2168
|
This method makes a synchronous HTTP request by default.
|
|
2353
2169
|
|
|
2354
|
-
:param session_id: 24-character hex ID
|
|
2355
|
-
:
|
|
2356
|
-
:param
|
|
2357
|
-
:
|
|
2358
|
-
:param
|
|
2359
|
-
:
|
|
2360
|
-
:param
|
|
2361
|
-
:
|
|
2362
|
-
:param
|
|
2363
|
-
:
|
|
2364
|
-
:
|
|
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
|
|
2170
|
+
:param str session_id: 24-character hex ID (required)
|
|
2171
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2172
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2173
|
+
:param str ticket: 24-char hex ticket id
|
|
2174
|
+
:param bool info: get file info only
|
|
2175
|
+
:param str member: get zipfile member
|
|
2176
|
+
:param bool view: feature flag for view/download
|
|
2177
|
+
:param str range: byte ranges to return
|
|
2178
|
+
:param list[str] x_accept_feature: redirect header
|
|
2179
|
+
:param bool async_: Perform the request asynchronously
|
|
2180
|
+
:return: FileZipInfo
|
|
2375
2181
|
"""
|
|
2376
2182
|
|
|
2377
2183
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2466,27 +2272,17 @@ class SessionsApi(object):
|
|
|
2466
2272
|
|
|
2467
2273
|
This method makes a synchronous HTTP request by default.
|
|
2468
2274
|
|
|
2469
|
-
:param session_id: 24-character hex ID
|
|
2470
|
-
:
|
|
2471
|
-
:param
|
|
2472
|
-
:
|
|
2473
|
-
:param
|
|
2474
|
-
:
|
|
2475
|
-
:param
|
|
2476
|
-
:
|
|
2477
|
-
:param
|
|
2478
|
-
:
|
|
2479
|
-
:
|
|
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]
|
|
2275
|
+
:param str session_id: 24-character hex ID (required)
|
|
2276
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2277
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2278
|
+
:param str ticket: 24-char hex ticket id
|
|
2279
|
+
:param bool info: get file info only
|
|
2280
|
+
:param str member: get zipfile member
|
|
2281
|
+
:param bool view: feature flag for view/download
|
|
2282
|
+
:param str range: byte ranges to return
|
|
2283
|
+
:param list[str] x_accept_feature: redirect header
|
|
2284
|
+
:param bool async_: Perform the request asynchronously
|
|
2285
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2490
2286
|
"""
|
|
2491
2287
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2492
2288
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2509,27 +2305,17 @@ class SessionsApi(object):
|
|
|
2509
2305
|
|
|
2510
2306
|
This method makes a synchronous HTTP request by default.
|
|
2511
2307
|
|
|
2512
|
-
:param session_id: 24-character hex ID
|
|
2513
|
-
:
|
|
2514
|
-
:param
|
|
2515
|
-
:
|
|
2516
|
-
:param
|
|
2517
|
-
:
|
|
2518
|
-
:param
|
|
2519
|
-
:
|
|
2520
|
-
:param
|
|
2521
|
-
:
|
|
2522
|
-
:
|
|
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]
|
|
2308
|
+
:param str session_id: 24-character hex ID (required)
|
|
2309
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2310
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2311
|
+
:param str ticket: 24-char hex ticket id
|
|
2312
|
+
:param bool info: get file info only
|
|
2313
|
+
:param str member: get zipfile member
|
|
2314
|
+
:param bool view: feature flag for view/download
|
|
2315
|
+
:param str range: byte ranges to return
|
|
2316
|
+
:param list[str] x_accept_feature: redirect header
|
|
2317
|
+
:param bool async_: Perform the request asynchronously
|
|
2318
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2533
2319
|
"""
|
|
2534
2320
|
|
|
2535
2321
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2623,27 +2409,17 @@ class SessionsApi(object):
|
|
|
2623
2409
|
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.
|
|
2624
2410
|
This method makes a synchronous HTTP request by default.
|
|
2625
2411
|
|
|
2626
|
-
:param session_id: 24-character hex ID
|
|
2627
|
-
:
|
|
2628
|
-
:param
|
|
2629
|
-
:
|
|
2630
|
-
:param
|
|
2631
|
-
:
|
|
2632
|
-
:param
|
|
2633
|
-
:
|
|
2634
|
-
:param
|
|
2635
|
-
:
|
|
2636
|
-
:
|
|
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]
|
|
2412
|
+
:param str session_id: 24-character hex ID (required)
|
|
2413
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2414
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2415
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2416
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2417
|
+
:param bool view: feature flag for view/download
|
|
2418
|
+
:param str range: byte ranges to return
|
|
2419
|
+
:param list[str] x_accept_feature: redirect header
|
|
2420
|
+
:param str dest_file: Destination file path
|
|
2421
|
+
:param bool async_: Perform the request asynchronously
|
|
2422
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2647
2423
|
"""
|
|
2648
2424
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2649
2425
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2666,25 +2442,16 @@ class SessionsApi(object):
|
|
|
2666
2442
|
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.
|
|
2667
2443
|
This method makes a synchronous HTTP request by default.
|
|
2668
2444
|
|
|
2669
|
-
:param session_id: 24-character hex ID
|
|
2670
|
-
:
|
|
2671
|
-
:param
|
|
2672
|
-
:
|
|
2673
|
-
:param
|
|
2674
|
-
:
|
|
2675
|
-
:param
|
|
2676
|
-
:
|
|
2677
|
-
:param
|
|
2678
|
-
:
|
|
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]
|
|
2445
|
+
:param str session_id: 24-character hex ID (required)
|
|
2446
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2447
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2448
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2449
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2450
|
+
:param bool view: feature flag for view/download
|
|
2451
|
+
:param str range: byte ranges to return
|
|
2452
|
+
:param list[str] x_accept_feature: redirect header
|
|
2453
|
+
:param bool async_: Perform the request asynchronously
|
|
2454
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2688
2455
|
"""
|
|
2689
2456
|
|
|
2690
2457
|
all_params = ['session_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2776,27 +2543,17 @@ class SessionsApi(object):
|
|
|
2776
2543
|
Does not work on files whose names contain a forward slash.
|
|
2777
2544
|
This method makes a synchronous HTTP request by default.
|
|
2778
2545
|
|
|
2779
|
-
:param session_id: 24-character hex ID
|
|
2780
|
-
:
|
|
2781
|
-
:param
|
|
2782
|
-
:
|
|
2783
|
-
:param
|
|
2784
|
-
:
|
|
2785
|
-
:param
|
|
2786
|
-
:
|
|
2787
|
-
:param
|
|
2788
|
-
:
|
|
2789
|
-
:
|
|
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
|
|
2546
|
+
:param str session_id: 24-character hex ID (required)
|
|
2547
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2548
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2549
|
+
:param str ticket: ticket id of the outputs to download
|
|
2550
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2551
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2552
|
+
:param bool view: feature flag for view/download
|
|
2553
|
+
:param str range: byte ranges to return
|
|
2554
|
+
:param list[str] x_accept_feature: redirect header
|
|
2555
|
+
:param bool async_: Perform the request asynchronously
|
|
2556
|
+
:return: FileZipInfo
|
|
2800
2557
|
"""
|
|
2801
2558
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2802
2559
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2820,27 +2577,17 @@ class SessionsApi(object):
|
|
|
2820
2577
|
Does not work on files whose names contain a forward slash.
|
|
2821
2578
|
This method makes a synchronous HTTP request by default.
|
|
2822
2579
|
|
|
2823
|
-
:param session_id: 24-character hex ID
|
|
2824
|
-
:
|
|
2825
|
-
:param
|
|
2826
|
-
:
|
|
2827
|
-
:param
|
|
2828
|
-
:
|
|
2829
|
-
:param
|
|
2830
|
-
:
|
|
2831
|
-
:param
|
|
2832
|
-
:
|
|
2833
|
-
:
|
|
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
|
|
2580
|
+
:param str session_id: 24-character hex ID (required)
|
|
2581
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2582
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2583
|
+
:param str ticket: ticket id of the outputs to download
|
|
2584
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2585
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2586
|
+
:param bool view: feature flag for view/download
|
|
2587
|
+
:param str range: byte ranges to return
|
|
2588
|
+
:param list[str] x_accept_feature: redirect header
|
|
2589
|
+
:param bool async_: Perform the request asynchronously
|
|
2590
|
+
:return: FileZipInfo
|
|
2844
2591
|
"""
|
|
2845
2592
|
|
|
2846
2593
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2935,27 +2682,17 @@ class SessionsApi(object):
|
|
|
2935
2682
|
|
|
2936
2683
|
This method makes a synchronous HTTP request by default.
|
|
2937
2684
|
|
|
2938
|
-
:param session_id: 24-character hex ID
|
|
2939
|
-
:
|
|
2940
|
-
:param
|
|
2941
|
-
:
|
|
2942
|
-
:param
|
|
2943
|
-
:
|
|
2944
|
-
:param
|
|
2945
|
-
:
|
|
2946
|
-
:param
|
|
2947
|
-
:
|
|
2948
|
-
:
|
|
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]
|
|
2685
|
+
:param str session_id: 24-character hex ID (required)
|
|
2686
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2687
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2688
|
+
:param str ticket: ticket id of the outputs to download
|
|
2689
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2690
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2691
|
+
:param bool view: feature flag for view/download
|
|
2692
|
+
:param str range: byte ranges to return
|
|
2693
|
+
:param list[str] x_accept_feature: redirect header
|
|
2694
|
+
:param bool async_: Perform the request asynchronously
|
|
2695
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2959
2696
|
"""
|
|
2960
2697
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2961
2698
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2978,27 +2715,17 @@ class SessionsApi(object):
|
|
|
2978
2715
|
|
|
2979
2716
|
This method makes a synchronous HTTP request by default.
|
|
2980
2717
|
|
|
2981
|
-
:param session_id: 24-character hex ID
|
|
2982
|
-
:
|
|
2983
|
-
:param
|
|
2984
|
-
:
|
|
2985
|
-
:param
|
|
2986
|
-
:
|
|
2987
|
-
:param
|
|
2988
|
-
:
|
|
2989
|
-
:param
|
|
2990
|
-
:
|
|
2991
|
-
:
|
|
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]
|
|
2718
|
+
:param str session_id: 24-character hex ID (required)
|
|
2719
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2720
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2721
|
+
:param str ticket: ticket id of the outputs to download
|
|
2722
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2723
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2724
|
+
:param bool view: feature flag for view/download
|
|
2725
|
+
:param str range: byte ranges to return
|
|
2726
|
+
:param list[str] x_accept_feature: redirect header
|
|
2727
|
+
:param bool async_: Perform the request asynchronously
|
|
2728
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
3002
2729
|
"""
|
|
3003
2730
|
|
|
3004
2731
|
all_params = ['session_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -3092,33 +2819,20 @@ class SessionsApi(object):
|
|
|
3092
2819
|
Finds all sessions.
|
|
3093
2820
|
This method makes a synchronous HTTP request by default.
|
|
3094
2821
|
|
|
3095
|
-
:param exhaustive: Set to return a complete list regardless of permissions
|
|
3096
|
-
:
|
|
3097
|
-
:param
|
|
3098
|
-
:
|
|
3099
|
-
:param
|
|
3100
|
-
:
|
|
3101
|
-
:param
|
|
3102
|
-
:
|
|
3103
|
-
:param
|
|
3104
|
-
:
|
|
3105
|
-
:param
|
|
3106
|
-
:
|
|
3107
|
-
:param
|
|
3108
|
-
:
|
|
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]]
|
|
2822
|
+
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
2823
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2824
|
+
:param JoinType join: join file origins
|
|
2825
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2826
|
+
:param str user_id:
|
|
2827
|
+
:param str 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)
|
|
2828
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2829
|
+
:param int limit: The maximum number of entries to return.
|
|
2830
|
+
:param int skip: The number of entries to skip.
|
|
2831
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2832
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2833
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2834
|
+
:param bool async_: Perform the request asynchronously
|
|
2835
|
+
:return: union[Page,list[SessionListOutput]]
|
|
3122
2836
|
"""
|
|
3123
2837
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3124
2838
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3142,33 +2856,20 @@ class SessionsApi(object):
|
|
|
3142
2856
|
Finds all sessions.
|
|
3143
2857
|
This method makes a synchronous HTTP request by default.
|
|
3144
2858
|
|
|
3145
|
-
:param exhaustive: Set to return a complete list regardless of permissions
|
|
3146
|
-
:
|
|
3147
|
-
:param
|
|
3148
|
-
:
|
|
3149
|
-
:param
|
|
3150
|
-
:
|
|
3151
|
-
:param
|
|
3152
|
-
:
|
|
3153
|
-
:param
|
|
3154
|
-
:
|
|
3155
|
-
:param
|
|
3156
|
-
:
|
|
3157
|
-
:param
|
|
3158
|
-
:
|
|
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]]
|
|
2859
|
+
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
2860
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2861
|
+
:param JoinType join: join file origins
|
|
2862
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2863
|
+
:param str user_id:
|
|
2864
|
+
:param str 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)
|
|
2865
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2866
|
+
:param int limit: The maximum number of entries to return.
|
|
2867
|
+
:param int skip: The number of entries to skip.
|
|
2868
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2869
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2870
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2871
|
+
:param bool async_: Perform the request asynchronously
|
|
2872
|
+
:return: union[Page,list[SessionListOutput]]
|
|
3172
2873
|
"""
|
|
3173
2874
|
|
|
3174
2875
|
all_params = ['exhaustive','join_avatars','join','include_all_info','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3256,17 +2957,12 @@ class SessionsApi(object):
|
|
|
3256
2957
|
Get a single session
|
|
3257
2958
|
This method makes a synchronous HTTP request by default.
|
|
3258
2959
|
|
|
3259
|
-
:param session_id:
|
|
3260
|
-
:
|
|
3261
|
-
:param
|
|
3262
|
-
:
|
|
3263
|
-
:param
|
|
3264
|
-
:
|
|
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
|
|
2960
|
+
:param str session_id: (required)
|
|
2961
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2962
|
+
:param JoinType join:
|
|
2963
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2964
|
+
:param bool async_: Perform the request asynchronously
|
|
2965
|
+
:return: SessionOutput
|
|
3270
2966
|
"""
|
|
3271
2967
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3272
2968
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3290,17 +2986,12 @@ class SessionsApi(object):
|
|
|
3290
2986
|
Get a single session
|
|
3291
2987
|
This method makes a synchronous HTTP request by default.
|
|
3292
2988
|
|
|
3293
|
-
:param session_id:
|
|
3294
|
-
:
|
|
3295
|
-
:param
|
|
3296
|
-
:
|
|
3297
|
-
:param
|
|
3298
|
-
:
|
|
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
|
|
2989
|
+
:param str session_id: (required)
|
|
2990
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2991
|
+
:param JoinType join:
|
|
2992
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2993
|
+
:param bool async_: Perform the request asynchronously
|
|
2994
|
+
:return: SessionOutput
|
|
3304
2995
|
"""
|
|
3305
2996
|
|
|
3306
2997
|
all_params = ['session_id','join_avatars','join','x_accept_feature',] # noqa: E501
|
|
@@ -3376,33 +3067,20 @@ class SessionsApi(object):
|
|
|
3376
3067
|
Get acquisitions.
|
|
3377
3068
|
This method makes a synchronous HTTP request by default.
|
|
3378
3069
|
|
|
3379
|
-
:param session_id:
|
|
3380
|
-
:
|
|
3381
|
-
:param
|
|
3382
|
-
:
|
|
3383
|
-
:param
|
|
3384
|
-
:
|
|
3385
|
-
:param
|
|
3386
|
-
:
|
|
3387
|
-
:param
|
|
3388
|
-
:
|
|
3389
|
-
:param
|
|
3390
|
-
:
|
|
3391
|
-
:param
|
|
3392
|
-
:
|
|
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]
|
|
3070
|
+
:param str session_id: (required)
|
|
3071
|
+
:param str collection_id:
|
|
3072
|
+
:param bool exhaustive:
|
|
3073
|
+
:param JoinType join:
|
|
3074
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3075
|
+
:param str 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)
|
|
3076
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3077
|
+
:param int limit: The maximum number of entries to return.
|
|
3078
|
+
:param int skip: The number of entries to skip.
|
|
3079
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3080
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3081
|
+
:param list[str] x_accept_feature:
|
|
3082
|
+
:param bool async_: Perform the request asynchronously
|
|
3083
|
+
:return: union[list[AcquisitionListOutput],Page]
|
|
3406
3084
|
"""
|
|
3407
3085
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3408
3086
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3426,33 +3104,20 @@ class SessionsApi(object):
|
|
|
3426
3104
|
Get acquisitions.
|
|
3427
3105
|
This method makes a synchronous HTTP request by default.
|
|
3428
3106
|
|
|
3429
|
-
:param session_id:
|
|
3430
|
-
:
|
|
3431
|
-
:param
|
|
3432
|
-
:
|
|
3433
|
-
:param
|
|
3434
|
-
:
|
|
3435
|
-
:param
|
|
3436
|
-
:
|
|
3437
|
-
:param
|
|
3438
|
-
:
|
|
3439
|
-
:param
|
|
3440
|
-
:
|
|
3441
|
-
:param
|
|
3442
|
-
:
|
|
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]
|
|
3107
|
+
:param str session_id: (required)
|
|
3108
|
+
:param str collection_id:
|
|
3109
|
+
:param bool exhaustive:
|
|
3110
|
+
:param JoinType join:
|
|
3111
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3112
|
+
:param str 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)
|
|
3113
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3114
|
+
:param int limit: The maximum number of entries to return.
|
|
3115
|
+
:param int skip: The number of entries to skip.
|
|
3116
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3117
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3118
|
+
:param list[str] x_accept_feature:
|
|
3119
|
+
:param bool async_: Perform the request asynchronously
|
|
3120
|
+
:return: union[list[AcquisitionListOutput],Page]
|
|
3456
3121
|
"""
|
|
3457
3122
|
|
|
3458
3123
|
all_params = ['session_id','collection_id','exhaustive','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3544,33 +3209,20 @@ class SessionsApi(object):
|
|
|
3544
3209
|
Returns analyses that directly belong to this resource.
|
|
3545
3210
|
This method makes a synchronous HTTP request by default.
|
|
3546
3211
|
|
|
3547
|
-
:param cid:
|
|
3548
|
-
:
|
|
3549
|
-
:param
|
|
3550
|
-
:
|
|
3551
|
-
:param
|
|
3552
|
-
:
|
|
3553
|
-
:param
|
|
3554
|
-
:
|
|
3555
|
-
:param
|
|
3556
|
-
:
|
|
3557
|
-
:param
|
|
3558
|
-
:
|
|
3559
|
-
:param
|
|
3560
|
-
:
|
|
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]]]
|
|
3212
|
+
:param str cid: (required)
|
|
3213
|
+
:param bool inflate_job:
|
|
3214
|
+
:param bool join_avatars:
|
|
3215
|
+
:param JoinType join:
|
|
3216
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3217
|
+
:param str 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)
|
|
3218
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3219
|
+
:param int limit: The maximum number of entries to return.
|
|
3220
|
+
:param int skip: The number of entries to skip.
|
|
3221
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3222
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3223
|
+
:param list[str] x_accept_feature:
|
|
3224
|
+
:param bool async_: Perform the request asynchronously
|
|
3225
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3574
3226
|
"""
|
|
3575
3227
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3576
3228
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3594,33 +3246,20 @@ class SessionsApi(object):
|
|
|
3594
3246
|
Returns analyses that directly belong to this resource.
|
|
3595
3247
|
This method makes a synchronous HTTP request by default.
|
|
3596
3248
|
|
|
3597
|
-
:param cid:
|
|
3598
|
-
:
|
|
3599
|
-
:param
|
|
3600
|
-
:
|
|
3601
|
-
:param
|
|
3602
|
-
:
|
|
3603
|
-
:param
|
|
3604
|
-
:
|
|
3605
|
-
:param
|
|
3606
|
-
:
|
|
3607
|
-
:param
|
|
3608
|
-
:
|
|
3609
|
-
:param
|
|
3610
|
-
:
|
|
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]]]
|
|
3249
|
+
:param str cid: (required)
|
|
3250
|
+
:param bool inflate_job:
|
|
3251
|
+
:param bool join_avatars:
|
|
3252
|
+
:param JoinType join:
|
|
3253
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3254
|
+
:param str 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)
|
|
3255
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3256
|
+
:param int limit: The maximum number of entries to return.
|
|
3257
|
+
:param int skip: The number of entries to skip.
|
|
3258
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3259
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3260
|
+
:param list[str] x_accept_feature:
|
|
3261
|
+
:param bool async_: Perform the request asynchronously
|
|
3262
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3624
3263
|
"""
|
|
3625
3264
|
|
|
3626
3265
|
all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3712,19 +3351,13 @@ class SessionsApi(object):
|
|
|
3712
3351
|
Get an analysis.
|
|
3713
3352
|
This method makes a synchronous HTTP request by default.
|
|
3714
3353
|
|
|
3715
|
-
:param cid:
|
|
3716
|
-
:
|
|
3717
|
-
:param
|
|
3718
|
-
:
|
|
3719
|
-
:param
|
|
3720
|
-
:
|
|
3721
|
-
:
|
|
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]
|
|
3354
|
+
:param str cid: (required)
|
|
3355
|
+
:param str analysis_id: (required)
|
|
3356
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
3357
|
+
:param bool join_avatars:
|
|
3358
|
+
:param JoinType join:
|
|
3359
|
+
:param bool async_: Perform the request asynchronously
|
|
3360
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3728
3361
|
"""
|
|
3729
3362
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3730
3363
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3748,19 +3381,13 @@ class SessionsApi(object):
|
|
|
3748
3381
|
Get an analysis.
|
|
3749
3382
|
This method makes a synchronous HTTP request by default.
|
|
3750
3383
|
|
|
3751
|
-
:param cid:
|
|
3752
|
-
:
|
|
3753
|
-
:param
|
|
3754
|
-
:
|
|
3755
|
-
:param
|
|
3756
|
-
:
|
|
3757
|
-
:
|
|
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]
|
|
3384
|
+
:param str cid: (required)
|
|
3385
|
+
:param str analysis_id: (required)
|
|
3386
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
3387
|
+
:param bool join_avatars:
|
|
3388
|
+
:param JoinType join:
|
|
3389
|
+
:param bool async_: Perform the request asynchronously
|
|
3390
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3764
3391
|
"""
|
|
3765
3392
|
|
|
3766
3393
|
all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
|
|
@@ -3841,13 +3468,10 @@ class SessionsApi(object):
|
|
|
3841
3468
|
Get info for a particular file.
|
|
3842
3469
|
This method makes a synchronous HTTP request by default.
|
|
3843
3470
|
|
|
3844
|
-
:param cid: Container Id
|
|
3845
|
-
:
|
|
3846
|
-
:param
|
|
3847
|
-
:
|
|
3848
|
-
:param async_: Perform the request asynchronously
|
|
3849
|
-
:type async_: bool, optional
|
|
3850
|
-
:rtype: FileOutput
|
|
3471
|
+
:param str cid: Container Id (required)
|
|
3472
|
+
:param str filename: (required)
|
|
3473
|
+
:param bool async_: Perform the request asynchronously
|
|
3474
|
+
:return: FileOutput
|
|
3851
3475
|
"""
|
|
3852
3476
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3853
3477
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3871,13 +3495,10 @@ class SessionsApi(object):
|
|
|
3871
3495
|
Get info for a particular file.
|
|
3872
3496
|
This method makes a synchronous HTTP request by default.
|
|
3873
3497
|
|
|
3874
|
-
:param cid: Container Id
|
|
3875
|
-
:
|
|
3876
|
-
:param
|
|
3877
|
-
:
|
|
3878
|
-
:param async_: Perform the request asynchronously
|
|
3879
|
-
:type async_: bool, optional
|
|
3880
|
-
:rtype: FileOutput
|
|
3498
|
+
:param str cid: Container Id (required)
|
|
3499
|
+
:param str filename: (required)
|
|
3500
|
+
:param bool async_: Perform the request asynchronously
|
|
3501
|
+
:return: FileOutput
|
|
3881
3502
|
"""
|
|
3882
3503
|
|
|
3883
3504
|
all_params = ['cid','filename',] # noqa: E501
|
|
@@ -3952,31 +3573,19 @@ class SessionsApi(object):
|
|
|
3952
3573
|
Gets session jobs.
|
|
3953
3574
|
This method makes a synchronous HTTP request by default.
|
|
3954
3575
|
|
|
3955
|
-
:param session_id:
|
|
3956
|
-
:
|
|
3957
|
-
:param
|
|
3958
|
-
:
|
|
3959
|
-
:param
|
|
3960
|
-
:
|
|
3961
|
-
:param
|
|
3962
|
-
:
|
|
3963
|
-
:param
|
|
3964
|
-
:
|
|
3965
|
-
:param
|
|
3966
|
-
:
|
|
3967
|
-
:
|
|
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]
|
|
3576
|
+
:param str session_id: (required)
|
|
3577
|
+
:param list[str] states: filter results by job state
|
|
3578
|
+
:param list[str] tags: filter results by job tags
|
|
3579
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3580
|
+
:param str 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)
|
|
3581
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3582
|
+
:param int limit: The maximum number of entries to return.
|
|
3583
|
+
:param int skip: The number of entries to skip.
|
|
3584
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3585
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3586
|
+
:param list[str] x_accept_feature:
|
|
3587
|
+
:param bool async_: Perform the request asynchronously
|
|
3588
|
+
:return: union[JobsList,Page]
|
|
3980
3589
|
"""
|
|
3981
3590
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3982
3591
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4000,31 +3609,19 @@ class SessionsApi(object):
|
|
|
4000
3609
|
Gets session jobs.
|
|
4001
3610
|
This method makes a synchronous HTTP request by default.
|
|
4002
3611
|
|
|
4003
|
-
:param session_id:
|
|
4004
|
-
:
|
|
4005
|
-
:param
|
|
4006
|
-
:
|
|
4007
|
-
:param
|
|
4008
|
-
:
|
|
4009
|
-
:param
|
|
4010
|
-
:
|
|
4011
|
-
:param
|
|
4012
|
-
:
|
|
4013
|
-
:param
|
|
4014
|
-
:
|
|
4015
|
-
:
|
|
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]
|
|
3612
|
+
:param str session_id: (required)
|
|
3613
|
+
:param list[str] states: filter results by job state
|
|
3614
|
+
:param list[str] tags: filter results by job tags
|
|
3615
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3616
|
+
:param str 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)
|
|
3617
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3618
|
+
:param int limit: The maximum number of entries to return.
|
|
3619
|
+
:param int skip: The number of entries to skip.
|
|
3620
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3621
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3622
|
+
:param list[str] x_accept_feature:
|
|
3623
|
+
:param bool async_: Perform the request asynchronously
|
|
3624
|
+
:return: union[JobsList,Page]
|
|
4028
3625
|
"""
|
|
4029
3626
|
|
|
4030
3627
|
all_params = ['session_id','states','tags','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -4116,13 +3713,10 @@ class SessionsApi(object):
|
|
|
4116
3713
|
Get a note of a(n) session
|
|
4117
3714
|
This method makes a synchronous HTTP request by default.
|
|
4118
3715
|
|
|
4119
|
-
:param cid:
|
|
4120
|
-
:
|
|
4121
|
-
:param
|
|
4122
|
-
:
|
|
4123
|
-
:param async_: Perform the request asynchronously
|
|
4124
|
-
:type async_: bool, optional
|
|
4125
|
-
:rtype: Note
|
|
3716
|
+
:param str cid: (required)
|
|
3717
|
+
:param str note_id: (required)
|
|
3718
|
+
:param bool async_: Perform the request asynchronously
|
|
3719
|
+
:return: Note
|
|
4126
3720
|
"""
|
|
4127
3721
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4128
3722
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4146,13 +3740,10 @@ class SessionsApi(object):
|
|
|
4146
3740
|
Get a note of a(n) session
|
|
4147
3741
|
This method makes a synchronous HTTP request by default.
|
|
4148
3742
|
|
|
4149
|
-
:param cid:
|
|
4150
|
-
:
|
|
4151
|
-
:param
|
|
4152
|
-
:
|
|
4153
|
-
:param async_: Perform the request asynchronously
|
|
4154
|
-
:type async_: bool, optional
|
|
4155
|
-
:rtype: Note
|
|
3743
|
+
:param str cid: (required)
|
|
3744
|
+
:param str note_id: (required)
|
|
3745
|
+
:param bool async_: Perform the request asynchronously
|
|
3746
|
+
:return: Note
|
|
4156
3747
|
"""
|
|
4157
3748
|
|
|
4158
3749
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -4227,13 +3818,10 @@ class SessionsApi(object):
|
|
|
4227
3818
|
Get the value of a tag, by name
|
|
4228
3819
|
This method makes a synchronous HTTP request by default.
|
|
4229
3820
|
|
|
4230
|
-
:param cid:
|
|
4231
|
-
:
|
|
4232
|
-
:param
|
|
4233
|
-
:
|
|
4234
|
-
:param async_: Perform the request asynchronously
|
|
4235
|
-
:type async_: bool, optional
|
|
4236
|
-
:rtype: str
|
|
3821
|
+
:param str cid: (required)
|
|
3822
|
+
:param str value: The tag to interact with (required)
|
|
3823
|
+
:param bool async_: Perform the request asynchronously
|
|
3824
|
+
:return: str
|
|
4237
3825
|
"""
|
|
4238
3826
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4239
3827
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4257,13 +3845,10 @@ class SessionsApi(object):
|
|
|
4257
3845
|
Get the value of a tag, by name
|
|
4258
3846
|
This method makes a synchronous HTTP request by default.
|
|
4259
3847
|
|
|
4260
|
-
:param cid:
|
|
4261
|
-
:
|
|
4262
|
-
:param
|
|
4263
|
-
:
|
|
4264
|
-
:param async_: Perform the request asynchronously
|
|
4265
|
-
:type async_: bool, optional
|
|
4266
|
-
:rtype: str
|
|
3848
|
+
:param str cid: (required)
|
|
3849
|
+
:param str value: The tag to interact with (required)
|
|
3850
|
+
:param bool async_: Perform the request asynchronously
|
|
3851
|
+
:return: str
|
|
4267
3852
|
"""
|
|
4268
3853
|
|
|
4269
3854
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -4338,13 +3923,10 @@ class SessionsApi(object):
|
|
|
4338
3923
|
Modify a session.
|
|
4339
3924
|
This method makes a synchronous HTTP request by default.
|
|
4340
3925
|
|
|
4341
|
-
:param session_id:
|
|
4342
|
-
:
|
|
4343
|
-
:param
|
|
4344
|
-
:
|
|
4345
|
-
:param async_: Perform the request asynchronously
|
|
4346
|
-
:type async_: bool, optional
|
|
4347
|
-
:rtype: ModifiedResult
|
|
3926
|
+
:param str session_id: (required)
|
|
3927
|
+
:param SessionModify body: (required)
|
|
3928
|
+
:param bool async_: Perform the request asynchronously
|
|
3929
|
+
:return: ModifiedResult
|
|
4348
3930
|
"""
|
|
4349
3931
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4350
3932
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4368,13 +3950,10 @@ class SessionsApi(object):
|
|
|
4368
3950
|
Modify a session.
|
|
4369
3951
|
This method makes a synchronous HTTP request by default.
|
|
4370
3952
|
|
|
4371
|
-
:param session_id:
|
|
4372
|
-
:
|
|
4373
|
-
:param
|
|
4374
|
-
:
|
|
4375
|
-
:param async_: Perform the request asynchronously
|
|
4376
|
-
:type async_: bool, optional
|
|
4377
|
-
:rtype: ModifiedResult
|
|
3953
|
+
:param str session_id: (required)
|
|
3954
|
+
:param SessionModify body: (required)
|
|
3955
|
+
:param bool async_: Perform the request asynchronously
|
|
3956
|
+
:return: ModifiedResult
|
|
4378
3957
|
"""
|
|
4379
3958
|
|
|
4380
3959
|
all_params = ['session_id','body',] # noqa: E501
|
|
@@ -4460,15 +4039,11 @@ class SessionsApi(object):
|
|
|
4460
4039
|
Modify an analysis.
|
|
4461
4040
|
This method makes a synchronous HTTP request by default.
|
|
4462
4041
|
|
|
4463
|
-
:param cid:
|
|
4464
|
-
:
|
|
4465
|
-
:param
|
|
4466
|
-
:
|
|
4467
|
-
:
|
|
4468
|
-
:type body: AnalysisModifyInput
|
|
4469
|
-
:param async_: Perform the request asynchronously
|
|
4470
|
-
:type async_: bool, optional
|
|
4471
|
-
:rtype: ModifiedResult
|
|
4042
|
+
:param str cid: (required)
|
|
4043
|
+
:param str analysis_id: (required)
|
|
4044
|
+
:param AnalysisModifyInput body: (required)
|
|
4045
|
+
:param bool async_: Perform the request asynchronously
|
|
4046
|
+
:return: ModifiedResult
|
|
4472
4047
|
"""
|
|
4473
4048
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4474
4049
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4492,15 +4067,11 @@ class SessionsApi(object):
|
|
|
4492
4067
|
Modify an analysis.
|
|
4493
4068
|
This method makes a synchronous HTTP request by default.
|
|
4494
4069
|
|
|
4495
|
-
:param cid:
|
|
4496
|
-
:
|
|
4497
|
-
:param
|
|
4498
|
-
:
|
|
4499
|
-
:
|
|
4500
|
-
:type body: AnalysisModifyInput
|
|
4501
|
-
:param async_: Perform the request asynchronously
|
|
4502
|
-
:type async_: bool, optional
|
|
4503
|
-
:rtype: ModifiedResult
|
|
4070
|
+
:param str cid: (required)
|
|
4071
|
+
:param str analysis_id: (required)
|
|
4072
|
+
:param AnalysisModifyInput body: (required)
|
|
4073
|
+
:param bool async_: Perform the request asynchronously
|
|
4074
|
+
:return: ModifiedResult
|
|
4504
4075
|
"""
|
|
4505
4076
|
|
|
4506
4077
|
all_params = ['cid','analysis_id','body',] # noqa: E501
|
|
@@ -4592,15 +4163,11 @@ class SessionsApi(object):
|
|
|
4592
4163
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4593
4164
|
This method makes a synchronous HTTP request by default.
|
|
4594
4165
|
|
|
4595
|
-
:param cid:
|
|
4596
|
-
:
|
|
4597
|
-
:param
|
|
4598
|
-
:
|
|
4599
|
-
:
|
|
4600
|
-
:type body: FileModifyInput
|
|
4601
|
-
:param async_: Perform the request asynchronously
|
|
4602
|
-
:type async_: bool, optional
|
|
4603
|
-
:rtype: ModifiedResult
|
|
4166
|
+
:param str cid: (required)
|
|
4167
|
+
:param str filename: (required)
|
|
4168
|
+
:param FileModifyInput body: (required)
|
|
4169
|
+
:param bool async_: Perform the request asynchronously
|
|
4170
|
+
:return: ModifiedResult
|
|
4604
4171
|
"""
|
|
4605
4172
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4606
4173
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4624,15 +4191,11 @@ class SessionsApi(object):
|
|
|
4624
4191
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4625
4192
|
This method makes a synchronous HTTP request by default.
|
|
4626
4193
|
|
|
4627
|
-
:param cid:
|
|
4628
|
-
:
|
|
4629
|
-
:param
|
|
4630
|
-
:
|
|
4631
|
-
:
|
|
4632
|
-
:type body: FileModifyInput
|
|
4633
|
-
:param async_: Perform the request asynchronously
|
|
4634
|
-
:type async_: bool, optional
|
|
4635
|
-
:rtype: ModifiedResult
|
|
4194
|
+
:param str cid: (required)
|
|
4195
|
+
:param str filename: (required)
|
|
4196
|
+
:param FileModifyInput body: (required)
|
|
4197
|
+
:param bool async_: Perform the request asynchronously
|
|
4198
|
+
:return: ModifiedResult
|
|
4636
4199
|
"""
|
|
4637
4200
|
|
|
4638
4201
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4724,15 +4287,11 @@ class SessionsApi(object):
|
|
|
4724
4287
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4725
4288
|
This method makes a synchronous HTTP request by default.
|
|
4726
4289
|
|
|
4727
|
-
:param cid:
|
|
4728
|
-
:
|
|
4729
|
-
:param
|
|
4730
|
-
:
|
|
4731
|
-
:
|
|
4732
|
-
:type body: FileClassificationDelta
|
|
4733
|
-
:param async_: Perform the request asynchronously
|
|
4734
|
-
:type async_: bool, optional
|
|
4735
|
-
:rtype: ModifiedResult
|
|
4290
|
+
:param str cid: (required)
|
|
4291
|
+
:param str filename: (required)
|
|
4292
|
+
:param FileClassificationDelta body: (required)
|
|
4293
|
+
:param bool async_: Perform the request asynchronously
|
|
4294
|
+
:return: ModifiedResult
|
|
4736
4295
|
"""
|
|
4737
4296
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4738
4297
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4756,15 +4315,11 @@ class SessionsApi(object):
|
|
|
4756
4315
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4757
4316
|
This method makes a synchronous HTTP request by default.
|
|
4758
4317
|
|
|
4759
|
-
:param cid:
|
|
4760
|
-
:
|
|
4761
|
-
:param
|
|
4762
|
-
:
|
|
4763
|
-
:
|
|
4764
|
-
:type body: FileClassificationDelta
|
|
4765
|
-
:param async_: Perform the request asynchronously
|
|
4766
|
-
:type async_: bool, optional
|
|
4767
|
-
:rtype: ModifiedResult
|
|
4318
|
+
:param str cid: (required)
|
|
4319
|
+
:param str filename: (required)
|
|
4320
|
+
:param FileClassificationDelta body: (required)
|
|
4321
|
+
:param bool async_: Perform the request asynchronously
|
|
4322
|
+
:return: ModifiedResult
|
|
4768
4323
|
"""
|
|
4769
4324
|
|
|
4770
4325
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4856,15 +4411,11 @@ class SessionsApi(object):
|
|
|
4856
4411
|
Modify and return the file 'info' field
|
|
4857
4412
|
This method makes a synchronous HTTP request by default.
|
|
4858
4413
|
|
|
4859
|
-
:param cid:
|
|
4860
|
-
:
|
|
4861
|
-
:param
|
|
4862
|
-
:
|
|
4863
|
-
:
|
|
4864
|
-
:type body: Info
|
|
4865
|
-
:param async_: Perform the request asynchronously
|
|
4866
|
-
:type async_: bool, optional
|
|
4867
|
-
:rtype: ModifiedResult
|
|
4414
|
+
:param str cid: (required)
|
|
4415
|
+
:param str filename: (required)
|
|
4416
|
+
:param Info body: (required)
|
|
4417
|
+
:param bool async_: Perform the request asynchronously
|
|
4418
|
+
:return: ModifiedResult
|
|
4868
4419
|
"""
|
|
4869
4420
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4870
4421
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4888,15 +4439,11 @@ class SessionsApi(object):
|
|
|
4888
4439
|
Modify and return the file 'info' field
|
|
4889
4440
|
This method makes a synchronous HTTP request by default.
|
|
4890
4441
|
|
|
4891
|
-
:param cid:
|
|
4892
|
-
:
|
|
4893
|
-
:param
|
|
4894
|
-
:
|
|
4895
|
-
:
|
|
4896
|
-
:type body: Info
|
|
4897
|
-
:param async_: Perform the request asynchronously
|
|
4898
|
-
:type async_: bool, optional
|
|
4899
|
-
:rtype: ModifiedResult
|
|
4442
|
+
:param str cid: (required)
|
|
4443
|
+
:param str filename: (required)
|
|
4444
|
+
:param Info body: (required)
|
|
4445
|
+
:param bool async_: Perform the request asynchronously
|
|
4446
|
+
:return: ModifiedResult
|
|
4900
4447
|
"""
|
|
4901
4448
|
|
|
4902
4449
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4988,13 +4535,10 @@ class SessionsApi(object):
|
|
|
4988
4535
|
Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4989
4536
|
This method makes a synchronous HTTP request by default.
|
|
4990
4537
|
|
|
4991
|
-
:param cid:
|
|
4992
|
-
:
|
|
4993
|
-
:param
|
|
4994
|
-
:
|
|
4995
|
-
:param async_: Perform the request asynchronously
|
|
4996
|
-
:type async_: bool, optional
|
|
4997
|
-
:rtype: ModifiedResult
|
|
4538
|
+
:param str cid: (required)
|
|
4539
|
+
:param Info body: (required)
|
|
4540
|
+
:param bool async_: Perform the request asynchronously
|
|
4541
|
+
:return: ModifiedResult
|
|
4998
4542
|
"""
|
|
4999
4543
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5000
4544
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5018,13 +4562,10 @@ class SessionsApi(object):
|
|
|
5018
4562
|
Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
5019
4563
|
This method makes a synchronous HTTP request by default.
|
|
5020
4564
|
|
|
5021
|
-
:param cid:
|
|
5022
|
-
:
|
|
5023
|
-
:param
|
|
5024
|
-
:
|
|
5025
|
-
:param async_: Perform the request asynchronously
|
|
5026
|
-
:type async_: bool, optional
|
|
5027
|
-
:rtype: ModifiedResult
|
|
4565
|
+
:param str cid: (required)
|
|
4566
|
+
:param Info body: (required)
|
|
4567
|
+
:param bool async_: Perform the request asynchronously
|
|
4568
|
+
:return: ModifiedResult
|
|
5028
4569
|
"""
|
|
5029
4570
|
|
|
5030
4571
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -5110,15 +4651,11 @@ class SessionsApi(object):
|
|
|
5110
4651
|
Update a note of a(n) session
|
|
5111
4652
|
This method makes a synchronous HTTP request by default.
|
|
5112
4653
|
|
|
5113
|
-
:param cid:
|
|
5114
|
-
:
|
|
5115
|
-
:param
|
|
5116
|
-
:
|
|
5117
|
-
:
|
|
5118
|
-
:type body: NoteInput
|
|
5119
|
-
:param async_: Perform the request asynchronously
|
|
5120
|
-
:type async_: bool, optional
|
|
5121
|
-
:rtype: int
|
|
4654
|
+
:param str cid: (required)
|
|
4655
|
+
:param str note_id: (required)
|
|
4656
|
+
:param NoteInput body: (required)
|
|
4657
|
+
:param bool async_: Perform the request asynchronously
|
|
4658
|
+
:return: int
|
|
5122
4659
|
"""
|
|
5123
4660
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5124
4661
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5142,15 +4679,11 @@ class SessionsApi(object):
|
|
|
5142
4679
|
Update a note of a(n) session
|
|
5143
4680
|
This method makes a synchronous HTTP request by default.
|
|
5144
4681
|
|
|
5145
|
-
:param cid:
|
|
5146
|
-
:
|
|
5147
|
-
:param
|
|
5148
|
-
:
|
|
5149
|
-
:
|
|
5150
|
-
:type body: NoteInput
|
|
5151
|
-
:param async_: Perform the request asynchronously
|
|
5152
|
-
:type async_: bool, optional
|
|
5153
|
-
:rtype: int
|
|
4682
|
+
:param str cid: (required)
|
|
4683
|
+
:param str note_id: (required)
|
|
4684
|
+
:param NoteInput body: (required)
|
|
4685
|
+
:param bool async_: Perform the request asynchronously
|
|
4686
|
+
:return: int
|
|
5154
4687
|
"""
|
|
5155
4688
|
|
|
5156
4689
|
all_params = ['cid','note_id','body',] # noqa: E501
|
|
@@ -5242,15 +4775,11 @@ class SessionsApi(object):
|
|
|
5242
4775
|
Rename a tag
|
|
5243
4776
|
This method makes a synchronous HTTP request by default.
|
|
5244
4777
|
|
|
5245
|
-
:param cid:
|
|
5246
|
-
:
|
|
5247
|
-
:param
|
|
5248
|
-
:
|
|
5249
|
-
:
|
|
5250
|
-
:type body: Tag
|
|
5251
|
-
:param async_: Perform the request asynchronously
|
|
5252
|
-
:type async_: bool, optional
|
|
5253
|
-
:rtype: str
|
|
4778
|
+
:param str cid: (required)
|
|
4779
|
+
:param str value: The tag to interact with (required)
|
|
4780
|
+
:param Tag body: (required)
|
|
4781
|
+
:param bool async_: Perform the request asynchronously
|
|
4782
|
+
:return: str
|
|
5254
4783
|
"""
|
|
5255
4784
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5256
4785
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5274,15 +4803,11 @@ class SessionsApi(object):
|
|
|
5274
4803
|
Rename a tag
|
|
5275
4804
|
This method makes a synchronous HTTP request by default.
|
|
5276
4805
|
|
|
5277
|
-
:param cid:
|
|
5278
|
-
:
|
|
5279
|
-
:param
|
|
5280
|
-
:
|
|
5281
|
-
:
|
|
5282
|
-
:type body: Tag
|
|
5283
|
-
:param async_: Perform the request asynchronously
|
|
5284
|
-
:type async_: bool, optional
|
|
5285
|
-
:rtype: str
|
|
4806
|
+
:param str cid: (required)
|
|
4807
|
+
:param str value: The tag to interact with (required)
|
|
4808
|
+
:param Tag body: (required)
|
|
4809
|
+
:param bool async_: Perform the request asynchronously
|
|
4810
|
+
:return: str
|
|
5286
4811
|
"""
|
|
5287
4812
|
|
|
5288
4813
|
all_params = ['cid','value','body',] # noqa: E501
|
|
@@ -5374,13 +4899,10 @@ class SessionsApi(object):
|
|
|
5374
4899
|
Smart copy a session
|
|
5375
4900
|
This method makes a synchronous HTTP request by default.
|
|
5376
4901
|
|
|
5377
|
-
:param session_id:
|
|
5378
|
-
:
|
|
5379
|
-
:param
|
|
5380
|
-
:
|
|
5381
|
-
:param async_: Perform the request asynchronously
|
|
5382
|
-
:type async_: bool, optional
|
|
5383
|
-
:rtype: Session
|
|
4902
|
+
:param str session_id: (required)
|
|
4903
|
+
:param SessionCopyInput body: (required)
|
|
4904
|
+
:param bool async_: Perform the request asynchronously
|
|
4905
|
+
:return: Session
|
|
5384
4906
|
"""
|
|
5385
4907
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5386
4908
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5404,13 +4926,10 @@ class SessionsApi(object):
|
|
|
5404
4926
|
Smart copy a session
|
|
5405
4927
|
This method makes a synchronous HTTP request by default.
|
|
5406
4928
|
|
|
5407
|
-
:param session_id:
|
|
5408
|
-
:
|
|
5409
|
-
:param
|
|
5410
|
-
:
|
|
5411
|
-
:param async_: Perform the request asynchronously
|
|
5412
|
-
:type async_: bool, optional
|
|
5413
|
-
:rtype: Session
|
|
4929
|
+
:param str session_id: (required)
|
|
4930
|
+
:param SessionCopyInput body: (required)
|
|
4931
|
+
:param bool async_: Perform the request asynchronously
|
|
4932
|
+
:return: Session
|
|
5414
4933
|
"""
|
|
5415
4934
|
|
|
5416
4935
|
all_params = ['session_id','body',] # noqa: E501
|
|
@@ -5496,29 +5015,18 @@ class SessionsApi(object):
|
|
|
5496
5015
|
Upload a file to a(n) session.
|
|
5497
5016
|
This method makes a synchronous HTTP request by default.
|
|
5498
5017
|
|
|
5499
|
-
:param container_id:
|
|
5500
|
-
:
|
|
5501
|
-
:param
|
|
5502
|
-
:
|
|
5503
|
-
:param
|
|
5504
|
-
:
|
|
5505
|
-
:param
|
|
5506
|
-
:
|
|
5507
|
-
:param
|
|
5508
|
-
:
|
|
5509
|
-
:param
|
|
5510
|
-
:
|
|
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]
|
|
5018
|
+
:param str container_id: (required)
|
|
5019
|
+
:param str file: The file to upload (required)
|
|
5020
|
+
:param bool preserve_metadata:
|
|
5021
|
+
:param str ticket:
|
|
5022
|
+
:param str id:
|
|
5023
|
+
:param ContainerType level:
|
|
5024
|
+
:param str job:
|
|
5025
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5026
|
+
:param list[str] x_accept_feature: redirect header
|
|
5027
|
+
:param str content_type:
|
|
5028
|
+
:param bool async_: Perform the request asynchronously
|
|
5029
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
5522
5030
|
"""
|
|
5523
5031
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5524
5032
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5542,29 +5050,18 @@ class SessionsApi(object):
|
|
|
5542
5050
|
Upload a file to a(n) session.
|
|
5543
5051
|
This method makes a synchronous HTTP request by default.
|
|
5544
5052
|
|
|
5545
|
-
:param container_id:
|
|
5546
|
-
:
|
|
5547
|
-
:param
|
|
5548
|
-
:
|
|
5549
|
-
:param
|
|
5550
|
-
:
|
|
5551
|
-
:param
|
|
5552
|
-
:
|
|
5553
|
-
:param
|
|
5554
|
-
:
|
|
5555
|
-
:param
|
|
5556
|
-
:
|
|
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]
|
|
5053
|
+
:param str container_id: (required)
|
|
5054
|
+
:param str file: The file to upload (required)
|
|
5055
|
+
:param bool preserve_metadata:
|
|
5056
|
+
:param str ticket:
|
|
5057
|
+
:param str id:
|
|
5058
|
+
:param ContainerType level:
|
|
5059
|
+
:param str job:
|
|
5060
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5061
|
+
:param list[str] x_accept_feature: redirect header
|
|
5062
|
+
:param str content_type:
|
|
5063
|
+
:param bool async_: Perform the request asynchronously
|
|
5064
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
5568
5065
|
"""
|
|
5569
5066
|
|
|
5570
5067
|
all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|
|
@@ -5660,25 +5157,16 @@ class SessionsApi(object):
|
|
|
5660
5157
|
Upload an output file to an analysis
|
|
5661
5158
|
This method makes a synchronous HTTP request by default.
|
|
5662
5159
|
|
|
5663
|
-
:param cid:
|
|
5664
|
-
:
|
|
5665
|
-
:param
|
|
5666
|
-
:
|
|
5667
|
-
:param
|
|
5668
|
-
:
|
|
5669
|
-
:param
|
|
5670
|
-
:
|
|
5671
|
-
:param
|
|
5672
|
-
:
|
|
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]
|
|
5160
|
+
:param str cid: (required)
|
|
5161
|
+
:param str analysis_id: (required)
|
|
5162
|
+
:param str file: The file to upload (required)
|
|
5163
|
+
:param str ticket:
|
|
5164
|
+
:param str id:
|
|
5165
|
+
:param ContainerType level:
|
|
5166
|
+
:param str job:
|
|
5167
|
+
:param str content_type:
|
|
5168
|
+
:param bool async_: Perform the request asynchronously
|
|
5169
|
+
:return: list[FileOutput]
|
|
5682
5170
|
"""
|
|
5683
5171
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5684
5172
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5702,25 +5190,16 @@ class SessionsApi(object):
|
|
|
5702
5190
|
Upload an output file to an analysis
|
|
5703
5191
|
This method makes a synchronous HTTP request by default.
|
|
5704
5192
|
|
|
5705
|
-
:param cid:
|
|
5706
|
-
:
|
|
5707
|
-
:param
|
|
5708
|
-
:
|
|
5709
|
-
:param
|
|
5710
|
-
:
|
|
5711
|
-
:param
|
|
5712
|
-
:
|
|
5713
|
-
:param
|
|
5714
|
-
:
|
|
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]
|
|
5193
|
+
:param str cid: (required)
|
|
5194
|
+
:param str analysis_id: (required)
|
|
5195
|
+
:param str file: The file to upload (required)
|
|
5196
|
+
:param str ticket:
|
|
5197
|
+
:param str id:
|
|
5198
|
+
:param ContainerType level:
|
|
5199
|
+
:param str job:
|
|
5200
|
+
:param str content_type:
|
|
5201
|
+
:param bool async_: Perform the request asynchronously
|
|
5202
|
+
:return: list[FileOutput]
|
|
5724
5203
|
"""
|
|
5725
5204
|
|
|
5726
5205
|
all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
|