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/subjects_api.py
CHANGED
|
@@ -30,11 +30,9 @@ class SubjectsApi(object):
|
|
|
30
30
|
Create a new subject
|
|
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 SubjectInput 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 SubjectsApi(object):
|
|
|
58
56
|
Create a new subject
|
|
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 SubjectInput 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 SubjectsApi(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 SubjectsApi(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 SubjectsApi(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 SubjectsApi(object):
|
|
|
272
264
|
Add a note to a(n) subject 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 SubjectsApi(object):
|
|
|
304
292
|
Add a note to a(n) subject 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 SubjectsApi(object):
|
|
|
404
388
|
Add a note to a(n) subject.
|
|
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 SubjectsApi(object):
|
|
|
434
415
|
Add a note to a(n) subject.
|
|
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 SubjectsApi(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 SubjectsApi(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 SubjectsApi(object):
|
|
|
648
620
|
Add multiple tags to a(n) subject
|
|
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 SubjectsApi(object):
|
|
|
678
647
|
Add multiple tags to a(n) subject
|
|
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,11 +729,9 @@ class SubjectsApi(object):
|
|
|
763
729
|
The workflow is the following. - send `patient_id` (e.g., MRN) and/or `first_name`, `last_name`, `date_of_birth` - indicate whether to use `patient_id` for identification or `first_name`, `last_name`, `date_of_birth` by the `use_patient_id` field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the `patient_id`, you can save more information for that MSC in a second request (`first_name`, `last_name`, `date_of_birth`). Only the missing fields will be set, so you can't update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.
|
|
764
730
|
This method makes a synchronous HTTP request by default.
|
|
765
731
|
|
|
766
|
-
:param body:
|
|
767
|
-
:
|
|
768
|
-
:
|
|
769
|
-
:type async_: bool, optional
|
|
770
|
-
:rtype: MasterSubjectCodeOutput
|
|
732
|
+
:param union[MasterSubjectCodeInput,MasterSubjectCodeDobInput] body: (required)
|
|
733
|
+
:param bool async_: Perform the request asynchronously
|
|
734
|
+
:return: MasterSubjectCodeOutput
|
|
771
735
|
"""
|
|
772
736
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
773
737
|
kwargs['_return_http_data_only'] = True
|
|
@@ -791,11 +755,9 @@ class SubjectsApi(object):
|
|
|
791
755
|
The workflow is the following. - send `patient_id` (e.g., MRN) and/or `first_name`, `last_name`, `date_of_birth` - indicate whether to use `patient_id` for identification or `first_name`, `last_name`, `date_of_birth` by the `use_patient_id` field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the `patient_id`, you can save more information for that MSC in a second request (`first_name`, `last_name`, `date_of_birth`). Only the missing fields will be set, so you can't update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.
|
|
792
756
|
This method makes a synchronous HTTP request by default.
|
|
793
757
|
|
|
794
|
-
:param body:
|
|
795
|
-
:
|
|
796
|
-
:
|
|
797
|
-
:type async_: bool, optional
|
|
798
|
-
:rtype: MasterSubjectCodeOutput
|
|
758
|
+
:param union[MasterSubjectCodeInput,MasterSubjectCodeDobInput] body: (required)
|
|
759
|
+
:param bool async_: Perform the request asynchronously
|
|
760
|
+
:return: MasterSubjectCodeOutput
|
|
799
761
|
"""
|
|
800
762
|
|
|
801
763
|
all_params = ['body',] # noqa: E501
|
|
@@ -875,13 +837,10 @@ class SubjectsApi(object):
|
|
|
875
837
|
Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it's acquisitions contain data uploaded by sources other than users and jobs.
|
|
876
838
|
This method makes a synchronous HTTP request by default.
|
|
877
839
|
|
|
878
|
-
:param subject_id: 24-char hex subject id
|
|
879
|
-
:
|
|
880
|
-
:param
|
|
881
|
-
:
|
|
882
|
-
:param async_: Perform the request asynchronously
|
|
883
|
-
:type async_: bool, optional
|
|
884
|
-
:rtype: DeletedResult
|
|
840
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
841
|
+
:param ContainerDeleteReason delete_reason:
|
|
842
|
+
:param bool async_: Perform the request asynchronously
|
|
843
|
+
:return: DeletedResult
|
|
885
844
|
"""
|
|
886
845
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
887
846
|
kwargs['_return_http_data_only'] = True
|
|
@@ -905,13 +864,10 @@ class SubjectsApi(object):
|
|
|
905
864
|
Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it's acquisitions contain data uploaded by sources other than users and jobs.
|
|
906
865
|
This method makes a synchronous HTTP request by default.
|
|
907
866
|
|
|
908
|
-
:param subject_id: 24-char hex subject id
|
|
909
|
-
:
|
|
910
|
-
:param
|
|
911
|
-
:
|
|
912
|
-
:param async_: Perform the request asynchronously
|
|
913
|
-
:type async_: bool, optional
|
|
914
|
-
:rtype: DeletedResult
|
|
867
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
868
|
+
:param ContainerDeleteReason delete_reason:
|
|
869
|
+
:param bool async_: Perform the request asynchronously
|
|
870
|
+
:return: DeletedResult
|
|
915
871
|
"""
|
|
916
872
|
|
|
917
873
|
all_params = ['subject_id','delete_reason',] # noqa: E501
|
|
@@ -982,15 +938,11 @@ class SubjectsApi(object):
|
|
|
982
938
|
Delete an analysis for a container.
|
|
983
939
|
This method makes a synchronous HTTP request by default.
|
|
984
940
|
|
|
985
|
-
:param cid:
|
|
986
|
-
:
|
|
987
|
-
:param
|
|
988
|
-
:
|
|
989
|
-
:
|
|
990
|
-
:type delete_reason: ContainerDeleteReason, optional
|
|
991
|
-
:param async_: Perform the request asynchronously
|
|
992
|
-
:type async_: bool, optional
|
|
993
|
-
:rtype: DeletedResult
|
|
941
|
+
:param str cid: (required)
|
|
942
|
+
:param str analysis_id: (required)
|
|
943
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
944
|
+
:param bool async_: Perform the request asynchronously
|
|
945
|
+
:return: DeletedResult
|
|
994
946
|
"""
|
|
995
947
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
996
948
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1014,15 +966,11 @@ class SubjectsApi(object):
|
|
|
1014
966
|
Delete an analysis for a container.
|
|
1015
967
|
This method makes a synchronous HTTP request by default.
|
|
1016
968
|
|
|
1017
|
-
:param cid:
|
|
1018
|
-
:
|
|
1019
|
-
:param
|
|
1020
|
-
:
|
|
1021
|
-
:
|
|
1022
|
-
:type delete_reason: ContainerDeleteReason, optional
|
|
1023
|
-
:param async_: Perform the request asynchronously
|
|
1024
|
-
:type async_: bool, optional
|
|
1025
|
-
:rtype: DeletedResult
|
|
969
|
+
:param str cid: (required)
|
|
970
|
+
:param str analysis_id: (required)
|
|
971
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
972
|
+
:param bool async_: Perform the request asynchronously
|
|
973
|
+
:return: DeletedResult
|
|
1026
974
|
"""
|
|
1027
975
|
|
|
1028
976
|
all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
|
|
@@ -1099,15 +1047,11 @@ class SubjectsApi(object):
|
|
|
1099
1047
|
Remove a note from a(n) subject analysis.
|
|
1100
1048
|
This method makes a synchronous HTTP request by default.
|
|
1101
1049
|
|
|
1102
|
-
:param cid: 24-char hex id
|
|
1103
|
-
:
|
|
1104
|
-
:param
|
|
1105
|
-
:
|
|
1106
|
-
:
|
|
1107
|
-
:type note_id: str
|
|
1108
|
-
:param async_: Perform the request asynchronously
|
|
1109
|
-
:type async_: bool, optional
|
|
1110
|
-
:rtype: DeletedResult
|
|
1050
|
+
:param str cid: 24-char hex id (required)
|
|
1051
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
1052
|
+
:param str note_id: 24-char hex note id (required)
|
|
1053
|
+
:param bool async_: Perform the request asynchronously
|
|
1054
|
+
:return: DeletedResult
|
|
1111
1055
|
"""
|
|
1112
1056
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1113
1057
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1131,15 +1075,11 @@ class SubjectsApi(object):
|
|
|
1131
1075
|
Remove a note from a(n) subject analysis.
|
|
1132
1076
|
This method makes a synchronous HTTP request by default.
|
|
1133
1077
|
|
|
1134
|
-
:param cid: 24-char hex id
|
|
1135
|
-
:
|
|
1136
|
-
:param
|
|
1137
|
-
:
|
|
1138
|
-
:
|
|
1139
|
-
:type note_id: str
|
|
1140
|
-
:param async_: Perform the request asynchronously
|
|
1141
|
-
:type async_: bool, optional
|
|
1142
|
-
:rtype: DeletedResult
|
|
1078
|
+
:param str cid: 24-char hex id (required)
|
|
1079
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
1080
|
+
:param str note_id: 24-char hex note id (required)
|
|
1081
|
+
:param bool async_: Perform the request asynchronously
|
|
1082
|
+
:return: DeletedResult
|
|
1143
1083
|
"""
|
|
1144
1084
|
|
|
1145
1085
|
all_params = ['cid','analysis_id','note_id',] # noqa: E501
|
|
@@ -1220,17 +1160,12 @@ class SubjectsApi(object):
|
|
|
1220
1160
|
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.
|
|
1221
1161
|
This method makes a synchronous HTTP request by default.
|
|
1222
1162
|
|
|
1223
|
-
:param cid:
|
|
1224
|
-
:
|
|
1225
|
-
:param
|
|
1226
|
-
:
|
|
1227
|
-
:param
|
|
1228
|
-
:
|
|
1229
|
-
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
1230
|
-
:type force: bool, optional
|
|
1231
|
-
:param async_: Perform the request asynchronously
|
|
1232
|
-
:type async_: bool, optional
|
|
1233
|
-
:rtype: DeletedResult
|
|
1163
|
+
:param str cid: (required)
|
|
1164
|
+
:param str filename: (required)
|
|
1165
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1166
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1167
|
+
:param bool async_: Perform the request asynchronously
|
|
1168
|
+
:return: DeletedResult
|
|
1234
1169
|
"""
|
|
1235
1170
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1236
1171
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1254,17 +1189,12 @@ class SubjectsApi(object):
|
|
|
1254
1189
|
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.
|
|
1255
1190
|
This method makes a synchronous HTTP request by default.
|
|
1256
1191
|
|
|
1257
|
-
:param cid:
|
|
1258
|
-
:
|
|
1259
|
-
:param
|
|
1260
|
-
:
|
|
1261
|
-
:param
|
|
1262
|
-
:
|
|
1263
|
-
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
1264
|
-
:type force: bool, optional
|
|
1265
|
-
:param async_: Perform the request asynchronously
|
|
1266
|
-
:type async_: bool, optional
|
|
1267
|
-
:rtype: DeletedResult
|
|
1192
|
+
:param str cid: (required)
|
|
1193
|
+
:param str filename: (required)
|
|
1194
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1195
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1196
|
+
:param bool async_: Perform the request asynchronously
|
|
1197
|
+
:return: DeletedResult
|
|
1268
1198
|
"""
|
|
1269
1199
|
|
|
1270
1200
|
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
@@ -1343,13 +1273,10 @@ class SubjectsApi(object):
|
|
|
1343
1273
|
Remove a note from a(n) subject
|
|
1344
1274
|
This method makes a synchronous HTTP request by default.
|
|
1345
1275
|
|
|
1346
|
-
:param cid:
|
|
1347
|
-
:
|
|
1348
|
-
:param
|
|
1349
|
-
:
|
|
1350
|
-
:param async_: Perform the request asynchronously
|
|
1351
|
-
:type async_: bool, optional
|
|
1352
|
-
:rtype: DeletedResult
|
|
1276
|
+
:param str cid: (required)
|
|
1277
|
+
:param str note_id: (required)
|
|
1278
|
+
:param bool async_: Perform the request asynchronously
|
|
1279
|
+
:return: DeletedResult
|
|
1353
1280
|
"""
|
|
1354
1281
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1355
1282
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1373,13 +1300,10 @@ class SubjectsApi(object):
|
|
|
1373
1300
|
Remove a note from a(n) subject
|
|
1374
1301
|
This method makes a synchronous HTTP request by default.
|
|
1375
1302
|
|
|
1376
|
-
:param cid:
|
|
1377
|
-
:
|
|
1378
|
-
:param
|
|
1379
|
-
:
|
|
1380
|
-
:param async_: Perform the request asynchronously
|
|
1381
|
-
:type async_: bool, optional
|
|
1382
|
-
:rtype: DeletedResult
|
|
1303
|
+
:param str cid: (required)
|
|
1304
|
+
:param str note_id: (required)
|
|
1305
|
+
:param bool async_: Perform the request asynchronously
|
|
1306
|
+
:return: DeletedResult
|
|
1383
1307
|
"""
|
|
1384
1308
|
|
|
1385
1309
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -1454,13 +1378,10 @@ class SubjectsApi(object):
|
|
|
1454
1378
|
Delete a tag
|
|
1455
1379
|
This method makes a synchronous HTTP request by default.
|
|
1456
1380
|
|
|
1457
|
-
:param cid:
|
|
1458
|
-
:
|
|
1459
|
-
:param
|
|
1460
|
-
:
|
|
1461
|
-
:param async_: Perform the request asynchronously
|
|
1462
|
-
:type async_: bool, optional
|
|
1463
|
-
:rtype: DeletedResult
|
|
1381
|
+
:param str cid: (required)
|
|
1382
|
+
:param str value: The tag to interact with (required)
|
|
1383
|
+
:param bool async_: Perform the request asynchronously
|
|
1384
|
+
:return: DeletedResult
|
|
1464
1385
|
"""
|
|
1465
1386
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1466
1387
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1484,13 +1405,10 @@ class SubjectsApi(object):
|
|
|
1484
1405
|
Delete a tag
|
|
1485
1406
|
This method makes a synchronous HTTP request by default.
|
|
1486
1407
|
|
|
1487
|
-
:param cid:
|
|
1488
|
-
:
|
|
1489
|
-
:param
|
|
1490
|
-
:
|
|
1491
|
-
:param async_: Perform the request asynchronously
|
|
1492
|
-
:type async_: bool, optional
|
|
1493
|
-
:rtype: DeletedResult
|
|
1408
|
+
:param str cid: (required)
|
|
1409
|
+
:param str value: The tag to interact with (required)
|
|
1410
|
+
:param bool async_: Perform the request asynchronously
|
|
1411
|
+
:return: DeletedResult
|
|
1494
1412
|
"""
|
|
1495
1413
|
|
|
1496
1414
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -1565,13 +1483,10 @@ class SubjectsApi(object):
|
|
|
1565
1483
|
Delete multiple tags from a(n) subject
|
|
1566
1484
|
This method makes a synchronous HTTP request by default.
|
|
1567
1485
|
|
|
1568
|
-
:param cid:
|
|
1569
|
-
:
|
|
1570
|
-
:param
|
|
1571
|
-
:
|
|
1572
|
-
:param async_: Perform the request asynchronously
|
|
1573
|
-
:type async_: bool, optional
|
|
1574
|
-
:rtype: None
|
|
1486
|
+
:param str cid: (required)
|
|
1487
|
+
:param list[str] body: (required)
|
|
1488
|
+
:param bool async_: Perform the request asynchronously
|
|
1489
|
+
:return: None
|
|
1575
1490
|
"""
|
|
1576
1491
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1577
1492
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1595,13 +1510,10 @@ class SubjectsApi(object):
|
|
|
1595
1510
|
Delete multiple tags from a(n) subject
|
|
1596
1511
|
This method makes a synchronous HTTP request by default.
|
|
1597
1512
|
|
|
1598
|
-
:param cid:
|
|
1599
|
-
:
|
|
1600
|
-
:param
|
|
1601
|
-
:
|
|
1602
|
-
:param async_: Perform the request asynchronously
|
|
1603
|
-
:type async_: bool, optional
|
|
1604
|
-
:rtype: None
|
|
1513
|
+
:param str cid: (required)
|
|
1514
|
+
:param list[str] body: (required)
|
|
1515
|
+
:param bool async_: Perform the request asynchronously
|
|
1516
|
+
:return: None
|
|
1605
1517
|
"""
|
|
1606
1518
|
|
|
1607
1519
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -1680,13 +1592,10 @@ class SubjectsApi(object):
|
|
|
1680
1592
|
Delete multiple subjects by ID list
|
|
1681
1593
|
This method makes a synchronous HTTP request by default.
|
|
1682
1594
|
|
|
1683
|
-
:param body: List of IDs to delete
|
|
1684
|
-
:
|
|
1685
|
-
:param
|
|
1686
|
-
:
|
|
1687
|
-
:param async_: Perform the request asynchronously
|
|
1688
|
-
:type async_: bool, optional
|
|
1689
|
-
:rtype: DeletedResult
|
|
1595
|
+
:param list[str] body: List of IDs to delete (required)
|
|
1596
|
+
:param ContainerDeleteReason delete_reason:
|
|
1597
|
+
:param bool async_: Perform the request asynchronously
|
|
1598
|
+
:return: DeletedResult
|
|
1690
1599
|
"""
|
|
1691
1600
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1692
1601
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1710,13 +1619,10 @@ class SubjectsApi(object):
|
|
|
1710
1619
|
Delete multiple subjects by ID list
|
|
1711
1620
|
This method makes a synchronous HTTP request by default.
|
|
1712
1621
|
|
|
1713
|
-
:param body: List of IDs to delete
|
|
1714
|
-
:
|
|
1715
|
-
:param
|
|
1716
|
-
:
|
|
1717
|
-
:param async_: Perform the request asynchronously
|
|
1718
|
-
:type async_: bool, optional
|
|
1719
|
-
:rtype: DeletedResult
|
|
1622
|
+
:param list[str] body: List of IDs to delete (required)
|
|
1623
|
+
:param ContainerDeleteReason delete_reason:
|
|
1624
|
+
:param bool async_: Perform the request asynchronously
|
|
1625
|
+
:return: DeletedResult
|
|
1720
1626
|
"""
|
|
1721
1627
|
|
|
1722
1628
|
all_params = ['body','delete_reason',] # noqa: E501
|
|
@@ -1791,29 +1697,18 @@ class SubjectsApi(object):
|
|
|
1791
1697
|
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.
|
|
1792
1698
|
This method makes a synchronous HTTP request by default.
|
|
1793
1699
|
|
|
1794
|
-
:param subject_id: 24-character hex ID
|
|
1795
|
-
:
|
|
1796
|
-
:param
|
|
1797
|
-
:
|
|
1798
|
-
:param
|
|
1799
|
-
:
|
|
1800
|
-
:param
|
|
1801
|
-
:
|
|
1802
|
-
:param
|
|
1803
|
-
:
|
|
1804
|
-
:param
|
|
1805
|
-
:
|
|
1806
|
-
:param hash: file hash for comparison
|
|
1807
|
-
:type hash: str, optional
|
|
1808
|
-
:param range: byte ranges to return
|
|
1809
|
-
:type range: str, optional
|
|
1810
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
1811
|
-
:type x_accept_feature: list[str], optional
|
|
1812
|
-
:param dest_file: Destination file path
|
|
1813
|
-
:type dest_file: str
|
|
1814
|
-
:param async_: Perform the request asynchronously
|
|
1815
|
-
:type async_: bool, optional
|
|
1816
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1700
|
+
:param str subject_id: 24-character hex ID (required)
|
|
1701
|
+
:param str file_name: output file name (required)
|
|
1702
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1703
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1704
|
+
: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\"
|
|
1705
|
+
:param int version: version of the file to download
|
|
1706
|
+
:param str hash: file hash for comparison
|
|
1707
|
+
:param str range: byte ranges to return
|
|
1708
|
+
:param list[str] x_accept_feature: redirect header
|
|
1709
|
+
:param str dest_file: Destination file path
|
|
1710
|
+
:param bool async_: Perform the request asynchronously
|
|
1711
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1817
1712
|
"""
|
|
1818
1713
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1819
1714
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1836,27 +1731,17 @@ class SubjectsApi(object):
|
|
|
1836
1731
|
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.
|
|
1837
1732
|
This method makes a synchronous HTTP request by default.
|
|
1838
1733
|
|
|
1839
|
-
:param subject_id: 24-character hex ID
|
|
1840
|
-
:
|
|
1841
|
-
:param
|
|
1842
|
-
:
|
|
1843
|
-
:param
|
|
1844
|
-
:
|
|
1845
|
-
:param
|
|
1846
|
-
:
|
|
1847
|
-
:param
|
|
1848
|
-
:
|
|
1849
|
-
:
|
|
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: union[DownloadTicketStub,ZipfileInfo]
|
|
1734
|
+
:param str subject_id: 24-character hex ID (required)
|
|
1735
|
+
:param str file_name: output file name (required)
|
|
1736
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1737
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1738
|
+
: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\"
|
|
1739
|
+
:param int version: version of the file to download
|
|
1740
|
+
:param str hash: file hash for comparison
|
|
1741
|
+
:param str range: byte ranges to return
|
|
1742
|
+
:param list[str] x_accept_feature: redirect header
|
|
1743
|
+
:param bool async_: Perform the request asynchronously
|
|
1744
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1860
1745
|
"""
|
|
1861
1746
|
|
|
1862
1747
|
all_params = ['subject_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1946,29 +1831,18 @@ class SubjectsApi(object):
|
|
|
1946
1831
|
Does not work on files whose names contain a forward slash.
|
|
1947
1832
|
This method makes a synchronous HTTP request by default.
|
|
1948
1833
|
|
|
1949
|
-
:param subject_id: 24-character hex ID
|
|
1950
|
-
:
|
|
1951
|
-
:param
|
|
1952
|
-
:
|
|
1953
|
-
:param
|
|
1954
|
-
:
|
|
1955
|
-
:param
|
|
1956
|
-
:
|
|
1957
|
-
:param
|
|
1958
|
-
:
|
|
1959
|
-
:param
|
|
1960
|
-
:
|
|
1961
|
-
:param version: version of the file to download
|
|
1962
|
-
:type version: int, optional
|
|
1963
|
-
:param hash: file hash for comparison
|
|
1964
|
-
:type hash: str, optional
|
|
1965
|
-
:param range: byte ranges to return
|
|
1966
|
-
:type range: str, optional
|
|
1967
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
1968
|
-
:type x_accept_feature: list[str], optional
|
|
1969
|
-
:param async_: Perform the request asynchronously
|
|
1970
|
-
:type async_: bool, optional
|
|
1971
|
-
:rtype: FileZipInfo
|
|
1834
|
+
:param str subject_id: 24-character hex ID (required)
|
|
1835
|
+
:param str file_name: output file name (required)
|
|
1836
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1837
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1838
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1839
|
+
: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\"
|
|
1840
|
+
:param int version: version of the file to download
|
|
1841
|
+
:param str hash: file hash for comparison
|
|
1842
|
+
:param str range: byte ranges to return
|
|
1843
|
+
:param list[str] x_accept_feature: redirect header
|
|
1844
|
+
:param bool async_: Perform the request asynchronously
|
|
1845
|
+
:return: FileZipInfo
|
|
1972
1846
|
"""
|
|
1973
1847
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1974
1848
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1992,29 +1866,18 @@ class SubjectsApi(object):
|
|
|
1992
1866
|
Does not work on files whose names contain a forward slash.
|
|
1993
1867
|
This method makes a synchronous HTTP request by default.
|
|
1994
1868
|
|
|
1995
|
-
:param subject_id: 24-character hex ID
|
|
1996
|
-
:
|
|
1997
|
-
:param
|
|
1998
|
-
:
|
|
1999
|
-
:param
|
|
2000
|
-
:
|
|
2001
|
-
:param
|
|
2002
|
-
:
|
|
2003
|
-
:param
|
|
2004
|
-
:
|
|
2005
|
-
:param
|
|
2006
|
-
:
|
|
2007
|
-
:param version: version of the file to download
|
|
2008
|
-
:type version: int, optional
|
|
2009
|
-
:param hash: file hash for comparison
|
|
2010
|
-
:type hash: str, optional
|
|
2011
|
-
:param range: byte ranges to return
|
|
2012
|
-
:type range: str, optional
|
|
2013
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2014
|
-
:type x_accept_feature: list[str], optional
|
|
2015
|
-
:param async_: Perform the request asynchronously
|
|
2016
|
-
:type async_: bool, optional
|
|
2017
|
-
:rtype: FileZipInfo
|
|
1869
|
+
:param str subject_id: 24-character hex ID (required)
|
|
1870
|
+
:param str file_name: output file name (required)
|
|
1871
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1872
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1873
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1874
|
+
: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\"
|
|
1875
|
+
:param int version: version of the file to download
|
|
1876
|
+
:param str hash: file hash for comparison
|
|
1877
|
+
:param str range: byte ranges to return
|
|
1878
|
+
:param list[str] x_accept_feature: redirect header
|
|
1879
|
+
:param bool async_: Perform the request asynchronously
|
|
1880
|
+
:return: FileZipInfo
|
|
2018
1881
|
"""
|
|
2019
1882
|
|
|
2020
1883
|
all_params = ['subject_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -2107,29 +1970,18 @@ class SubjectsApi(object):
|
|
|
2107
1970
|
|
|
2108
1971
|
This method makes a synchronous HTTP request by default.
|
|
2109
1972
|
|
|
2110
|
-
:param subject_id: 24-character hex ID
|
|
2111
|
-
:
|
|
2112
|
-
:param
|
|
2113
|
-
:
|
|
2114
|
-
:param
|
|
2115
|
-
:
|
|
2116
|
-
:param
|
|
2117
|
-
:
|
|
2118
|
-
:param
|
|
2119
|
-
:
|
|
2120
|
-
:param
|
|
2121
|
-
:
|
|
2122
|
-
:param version: version of the file to download
|
|
2123
|
-
:type version: int, optional
|
|
2124
|
-
:param hash: file hash for comparison
|
|
2125
|
-
:type hash: str, optional
|
|
2126
|
-
:param range: byte ranges to return
|
|
2127
|
-
:type range: str, optional
|
|
2128
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2129
|
-
:type x_accept_feature: list[str], optional
|
|
2130
|
-
:param async_: Perform the request asynchronously
|
|
2131
|
-
:type async_: bool, optional
|
|
2132
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1973
|
+
:param str subject_id: 24-character hex ID (required)
|
|
1974
|
+
:param str file_name: output file name (required)
|
|
1975
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1976
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1977
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1978
|
+
: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\"
|
|
1979
|
+
:param int version: version of the file to download
|
|
1980
|
+
:param str hash: file hash for comparison
|
|
1981
|
+
:param str range: byte ranges to return
|
|
1982
|
+
:param list[str] x_accept_feature: redirect header
|
|
1983
|
+
:param bool async_: Perform the request asynchronously
|
|
1984
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2133
1985
|
"""
|
|
2134
1986
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2135
1987
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2152,29 +2004,18 @@ class SubjectsApi(object):
|
|
|
2152
2004
|
|
|
2153
2005
|
This method makes a synchronous HTTP request by default.
|
|
2154
2006
|
|
|
2155
|
-
:param subject_id: 24-character hex ID
|
|
2156
|
-
:
|
|
2157
|
-
:param
|
|
2158
|
-
:
|
|
2159
|
-
:param
|
|
2160
|
-
:
|
|
2161
|
-
:param
|
|
2162
|
-
:
|
|
2163
|
-
:param
|
|
2164
|
-
:
|
|
2165
|
-
:param
|
|
2166
|
-
:
|
|
2167
|
-
:param version: version of the file to download
|
|
2168
|
-
:type version: int, optional
|
|
2169
|
-
:param hash: file hash for comparison
|
|
2170
|
-
:type hash: str, optional
|
|
2171
|
-
:param range: byte ranges to return
|
|
2172
|
-
:type range: str, optional
|
|
2173
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2174
|
-
:type x_accept_feature: list[str], optional
|
|
2175
|
-
:param async_: Perform the request asynchronously
|
|
2176
|
-
:type async_: bool, optional
|
|
2177
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2007
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2008
|
+
:param str file_name: output file name (required)
|
|
2009
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
2010
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2011
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2012
|
+
: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\"
|
|
2013
|
+
:param int version: version of the file to download
|
|
2014
|
+
:param str hash: file hash for comparison
|
|
2015
|
+
:param str range: byte ranges to return
|
|
2016
|
+
:param list[str] x_accept_feature: redirect header
|
|
2017
|
+
:param bool async_: Perform the request asynchronously
|
|
2018
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2178
2019
|
"""
|
|
2179
2020
|
|
|
2180
2021
|
all_params = ['subject_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -2266,27 +2107,17 @@ class SubjectsApi(object):
|
|
|
2266
2107
|
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.
|
|
2267
2108
|
This method makes a synchronous HTTP request by default.
|
|
2268
2109
|
|
|
2269
|
-
:param subject_id: 24-character hex ID
|
|
2270
|
-
:
|
|
2271
|
-
:param
|
|
2272
|
-
:
|
|
2273
|
-
:param
|
|
2274
|
-
:
|
|
2275
|
-
:param
|
|
2276
|
-
:
|
|
2277
|
-
:param
|
|
2278
|
-
:
|
|
2279
|
-
:
|
|
2280
|
-
:type view: bool, optional
|
|
2281
|
-
:param range: byte ranges to return
|
|
2282
|
-
:type range: str, optional
|
|
2283
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2284
|
-
:type x_accept_feature: list[str], optional
|
|
2285
|
-
:param dest_file: Destination file path
|
|
2286
|
-
:type dest_file: str
|
|
2287
|
-
:param async_: Perform the request asynchronously
|
|
2288
|
-
:type async_: bool, optional
|
|
2289
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2110
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2111
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2112
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2113
|
+
:param bool info: get file info only
|
|
2114
|
+
:param str member: get zipfile member
|
|
2115
|
+
:param bool view: feature flag for view/download
|
|
2116
|
+
:param str range: byte ranges to return
|
|
2117
|
+
:param list[str] x_accept_feature: redirect header
|
|
2118
|
+
:param str dest_file: Destination file path
|
|
2119
|
+
:param bool async_: Perform the request asynchronously
|
|
2120
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2290
2121
|
"""
|
|
2291
2122
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2292
2123
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2309,25 +2140,16 @@ class SubjectsApi(object):
|
|
|
2309
2140
|
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.
|
|
2310
2141
|
This method makes a synchronous HTTP request by default.
|
|
2311
2142
|
|
|
2312
|
-
:param subject_id: 24-character hex ID
|
|
2313
|
-
:
|
|
2314
|
-
:param
|
|
2315
|
-
:
|
|
2316
|
-
:param
|
|
2317
|
-
:
|
|
2318
|
-
:param
|
|
2319
|
-
:
|
|
2320
|
-
:param
|
|
2321
|
-
:
|
|
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: union[DownloadTicketStub,ZipfileInfo]
|
|
2143
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2144
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2145
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2146
|
+
:param bool info: get file info only
|
|
2147
|
+
:param str member: get zipfile member
|
|
2148
|
+
:param bool view: feature flag for view/download
|
|
2149
|
+
:param str range: byte ranges to return
|
|
2150
|
+
:param list[str] x_accept_feature: redirect header
|
|
2151
|
+
:param bool async_: Perform the request asynchronously
|
|
2152
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2331
2153
|
"""
|
|
2332
2154
|
|
|
2333
2155
|
all_params = ['subject_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2419,27 +2241,17 @@ class SubjectsApi(object):
|
|
|
2419
2241
|
Does not work on files whose names contain a forward slash.
|
|
2420
2242
|
This method makes a synchronous HTTP request by default.
|
|
2421
2243
|
|
|
2422
|
-
:param subject_id: 24-character hex ID
|
|
2423
|
-
:
|
|
2424
|
-
:param
|
|
2425
|
-
:
|
|
2426
|
-
:param
|
|
2427
|
-
:
|
|
2428
|
-
:param
|
|
2429
|
-
:
|
|
2430
|
-
:param
|
|
2431
|
-
:
|
|
2432
|
-
:
|
|
2433
|
-
:type member: str, optional
|
|
2434
|
-
:param view: feature flag for view/download, defaults to false
|
|
2435
|
-
:type view: bool, optional
|
|
2436
|
-
:param range: byte ranges to return
|
|
2437
|
-
:type range: str, optional
|
|
2438
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2439
|
-
:type x_accept_feature: list[str], optional
|
|
2440
|
-
:param async_: Perform the request asynchronously
|
|
2441
|
-
:type async_: bool, optional
|
|
2442
|
-
:rtype: FileZipInfo
|
|
2244
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2245
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2246
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2247
|
+
:param str ticket: 24-char hex ticket id
|
|
2248
|
+
:param bool info: get file info only
|
|
2249
|
+
:param str member: get zipfile member
|
|
2250
|
+
:param bool view: feature flag for view/download
|
|
2251
|
+
:param str range: byte ranges to return
|
|
2252
|
+
:param list[str] x_accept_feature: redirect header
|
|
2253
|
+
:param bool async_: Perform the request asynchronously
|
|
2254
|
+
:return: FileZipInfo
|
|
2443
2255
|
"""
|
|
2444
2256
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2445
2257
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2463,27 +2275,17 @@ class SubjectsApi(object):
|
|
|
2463
2275
|
Does not work on files whose names contain a forward slash.
|
|
2464
2276
|
This method makes a synchronous HTTP request by default.
|
|
2465
2277
|
|
|
2466
|
-
:param subject_id: 24-character hex ID
|
|
2467
|
-
:
|
|
2468
|
-
:param
|
|
2469
|
-
:
|
|
2470
|
-
:param
|
|
2471
|
-
:
|
|
2472
|
-
:param
|
|
2473
|
-
:
|
|
2474
|
-
:param
|
|
2475
|
-
:
|
|
2476
|
-
:
|
|
2477
|
-
:type member: str, optional
|
|
2478
|
-
:param view: feature flag for view/download, defaults to false
|
|
2479
|
-
:type view: bool, optional
|
|
2480
|
-
:param range: byte ranges to return
|
|
2481
|
-
:type range: str, optional
|
|
2482
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2483
|
-
:type x_accept_feature: list[str], optional
|
|
2484
|
-
:param async_: Perform the request asynchronously
|
|
2485
|
-
:type async_: bool, optional
|
|
2486
|
-
:rtype: FileZipInfo
|
|
2278
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2279
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2280
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2281
|
+
:param str ticket: 24-char hex ticket id
|
|
2282
|
+
:param bool info: get file info only
|
|
2283
|
+
:param str member: get zipfile member
|
|
2284
|
+
:param bool view: feature flag for view/download
|
|
2285
|
+
:param str range: byte ranges to return
|
|
2286
|
+
:param list[str] x_accept_feature: redirect header
|
|
2287
|
+
:param bool async_: Perform the request asynchronously
|
|
2288
|
+
:return: FileZipInfo
|
|
2487
2289
|
"""
|
|
2488
2290
|
|
|
2489
2291
|
all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2578,27 +2380,17 @@ class SubjectsApi(object):
|
|
|
2578
2380
|
|
|
2579
2381
|
This method makes a synchronous HTTP request by default.
|
|
2580
2382
|
|
|
2581
|
-
:param subject_id: 24-character hex ID
|
|
2582
|
-
:
|
|
2583
|
-
:param
|
|
2584
|
-
:
|
|
2585
|
-
:param
|
|
2586
|
-
:
|
|
2587
|
-
:param
|
|
2588
|
-
:
|
|
2589
|
-
:param
|
|
2590
|
-
:
|
|
2591
|
-
:
|
|
2592
|
-
:type member: str, optional
|
|
2593
|
-
:param view: feature flag for view/download, defaults to false
|
|
2594
|
-
:type view: bool, optional
|
|
2595
|
-
:param range: byte ranges to return
|
|
2596
|
-
:type range: str, optional
|
|
2597
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2598
|
-
:type x_accept_feature: list[str], optional
|
|
2599
|
-
:param async_: Perform the request asynchronously
|
|
2600
|
-
:type async_: bool, optional
|
|
2601
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2383
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2384
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2385
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2386
|
+
:param str ticket: 24-char hex ticket id
|
|
2387
|
+
:param bool info: get file info only
|
|
2388
|
+
:param str member: get zipfile member
|
|
2389
|
+
:param bool view: feature flag for view/download
|
|
2390
|
+
:param str range: byte ranges to return
|
|
2391
|
+
:param list[str] x_accept_feature: redirect header
|
|
2392
|
+
:param bool async_: Perform the request asynchronously
|
|
2393
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2602
2394
|
"""
|
|
2603
2395
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2604
2396
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2621,27 +2413,17 @@ class SubjectsApi(object):
|
|
|
2621
2413
|
|
|
2622
2414
|
This method makes a synchronous HTTP request by default.
|
|
2623
2415
|
|
|
2624
|
-
:param subject_id: 24-character hex ID
|
|
2625
|
-
:
|
|
2626
|
-
:param
|
|
2627
|
-
:
|
|
2628
|
-
:param
|
|
2629
|
-
:
|
|
2630
|
-
:param
|
|
2631
|
-
:
|
|
2632
|
-
:param
|
|
2633
|
-
:
|
|
2634
|
-
:
|
|
2635
|
-
:type member: str, optional
|
|
2636
|
-
:param view: feature flag for view/download, defaults to false
|
|
2637
|
-
:type view: bool, optional
|
|
2638
|
-
:param range: byte ranges to return
|
|
2639
|
-
:type range: str, optional
|
|
2640
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2641
|
-
:type x_accept_feature: list[str], optional
|
|
2642
|
-
:param async_: Perform the request asynchronously
|
|
2643
|
-
:type async_: bool, optional
|
|
2644
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2416
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2417
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2418
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2419
|
+
:param str ticket: 24-char hex ticket id
|
|
2420
|
+
:param bool info: get file info only
|
|
2421
|
+
:param str member: get zipfile member
|
|
2422
|
+
:param bool view: feature flag for view/download
|
|
2423
|
+
:param str range: byte ranges to return
|
|
2424
|
+
:param list[str] x_accept_feature: redirect header
|
|
2425
|
+
:param bool async_: Perform the request asynchronously
|
|
2426
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2645
2427
|
"""
|
|
2646
2428
|
|
|
2647
2429
|
all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2735,27 +2517,17 @@ class SubjectsApi(object):
|
|
|
2735
2517
|
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.
|
|
2736
2518
|
This method makes a synchronous HTTP request by default.
|
|
2737
2519
|
|
|
2738
|
-
:param subject_id: 24-character hex ID
|
|
2739
|
-
:
|
|
2740
|
-
:param
|
|
2741
|
-
:
|
|
2742
|
-
:param
|
|
2743
|
-
:
|
|
2744
|
-
:param
|
|
2745
|
-
:
|
|
2746
|
-
:param
|
|
2747
|
-
:
|
|
2748
|
-
:
|
|
2749
|
-
:type view: bool, optional
|
|
2750
|
-
:param range: byte ranges to return
|
|
2751
|
-
:type range: str, optional
|
|
2752
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2753
|
-
:type x_accept_feature: list[str], optional
|
|
2754
|
-
:param dest_file: Destination file path
|
|
2755
|
-
:type dest_file: str
|
|
2756
|
-
:param async_: Perform the request asynchronously
|
|
2757
|
-
:type async_: bool, optional
|
|
2758
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2520
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2521
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2522
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2523
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2524
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2525
|
+
:param bool view: feature flag for view/download
|
|
2526
|
+
:param str range: byte ranges to return
|
|
2527
|
+
:param list[str] x_accept_feature: redirect header
|
|
2528
|
+
:param str dest_file: Destination file path
|
|
2529
|
+
:param bool async_: Perform the request asynchronously
|
|
2530
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2759
2531
|
"""
|
|
2760
2532
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2761
2533
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2778,25 +2550,16 @@ class SubjectsApi(object):
|
|
|
2778
2550
|
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.
|
|
2779
2551
|
This method makes a synchronous HTTP request by default.
|
|
2780
2552
|
|
|
2781
|
-
:param subject_id: 24-character hex ID
|
|
2782
|
-
:
|
|
2783
|
-
:param
|
|
2784
|
-
:
|
|
2785
|
-
:param
|
|
2786
|
-
:
|
|
2787
|
-
:param
|
|
2788
|
-
:
|
|
2789
|
-
:param
|
|
2790
|
-
:
|
|
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: union[DownloadTicketStub,ZipfileInfo]
|
|
2553
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2554
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2555
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2556
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2557
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2558
|
+
:param bool view: feature flag for view/download
|
|
2559
|
+
:param str range: byte ranges to return
|
|
2560
|
+
:param list[str] x_accept_feature: redirect header
|
|
2561
|
+
:param bool async_: Perform the request asynchronously
|
|
2562
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2800
2563
|
"""
|
|
2801
2564
|
|
|
2802
2565
|
all_params = ['subject_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -2888,27 +2651,17 @@ class SubjectsApi(object):
|
|
|
2888
2651
|
Does not work on files whose names contain a forward slash.
|
|
2889
2652
|
This method makes a synchronous HTTP request by default.
|
|
2890
2653
|
|
|
2891
|
-
:param subject_id: 24-character hex ID
|
|
2892
|
-
:
|
|
2893
|
-
:param
|
|
2894
|
-
:
|
|
2895
|
-
:param
|
|
2896
|
-
:
|
|
2897
|
-
:param
|
|
2898
|
-
:
|
|
2899
|
-
:param
|
|
2900
|
-
:
|
|
2901
|
-
:
|
|
2902
|
-
:type member: str, optional
|
|
2903
|
-
:param view: feature flag for view/download, defaults to false
|
|
2904
|
-
:type view: bool, optional
|
|
2905
|
-
:param range: byte ranges to return
|
|
2906
|
-
:type range: str, optional
|
|
2907
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2908
|
-
:type x_accept_feature: list[str], optional
|
|
2909
|
-
:param async_: Perform the request asynchronously
|
|
2910
|
-
:type async_: bool, optional
|
|
2911
|
-
:rtype: FileZipInfo
|
|
2654
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2655
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2656
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2657
|
+
:param str ticket: ticket id of the outputs to download
|
|
2658
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2659
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2660
|
+
:param bool view: feature flag for view/download
|
|
2661
|
+
:param str range: byte ranges to return
|
|
2662
|
+
:param list[str] x_accept_feature: redirect header
|
|
2663
|
+
:param bool async_: Perform the request asynchronously
|
|
2664
|
+
:return: FileZipInfo
|
|
2912
2665
|
"""
|
|
2913
2666
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2914
2667
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2932,27 +2685,17 @@ class SubjectsApi(object):
|
|
|
2932
2685
|
Does not work on files whose names contain a forward slash.
|
|
2933
2686
|
This method makes a synchronous HTTP request by default.
|
|
2934
2687
|
|
|
2935
|
-
:param subject_id: 24-character hex ID
|
|
2936
|
-
:
|
|
2937
|
-
:param
|
|
2938
|
-
:
|
|
2939
|
-
:param
|
|
2940
|
-
:
|
|
2941
|
-
:param
|
|
2942
|
-
:
|
|
2943
|
-
:param
|
|
2944
|
-
:
|
|
2945
|
-
:
|
|
2946
|
-
:type member: str, optional
|
|
2947
|
-
:param view: feature flag for view/download, defaults to false
|
|
2948
|
-
:type view: bool, optional
|
|
2949
|
-
:param range: byte ranges to return
|
|
2950
|
-
:type range: str, optional
|
|
2951
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
2952
|
-
:type x_accept_feature: list[str], optional
|
|
2953
|
-
:param async_: Perform the request asynchronously
|
|
2954
|
-
:type async_: bool, optional
|
|
2955
|
-
:rtype: FileZipInfo
|
|
2688
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2689
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2690
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2691
|
+
:param str ticket: ticket id of the outputs to download
|
|
2692
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2693
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2694
|
+
:param bool view: feature flag for view/download
|
|
2695
|
+
:param str range: byte ranges to return
|
|
2696
|
+
:param list[str] x_accept_feature: redirect header
|
|
2697
|
+
:param bool async_: Perform the request asynchronously
|
|
2698
|
+
:return: FileZipInfo
|
|
2956
2699
|
"""
|
|
2957
2700
|
|
|
2958
2701
|
all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -3047,27 +2790,17 @@ class SubjectsApi(object):
|
|
|
3047
2790
|
|
|
3048
2791
|
This method makes a synchronous HTTP request by default.
|
|
3049
2792
|
|
|
3050
|
-
:param subject_id: 24-character hex ID
|
|
3051
|
-
:
|
|
3052
|
-
:param
|
|
3053
|
-
:
|
|
3054
|
-
:param
|
|
3055
|
-
:
|
|
3056
|
-
:param
|
|
3057
|
-
:
|
|
3058
|
-
:param
|
|
3059
|
-
:
|
|
3060
|
-
:
|
|
3061
|
-
:type member: str, optional
|
|
3062
|
-
:param view: feature flag for view/download, defaults to false
|
|
3063
|
-
:type view: bool, optional
|
|
3064
|
-
:param range: byte ranges to return
|
|
3065
|
-
:type range: str, optional
|
|
3066
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
3067
|
-
:type x_accept_feature: list[str], optional
|
|
3068
|
-
:param async_: Perform the request asynchronously
|
|
3069
|
-
:type async_: bool, optional
|
|
3070
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2793
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2794
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2795
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2796
|
+
:param str ticket: ticket id of the outputs to download
|
|
2797
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2798
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2799
|
+
:param bool view: feature flag for view/download
|
|
2800
|
+
:param str range: byte ranges to return
|
|
2801
|
+
:param list[str] x_accept_feature: redirect header
|
|
2802
|
+
:param bool async_: Perform the request asynchronously
|
|
2803
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
3071
2804
|
"""
|
|
3072
2805
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3073
2806
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3090,27 +2823,17 @@ class SubjectsApi(object):
|
|
|
3090
2823
|
|
|
3091
2824
|
This method makes a synchronous HTTP request by default.
|
|
3092
2825
|
|
|
3093
|
-
:param subject_id: 24-character hex ID
|
|
3094
|
-
:
|
|
3095
|
-
:param
|
|
3096
|
-
:
|
|
3097
|
-
:param
|
|
3098
|
-
:
|
|
3099
|
-
:param
|
|
3100
|
-
:
|
|
3101
|
-
:param
|
|
3102
|
-
:
|
|
3103
|
-
:
|
|
3104
|
-
:type member: str, optional
|
|
3105
|
-
:param view: feature flag for view/download, defaults to false
|
|
3106
|
-
:type view: bool, optional
|
|
3107
|
-
:param range: byte ranges to return
|
|
3108
|
-
:type range: str, optional
|
|
3109
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
3110
|
-
:type x_accept_feature: list[str], optional
|
|
3111
|
-
:param async_: Perform the request asynchronously
|
|
3112
|
-
:type async_: bool, optional
|
|
3113
|
-
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
2826
|
+
:param str subject_id: 24-character hex ID (required)
|
|
2827
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2828
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2829
|
+
:param str ticket: ticket id of the outputs to download
|
|
2830
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2831
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2832
|
+
:param bool view: feature flag for view/download
|
|
2833
|
+
:param str range: byte ranges to return
|
|
2834
|
+
:param list[str] x_accept_feature: redirect header
|
|
2835
|
+
:param bool async_: Perform the request asynchronously
|
|
2836
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
3114
2837
|
"""
|
|
3115
2838
|
|
|
3116
2839
|
all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -3204,31 +2927,19 @@ class SubjectsApi(object):
|
|
|
3204
2927
|
Get a list of subjects
|
|
3205
2928
|
This method makes a synchronous HTTP request by default.
|
|
3206
2929
|
|
|
3207
|
-
:param exhaustive: Set to return a complete list regardless of permissions
|
|
3208
|
-
:
|
|
3209
|
-
:param
|
|
3210
|
-
:
|
|
3211
|
-
:param
|
|
3212
|
-
:
|
|
3213
|
-
:param
|
|
3214
|
-
:
|
|
3215
|
-
:param
|
|
3216
|
-
:
|
|
3217
|
-
:param
|
|
3218
|
-
:
|
|
3219
|
-
:
|
|
3220
|
-
:type limit: int, optional
|
|
3221
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
3222
|
-
:type skip: int, optional
|
|
3223
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
3224
|
-
:type page: int, optional
|
|
3225
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3226
|
-
:type after_id: str, optional
|
|
3227
|
-
:param x_accept_feature:, defaults to []
|
|
3228
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3229
|
-
:param async_: Perform the request asynchronously
|
|
3230
|
-
:type async_: bool, optional
|
|
3231
|
-
:rtype: union[Page,list[SubjectOutputForList]]
|
|
2930
|
+
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
2931
|
+
:param JoinType join: join file origins
|
|
2932
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2933
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2934
|
+
: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)
|
|
2935
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2936
|
+
:param int limit: The maximum number of entries to return.
|
|
2937
|
+
:param int skip: The number of entries to skip.
|
|
2938
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2939
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2940
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2941
|
+
:param bool async_: Perform the request asynchronously
|
|
2942
|
+
:return: union[Page,list[SubjectOutputForList]]
|
|
3232
2943
|
"""
|
|
3233
2944
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3234
2945
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3252,31 +2963,19 @@ class SubjectsApi(object):
|
|
|
3252
2963
|
Get a list of subjects
|
|
3253
2964
|
This method makes a synchronous HTTP request by default.
|
|
3254
2965
|
|
|
3255
|
-
:param exhaustive: Set to return a complete list regardless of permissions
|
|
3256
|
-
:
|
|
3257
|
-
:param
|
|
3258
|
-
:
|
|
3259
|
-
:param
|
|
3260
|
-
:
|
|
3261
|
-
:param
|
|
3262
|
-
:
|
|
3263
|
-
:param
|
|
3264
|
-
:
|
|
3265
|
-
:param
|
|
3266
|
-
:
|
|
3267
|
-
:
|
|
3268
|
-
:type limit: int, optional
|
|
3269
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
3270
|
-
:type skip: int, optional
|
|
3271
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
3272
|
-
:type page: int, optional
|
|
3273
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3274
|
-
:type after_id: str, optional
|
|
3275
|
-
:param x_accept_feature:, defaults to []
|
|
3276
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3277
|
-
:param async_: Perform the request asynchronously
|
|
3278
|
-
:type async_: bool, optional
|
|
3279
|
-
:rtype: union[Page,list[SubjectOutputForList]]
|
|
2966
|
+
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
2967
|
+
:param JoinType join: join file origins
|
|
2968
|
+
:param bool join_avatars: add name and avatar to notes
|
|
2969
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2970
|
+
: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)
|
|
2971
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2972
|
+
:param int limit: The maximum number of entries to return.
|
|
2973
|
+
:param int skip: The number of entries to skip.
|
|
2974
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2975
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2976
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
2977
|
+
:param bool async_: Perform the request asynchronously
|
|
2978
|
+
:return: union[Page,list[SubjectOutputForList]]
|
|
3280
2979
|
"""
|
|
3281
2980
|
|
|
3282
2981
|
all_params = ['exhaustive','join','join_avatars','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3362,17 +3061,12 @@ class SubjectsApi(object):
|
|
|
3362
3061
|
Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput
|
|
3363
3062
|
This method makes a synchronous HTTP request by default.
|
|
3364
3063
|
|
|
3365
|
-
:param subject_id: 24-char hex subject id
|
|
3366
|
-
:
|
|
3367
|
-
:param
|
|
3368
|
-
:
|
|
3369
|
-
:param
|
|
3370
|
-
:
|
|
3371
|
-
:param x_accept_feature:, defaults to []
|
|
3372
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3373
|
-
:param async_: Perform the request asynchronously
|
|
3374
|
-
:type async_: bool, optional
|
|
3375
|
-
:rtype: SubjectOutput
|
|
3064
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3065
|
+
:param JoinType join: join file origins
|
|
3066
|
+
:param bool join_avatars: add name and avatar to notes
|
|
3067
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3068
|
+
:param bool async_: Perform the request asynchronously
|
|
3069
|
+
:return: SubjectOutput
|
|
3376
3070
|
"""
|
|
3377
3071
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3378
3072
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3396,17 +3090,12 @@ class SubjectsApi(object):
|
|
|
3396
3090
|
Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput
|
|
3397
3091
|
This method makes a synchronous HTTP request by default.
|
|
3398
3092
|
|
|
3399
|
-
:param subject_id: 24-char hex subject id
|
|
3400
|
-
:
|
|
3401
|
-
:param
|
|
3402
|
-
:
|
|
3403
|
-
:param
|
|
3404
|
-
:
|
|
3405
|
-
:param x_accept_feature:, defaults to []
|
|
3406
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
3407
|
-
:param async_: Perform the request asynchronously
|
|
3408
|
-
:type async_: bool, optional
|
|
3409
|
-
:rtype: SubjectOutput
|
|
3093
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3094
|
+
:param JoinType join: join file origins
|
|
3095
|
+
:param bool join_avatars: add name and avatar to notes
|
|
3096
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3097
|
+
:param bool async_: Perform the request asynchronously
|
|
3098
|
+
:return: SubjectOutput
|
|
3410
3099
|
"""
|
|
3411
3100
|
|
|
3412
3101
|
all_params = ['subject_id','join','join_avatars','x_accept_feature',] # noqa: E501
|
|
@@ -3482,33 +3171,20 @@ class SubjectsApi(object):
|
|
|
3482
3171
|
Returns analyses that directly belong to this resource.
|
|
3483
3172
|
This method makes a synchronous HTTP request by default.
|
|
3484
3173
|
|
|
3485
|
-
:param cid:
|
|
3486
|
-
:
|
|
3487
|
-
:param
|
|
3488
|
-
:
|
|
3489
|
-
:param
|
|
3490
|
-
:
|
|
3491
|
-
:param
|
|
3492
|
-
:
|
|
3493
|
-
:param
|
|
3494
|
-
:
|
|
3495
|
-
:param
|
|
3496
|
-
:
|
|
3497
|
-
:param
|
|
3498
|
-
:
|
|
3499
|
-
:param limit: The maximum number of entries to return.
|
|
3500
|
-
:type limit: int, optional
|
|
3501
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
3502
|
-
:type skip: int, optional
|
|
3503
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
3504
|
-
:type page: int, optional
|
|
3505
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3506
|
-
:type after_id: str, optional
|
|
3507
|
-
:param x_accept_feature:, defaults to []
|
|
3508
|
-
:type x_accept_feature: list[str], optional
|
|
3509
|
-
:param async_: Perform the request asynchronously
|
|
3510
|
-
:type async_: bool, optional
|
|
3511
|
-
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3174
|
+
:param str cid: (required)
|
|
3175
|
+
:param bool inflate_job:
|
|
3176
|
+
:param bool join_avatars:
|
|
3177
|
+
:param JoinType join:
|
|
3178
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3179
|
+
: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)
|
|
3180
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3181
|
+
:param int limit: The maximum number of entries to return.
|
|
3182
|
+
:param int skip: The number of entries to skip.
|
|
3183
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3184
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3185
|
+
:param list[str] x_accept_feature:
|
|
3186
|
+
:param bool async_: Perform the request asynchronously
|
|
3187
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3512
3188
|
"""
|
|
3513
3189
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3514
3190
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3532,33 +3208,20 @@ class SubjectsApi(object):
|
|
|
3532
3208
|
Returns analyses that directly belong to this resource.
|
|
3533
3209
|
This method makes a synchronous HTTP request by default.
|
|
3534
3210
|
|
|
3535
|
-
:param cid:
|
|
3536
|
-
:
|
|
3537
|
-
:param
|
|
3538
|
-
:
|
|
3539
|
-
:param
|
|
3540
|
-
:
|
|
3541
|
-
:param
|
|
3542
|
-
:
|
|
3543
|
-
:param
|
|
3544
|
-
:
|
|
3545
|
-
:param
|
|
3546
|
-
:
|
|
3547
|
-
:param
|
|
3548
|
-
:
|
|
3549
|
-
:param limit: The maximum number of entries to return.
|
|
3550
|
-
:type limit: int, optional
|
|
3551
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
3552
|
-
:type skip: int, optional
|
|
3553
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
3554
|
-
:type page: int, optional
|
|
3555
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3556
|
-
:type after_id: str, optional
|
|
3557
|
-
:param x_accept_feature:, defaults to []
|
|
3558
|
-
:type x_accept_feature: list[str], optional
|
|
3559
|
-
:param async_: Perform the request asynchronously
|
|
3560
|
-
:type async_: bool, optional
|
|
3561
|
-
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3211
|
+
:param str cid: (required)
|
|
3212
|
+
:param bool inflate_job:
|
|
3213
|
+
:param bool join_avatars:
|
|
3214
|
+
:param JoinType join:
|
|
3215
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3216
|
+
: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)
|
|
3217
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3218
|
+
:param int limit: The maximum number of entries to return.
|
|
3219
|
+
:param int skip: The number of entries to skip.
|
|
3220
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3221
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3222
|
+
:param list[str] x_accept_feature:
|
|
3223
|
+
:param bool async_: Perform the request asynchronously
|
|
3224
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
3562
3225
|
"""
|
|
3563
3226
|
|
|
3564
3227
|
all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -3650,19 +3313,13 @@ class SubjectsApi(object):
|
|
|
3650
3313
|
Get an analysis.
|
|
3651
3314
|
This method makes a synchronous HTTP request by default.
|
|
3652
3315
|
|
|
3653
|
-
:param cid:
|
|
3654
|
-
:
|
|
3655
|
-
:param
|
|
3656
|
-
:
|
|
3657
|
-
:param
|
|
3658
|
-
:
|
|
3659
|
-
:
|
|
3660
|
-
:type join_avatars: bool, optional
|
|
3661
|
-
:param join:
|
|
3662
|
-
:type join: JoinType, optional
|
|
3663
|
-
:param async_: Perform the request asynchronously
|
|
3664
|
-
:type async_: bool, optional
|
|
3665
|
-
:rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3316
|
+
:param str cid: (required)
|
|
3317
|
+
:param str analysis_id: (required)
|
|
3318
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
3319
|
+
:param bool join_avatars:
|
|
3320
|
+
:param JoinType join:
|
|
3321
|
+
:param bool async_: Perform the request asynchronously
|
|
3322
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3666
3323
|
"""
|
|
3667
3324
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3668
3325
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3686,19 +3343,13 @@ class SubjectsApi(object):
|
|
|
3686
3343
|
Get an analysis.
|
|
3687
3344
|
This method makes a synchronous HTTP request by default.
|
|
3688
3345
|
|
|
3689
|
-
:param cid:
|
|
3690
|
-
:
|
|
3691
|
-
:param
|
|
3692
|
-
:
|
|
3693
|
-
:param
|
|
3694
|
-
:
|
|
3695
|
-
:
|
|
3696
|
-
:type join_avatars: bool, optional
|
|
3697
|
-
:param join:
|
|
3698
|
-
:type join: JoinType, optional
|
|
3699
|
-
:param async_: Perform the request asynchronously
|
|
3700
|
-
:type async_: bool, optional
|
|
3701
|
-
:rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3346
|
+
:param str cid: (required)
|
|
3347
|
+
:param str analysis_id: (required)
|
|
3348
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
3349
|
+
:param bool join_avatars:
|
|
3350
|
+
:param JoinType join:
|
|
3351
|
+
:param bool async_: Perform the request asynchronously
|
|
3352
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3702
3353
|
"""
|
|
3703
3354
|
|
|
3704
3355
|
all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
|
|
@@ -3779,13 +3430,10 @@ class SubjectsApi(object):
|
|
|
3779
3430
|
Get info for a particular file.
|
|
3780
3431
|
This method makes a synchronous HTTP request by default.
|
|
3781
3432
|
|
|
3782
|
-
:param cid: Container Id
|
|
3783
|
-
:
|
|
3784
|
-
:param
|
|
3785
|
-
:
|
|
3786
|
-
:param async_: Perform the request asynchronously
|
|
3787
|
-
:type async_: bool, optional
|
|
3788
|
-
:rtype: FileOutput
|
|
3433
|
+
:param str cid: Container Id (required)
|
|
3434
|
+
:param str filename: (required)
|
|
3435
|
+
:param bool async_: Perform the request asynchronously
|
|
3436
|
+
:return: FileOutput
|
|
3789
3437
|
"""
|
|
3790
3438
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3791
3439
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3809,13 +3457,10 @@ class SubjectsApi(object):
|
|
|
3809
3457
|
Get info for a particular file.
|
|
3810
3458
|
This method makes a synchronous HTTP request by default.
|
|
3811
3459
|
|
|
3812
|
-
:param cid: Container Id
|
|
3813
|
-
:
|
|
3814
|
-
:param
|
|
3815
|
-
:
|
|
3816
|
-
:param async_: Perform the request asynchronously
|
|
3817
|
-
:type async_: bool, optional
|
|
3818
|
-
:rtype: FileOutput
|
|
3460
|
+
:param str cid: Container Id (required)
|
|
3461
|
+
:param str filename: (required)
|
|
3462
|
+
:param bool async_: Perform the request asynchronously
|
|
3463
|
+
:return: FileOutput
|
|
3819
3464
|
"""
|
|
3820
3465
|
|
|
3821
3466
|
all_params = ['cid','filename',] # noqa: E501
|
|
@@ -3890,13 +3535,10 @@ class SubjectsApi(object):
|
|
|
3890
3535
|
Get a note of a(n) subject
|
|
3891
3536
|
This method makes a synchronous HTTP request by default.
|
|
3892
3537
|
|
|
3893
|
-
:param cid:
|
|
3894
|
-
:
|
|
3895
|
-
:param
|
|
3896
|
-
:
|
|
3897
|
-
:param async_: Perform the request asynchronously
|
|
3898
|
-
:type async_: bool, optional
|
|
3899
|
-
:rtype: Note
|
|
3538
|
+
:param str cid: (required)
|
|
3539
|
+
:param str note_id: (required)
|
|
3540
|
+
:param bool async_: Perform the request asynchronously
|
|
3541
|
+
:return: Note
|
|
3900
3542
|
"""
|
|
3901
3543
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3902
3544
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3920,13 +3562,10 @@ class SubjectsApi(object):
|
|
|
3920
3562
|
Get a note of a(n) subject
|
|
3921
3563
|
This method makes a synchronous HTTP request by default.
|
|
3922
3564
|
|
|
3923
|
-
:param cid:
|
|
3924
|
-
:
|
|
3925
|
-
:param
|
|
3926
|
-
:
|
|
3927
|
-
:param async_: Perform the request asynchronously
|
|
3928
|
-
:type async_: bool, optional
|
|
3929
|
-
:rtype: Note
|
|
3565
|
+
:param str cid: (required)
|
|
3566
|
+
:param str note_id: (required)
|
|
3567
|
+
:param bool async_: Perform the request asynchronously
|
|
3568
|
+
:return: Note
|
|
3930
3569
|
"""
|
|
3931
3570
|
|
|
3932
3571
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -4001,29 +3640,18 @@ class SubjectsApi(object):
|
|
|
4001
3640
|
List sessions of a subject
|
|
4002
3641
|
This method makes a synchronous HTTP request by default.
|
|
4003
3642
|
|
|
4004
|
-
:param subject_id: 24-char hex subject id
|
|
4005
|
-
:
|
|
4006
|
-
:param
|
|
4007
|
-
:
|
|
4008
|
-
:param
|
|
4009
|
-
:
|
|
4010
|
-
:param
|
|
4011
|
-
:
|
|
4012
|
-
:param
|
|
4013
|
-
:
|
|
4014
|
-
:param
|
|
4015
|
-
:
|
|
4016
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
4017
|
-
:type skip: int, optional
|
|
4018
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
4019
|
-
:type page: int, optional
|
|
4020
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
4021
|
-
:type after_id: str, optional
|
|
4022
|
-
:param x_accept_feature:, defaults to []
|
|
4023
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
4024
|
-
:param async_: Perform the request asynchronously
|
|
4025
|
-
:type async_: bool, optional
|
|
4026
|
-
:rtype: union[Page,list[SessionListOutput]]
|
|
3643
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3644
|
+
:param JoinType join: join file origins
|
|
3645
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3646
|
+
: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)
|
|
3647
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3648
|
+
:param int limit: The maximum number of entries to return.
|
|
3649
|
+
:param int skip: The number of entries to skip.
|
|
3650
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3651
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3652
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3653
|
+
:param bool async_: Perform the request asynchronously
|
|
3654
|
+
:return: union[Page,list[SessionListOutput]]
|
|
4027
3655
|
"""
|
|
4028
3656
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4029
3657
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4047,29 +3675,18 @@ class SubjectsApi(object):
|
|
|
4047
3675
|
List sessions of a subject
|
|
4048
3676
|
This method makes a synchronous HTTP request by default.
|
|
4049
3677
|
|
|
4050
|
-
:param subject_id: 24-char hex subject id
|
|
4051
|
-
:
|
|
4052
|
-
:param
|
|
4053
|
-
:
|
|
4054
|
-
:param
|
|
4055
|
-
:
|
|
4056
|
-
:param
|
|
4057
|
-
:
|
|
4058
|
-
:param
|
|
4059
|
-
:
|
|
4060
|
-
:param
|
|
4061
|
-
:
|
|
4062
|
-
:param skip: The number of entries to skip., defaults to 0
|
|
4063
|
-
:type skip: int, optional
|
|
4064
|
-
:param page: The page number (i.e. skip limit*page entries)
|
|
4065
|
-
:type page: int, optional
|
|
4066
|
-
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
4067
|
-
:type after_id: str, optional
|
|
4068
|
-
:param x_accept_feature:, defaults to []
|
|
4069
|
-
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
4070
|
-
:param async_: Perform the request asynchronously
|
|
4071
|
-
:type async_: bool, optional
|
|
4072
|
-
:rtype: union[Page,list[SessionListOutput]]
|
|
3678
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3679
|
+
:param JoinType join: join file origins
|
|
3680
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3681
|
+
: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)
|
|
3682
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3683
|
+
:param int limit: The maximum number of entries to return.
|
|
3684
|
+
:param int skip: The number of entries to skip.
|
|
3685
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3686
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3687
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3688
|
+
:param bool async_: Perform the request asynchronously
|
|
3689
|
+
:return: union[Page,list[SessionListOutput]]
|
|
4073
3690
|
"""
|
|
4074
3691
|
|
|
4075
3692
|
all_params = ['subject_id','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -4157,13 +3774,10 @@ class SubjectsApi(object):
|
|
|
4157
3774
|
Get the value of a tag, by name
|
|
4158
3775
|
This method makes a synchronous HTTP request by default.
|
|
4159
3776
|
|
|
4160
|
-
:param cid:
|
|
4161
|
-
:
|
|
4162
|
-
:param
|
|
4163
|
-
:
|
|
4164
|
-
:param async_: Perform the request asynchronously
|
|
4165
|
-
:type async_: bool, optional
|
|
4166
|
-
:rtype: str
|
|
3777
|
+
:param str cid: (required)
|
|
3778
|
+
:param str value: The tag to interact with (required)
|
|
3779
|
+
:param bool async_: Perform the request asynchronously
|
|
3780
|
+
:return: str
|
|
4167
3781
|
"""
|
|
4168
3782
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4169
3783
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4187,13 +3801,10 @@ class SubjectsApi(object):
|
|
|
4187
3801
|
Get the value of a tag, by name
|
|
4188
3802
|
This method makes a synchronous HTTP request by default.
|
|
4189
3803
|
|
|
4190
|
-
:param cid:
|
|
4191
|
-
:
|
|
4192
|
-
:param
|
|
4193
|
-
:
|
|
4194
|
-
:param async_: Perform the request asynchronously
|
|
4195
|
-
:type async_: bool, optional
|
|
4196
|
-
:rtype: str
|
|
3804
|
+
:param str cid: (required)
|
|
3805
|
+
:param str value: The tag to interact with (required)
|
|
3806
|
+
:param bool async_: Perform the request asynchronously
|
|
3807
|
+
:return: str
|
|
4197
3808
|
"""
|
|
4198
3809
|
|
|
4199
3810
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -4268,13 +3879,10 @@ class SubjectsApi(object):
|
|
|
4268
3879
|
Update a subject
|
|
4269
3880
|
This method makes a synchronous HTTP request by default.
|
|
4270
3881
|
|
|
4271
|
-
:param subject_id: 24-char hex subject id
|
|
4272
|
-
:
|
|
4273
|
-
:param
|
|
4274
|
-
:
|
|
4275
|
-
:param async_: Perform the request asynchronously
|
|
4276
|
-
:type async_: bool, optional
|
|
4277
|
-
:rtype: ModifiedResult
|
|
3882
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3883
|
+
:param SubjectModify body: (required)
|
|
3884
|
+
:param bool async_: Perform the request asynchronously
|
|
3885
|
+
:return: ModifiedResult
|
|
4278
3886
|
"""
|
|
4279
3887
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4280
3888
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4298,13 +3906,10 @@ class SubjectsApi(object):
|
|
|
4298
3906
|
Update a subject
|
|
4299
3907
|
This method makes a synchronous HTTP request by default.
|
|
4300
3908
|
|
|
4301
|
-
:param subject_id: 24-char hex subject id
|
|
4302
|
-
:
|
|
4303
|
-
:param
|
|
4304
|
-
:
|
|
4305
|
-
:param async_: Perform the request asynchronously
|
|
4306
|
-
:type async_: bool, optional
|
|
4307
|
-
:rtype: ModifiedResult
|
|
3909
|
+
:param str subject_id: 24-char hex subject id (required)
|
|
3910
|
+
:param SubjectModify body: (required)
|
|
3911
|
+
:param bool async_: Perform the request asynchronously
|
|
3912
|
+
:return: ModifiedResult
|
|
4308
3913
|
"""
|
|
4309
3914
|
|
|
4310
3915
|
all_params = ['subject_id','body',] # noqa: E501
|
|
@@ -4390,15 +3995,11 @@ class SubjectsApi(object):
|
|
|
4390
3995
|
Modify an analysis.
|
|
4391
3996
|
This method makes a synchronous HTTP request by default.
|
|
4392
3997
|
|
|
4393
|
-
:param cid:
|
|
4394
|
-
:
|
|
4395
|
-
:param
|
|
4396
|
-
:
|
|
4397
|
-
:
|
|
4398
|
-
:type body: AnalysisModifyInput
|
|
4399
|
-
:param async_: Perform the request asynchronously
|
|
4400
|
-
:type async_: bool, optional
|
|
4401
|
-
:rtype: ModifiedResult
|
|
3998
|
+
:param str cid: (required)
|
|
3999
|
+
:param str analysis_id: (required)
|
|
4000
|
+
:param AnalysisModifyInput body: (required)
|
|
4001
|
+
:param bool async_: Perform the request asynchronously
|
|
4002
|
+
:return: ModifiedResult
|
|
4402
4003
|
"""
|
|
4403
4004
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4404
4005
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4422,15 +4023,11 @@ class SubjectsApi(object):
|
|
|
4422
4023
|
Modify an analysis.
|
|
4423
4024
|
This method makes a synchronous HTTP request by default.
|
|
4424
4025
|
|
|
4425
|
-
:param cid:
|
|
4426
|
-
:
|
|
4427
|
-
:param
|
|
4428
|
-
:
|
|
4429
|
-
:
|
|
4430
|
-
:type body: AnalysisModifyInput
|
|
4431
|
-
:param async_: Perform the request asynchronously
|
|
4432
|
-
:type async_: bool, optional
|
|
4433
|
-
:rtype: ModifiedResult
|
|
4026
|
+
:param str cid: (required)
|
|
4027
|
+
:param str analysis_id: (required)
|
|
4028
|
+
:param AnalysisModifyInput body: (required)
|
|
4029
|
+
:param bool async_: Perform the request asynchronously
|
|
4030
|
+
:return: ModifiedResult
|
|
4434
4031
|
"""
|
|
4435
4032
|
|
|
4436
4033
|
all_params = ['cid','analysis_id','body',] # noqa: E501
|
|
@@ -4522,15 +4119,11 @@ class SubjectsApi(object):
|
|
|
4522
4119
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4523
4120
|
This method makes a synchronous HTTP request by default.
|
|
4524
4121
|
|
|
4525
|
-
:param cid:
|
|
4526
|
-
:
|
|
4527
|
-
:param
|
|
4528
|
-
:
|
|
4529
|
-
:
|
|
4530
|
-
:type body: FileModifyInput
|
|
4531
|
-
:param async_: Perform the request asynchronously
|
|
4532
|
-
:type async_: bool, optional
|
|
4533
|
-
:rtype: ModifiedResult
|
|
4122
|
+
:param str cid: (required)
|
|
4123
|
+
:param str filename: (required)
|
|
4124
|
+
:param FileModifyInput body: (required)
|
|
4125
|
+
:param bool async_: Perform the request asynchronously
|
|
4126
|
+
:return: ModifiedResult
|
|
4534
4127
|
"""
|
|
4535
4128
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4536
4129
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4554,15 +4147,11 @@ class SubjectsApi(object):
|
|
|
4554
4147
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
4555
4148
|
This method makes a synchronous HTTP request by default.
|
|
4556
4149
|
|
|
4557
|
-
:param cid:
|
|
4558
|
-
:
|
|
4559
|
-
:param
|
|
4560
|
-
:
|
|
4561
|
-
:
|
|
4562
|
-
:type body: FileModifyInput
|
|
4563
|
-
:param async_: Perform the request asynchronously
|
|
4564
|
-
:type async_: bool, optional
|
|
4565
|
-
:rtype: ModifiedResult
|
|
4150
|
+
:param str cid: (required)
|
|
4151
|
+
:param str filename: (required)
|
|
4152
|
+
:param FileModifyInput body: (required)
|
|
4153
|
+
:param bool async_: Perform the request asynchronously
|
|
4154
|
+
:return: ModifiedResult
|
|
4566
4155
|
"""
|
|
4567
4156
|
|
|
4568
4157
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4654,15 +4243,11 @@ class SubjectsApi(object):
|
|
|
4654
4243
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4655
4244
|
This method makes a synchronous HTTP request by default.
|
|
4656
4245
|
|
|
4657
|
-
:param cid:
|
|
4658
|
-
:
|
|
4659
|
-
:param
|
|
4660
|
-
:
|
|
4661
|
-
:
|
|
4662
|
-
:type body: FileClassificationDelta
|
|
4663
|
-
:param async_: Perform the request asynchronously
|
|
4664
|
-
:type async_: bool, optional
|
|
4665
|
-
:rtype: ModifiedResult
|
|
4246
|
+
:param str cid: (required)
|
|
4247
|
+
:param str filename: (required)
|
|
4248
|
+
:param FileClassificationDelta body: (required)
|
|
4249
|
+
:param bool async_: Perform the request asynchronously
|
|
4250
|
+
:return: ModifiedResult
|
|
4666
4251
|
"""
|
|
4667
4252
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4668
4253
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4686,15 +4271,11 @@ class SubjectsApi(object):
|
|
|
4686
4271
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
4687
4272
|
This method makes a synchronous HTTP request by default.
|
|
4688
4273
|
|
|
4689
|
-
:param cid:
|
|
4690
|
-
:
|
|
4691
|
-
:param
|
|
4692
|
-
:
|
|
4693
|
-
:
|
|
4694
|
-
:type body: FileClassificationDelta
|
|
4695
|
-
:param async_: Perform the request asynchronously
|
|
4696
|
-
:type async_: bool, optional
|
|
4697
|
-
:rtype: ModifiedResult
|
|
4274
|
+
:param str cid: (required)
|
|
4275
|
+
:param str filename: (required)
|
|
4276
|
+
:param FileClassificationDelta body: (required)
|
|
4277
|
+
:param bool async_: Perform the request asynchronously
|
|
4278
|
+
:return: ModifiedResult
|
|
4698
4279
|
"""
|
|
4699
4280
|
|
|
4700
4281
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4786,15 +4367,11 @@ class SubjectsApi(object):
|
|
|
4786
4367
|
Modify and return the file 'info' field
|
|
4787
4368
|
This method makes a synchronous HTTP request by default.
|
|
4788
4369
|
|
|
4789
|
-
:param cid:
|
|
4790
|
-
:
|
|
4791
|
-
:param
|
|
4792
|
-
:
|
|
4793
|
-
:
|
|
4794
|
-
:type body: Info
|
|
4795
|
-
:param async_: Perform the request asynchronously
|
|
4796
|
-
:type async_: bool, optional
|
|
4797
|
-
:rtype: ModifiedResult
|
|
4370
|
+
:param str cid: (required)
|
|
4371
|
+
:param str filename: (required)
|
|
4372
|
+
:param Info body: (required)
|
|
4373
|
+
:param bool async_: Perform the request asynchronously
|
|
4374
|
+
:return: ModifiedResult
|
|
4798
4375
|
"""
|
|
4799
4376
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4800
4377
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4818,15 +4395,11 @@ class SubjectsApi(object):
|
|
|
4818
4395
|
Modify and return the file 'info' field
|
|
4819
4396
|
This method makes a synchronous HTTP request by default.
|
|
4820
4397
|
|
|
4821
|
-
:param cid:
|
|
4822
|
-
:
|
|
4823
|
-
:param
|
|
4824
|
-
:
|
|
4825
|
-
:
|
|
4826
|
-
:type body: Info
|
|
4827
|
-
:param async_: Perform the request asynchronously
|
|
4828
|
-
:type async_: bool, optional
|
|
4829
|
-
:rtype: ModifiedResult
|
|
4398
|
+
:param str cid: (required)
|
|
4399
|
+
:param str filename: (required)
|
|
4400
|
+
:param Info body: (required)
|
|
4401
|
+
:param bool async_: Perform the request asynchronously
|
|
4402
|
+
:return: ModifiedResult
|
|
4830
4403
|
"""
|
|
4831
4404
|
|
|
4832
4405
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -4918,13 +4491,10 @@ class SubjectsApi(object):
|
|
|
4918
4491
|
Update or replace info for a(n) subject. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4919
4492
|
This method makes a synchronous HTTP request by default.
|
|
4920
4493
|
|
|
4921
|
-
:param cid:
|
|
4922
|
-
:
|
|
4923
|
-
:param
|
|
4924
|
-
:
|
|
4925
|
-
:param async_: Perform the request asynchronously
|
|
4926
|
-
:type async_: bool, optional
|
|
4927
|
-
:rtype: ModifiedResult
|
|
4494
|
+
:param str cid: (required)
|
|
4495
|
+
:param Info body: (required)
|
|
4496
|
+
:param bool async_: Perform the request asynchronously
|
|
4497
|
+
:return: ModifiedResult
|
|
4928
4498
|
"""
|
|
4929
4499
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4930
4500
|
kwargs['_return_http_data_only'] = True
|
|
@@ -4948,13 +4518,10 @@ class SubjectsApi(object):
|
|
|
4948
4518
|
Update or replace info for a(n) subject. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4949
4519
|
This method makes a synchronous HTTP request by default.
|
|
4950
4520
|
|
|
4951
|
-
:param cid:
|
|
4952
|
-
:
|
|
4953
|
-
:param
|
|
4954
|
-
:
|
|
4955
|
-
:param async_: Perform the request asynchronously
|
|
4956
|
-
:type async_: bool, optional
|
|
4957
|
-
:rtype: ModifiedResult
|
|
4521
|
+
:param str cid: (required)
|
|
4522
|
+
:param Info body: (required)
|
|
4523
|
+
:param bool async_: Perform the request asynchronously
|
|
4524
|
+
:return: ModifiedResult
|
|
4958
4525
|
"""
|
|
4959
4526
|
|
|
4960
4527
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -5040,15 +4607,11 @@ class SubjectsApi(object):
|
|
|
5040
4607
|
Update a note of a(n) subject
|
|
5041
4608
|
This method makes a synchronous HTTP request by default.
|
|
5042
4609
|
|
|
5043
|
-
:param cid:
|
|
5044
|
-
:
|
|
5045
|
-
:param
|
|
5046
|
-
:
|
|
5047
|
-
:
|
|
5048
|
-
:type body: NoteInput
|
|
5049
|
-
:param async_: Perform the request asynchronously
|
|
5050
|
-
:type async_: bool, optional
|
|
5051
|
-
:rtype: int
|
|
4610
|
+
:param str cid: (required)
|
|
4611
|
+
:param str note_id: (required)
|
|
4612
|
+
:param NoteInput body: (required)
|
|
4613
|
+
:param bool async_: Perform the request asynchronously
|
|
4614
|
+
:return: int
|
|
5052
4615
|
"""
|
|
5053
4616
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5054
4617
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5072,15 +4635,11 @@ class SubjectsApi(object):
|
|
|
5072
4635
|
Update a note of a(n) subject
|
|
5073
4636
|
This method makes a synchronous HTTP request by default.
|
|
5074
4637
|
|
|
5075
|
-
:param cid:
|
|
5076
|
-
:
|
|
5077
|
-
:param
|
|
5078
|
-
:
|
|
5079
|
-
:
|
|
5080
|
-
:type body: NoteInput
|
|
5081
|
-
:param async_: Perform the request asynchronously
|
|
5082
|
-
:type async_: bool, optional
|
|
5083
|
-
:rtype: int
|
|
4638
|
+
:param str cid: (required)
|
|
4639
|
+
:param str note_id: (required)
|
|
4640
|
+
:param NoteInput body: (required)
|
|
4641
|
+
:param bool async_: Perform the request asynchronously
|
|
4642
|
+
:return: int
|
|
5084
4643
|
"""
|
|
5085
4644
|
|
|
5086
4645
|
all_params = ['cid','note_id','body',] # noqa: E501
|
|
@@ -5172,15 +4731,11 @@ class SubjectsApi(object):
|
|
|
5172
4731
|
Rename a tag
|
|
5173
4732
|
This method makes a synchronous HTTP request by default.
|
|
5174
4733
|
|
|
5175
|
-
:param cid:
|
|
5176
|
-
:
|
|
5177
|
-
:param
|
|
5178
|
-
:
|
|
5179
|
-
:
|
|
5180
|
-
:type body: Tag
|
|
5181
|
-
:param async_: Perform the request asynchronously
|
|
5182
|
-
:type async_: bool, optional
|
|
5183
|
-
:rtype: str
|
|
4734
|
+
:param str cid: (required)
|
|
4735
|
+
:param str value: The tag to interact with (required)
|
|
4736
|
+
:param Tag body: (required)
|
|
4737
|
+
:param bool async_: Perform the request asynchronously
|
|
4738
|
+
:return: str
|
|
5184
4739
|
"""
|
|
5185
4740
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5186
4741
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5204,15 +4759,11 @@ class SubjectsApi(object):
|
|
|
5204
4759
|
Rename a tag
|
|
5205
4760
|
This method makes a synchronous HTTP request by default.
|
|
5206
4761
|
|
|
5207
|
-
:param cid:
|
|
5208
|
-
:
|
|
5209
|
-
:param
|
|
5210
|
-
:
|
|
5211
|
-
:
|
|
5212
|
-
:type body: Tag
|
|
5213
|
-
:param async_: Perform the request asynchronously
|
|
5214
|
-
:type async_: bool, optional
|
|
5215
|
-
:rtype: str
|
|
4762
|
+
:param str cid: (required)
|
|
4763
|
+
:param str value: The tag to interact with (required)
|
|
4764
|
+
:param Tag body: (required)
|
|
4765
|
+
:param bool async_: Perform the request asynchronously
|
|
4766
|
+
:return: str
|
|
5216
4767
|
"""
|
|
5217
4768
|
|
|
5218
4769
|
all_params = ['cid','value','body',] # noqa: E501
|
|
@@ -5304,13 +4855,10 @@ class SubjectsApi(object):
|
|
|
5304
4855
|
Smart copy a subject
|
|
5305
4856
|
This method makes a synchronous HTTP request by default.
|
|
5306
4857
|
|
|
5307
|
-
:param subject_id:
|
|
5308
|
-
:
|
|
5309
|
-
:param
|
|
5310
|
-
:
|
|
5311
|
-
:param async_: Perform the request asynchronously
|
|
5312
|
-
:type async_: bool, optional
|
|
5313
|
-
:rtype: Subject
|
|
4858
|
+
:param str subject_id: (required)
|
|
4859
|
+
:param SubjectCopyInput body: (required)
|
|
4860
|
+
:param bool async_: Perform the request asynchronously
|
|
4861
|
+
:return: Subject
|
|
5314
4862
|
"""
|
|
5315
4863
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5316
4864
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5334,13 +4882,10 @@ class SubjectsApi(object):
|
|
|
5334
4882
|
Smart copy a subject
|
|
5335
4883
|
This method makes a synchronous HTTP request by default.
|
|
5336
4884
|
|
|
5337
|
-
:param subject_id:
|
|
5338
|
-
:
|
|
5339
|
-
:param
|
|
5340
|
-
:
|
|
5341
|
-
:param async_: Perform the request asynchronously
|
|
5342
|
-
:type async_: bool, optional
|
|
5343
|
-
:rtype: Subject
|
|
4885
|
+
:param str subject_id: (required)
|
|
4886
|
+
:param SubjectCopyInput body: (required)
|
|
4887
|
+
:param bool async_: Perform the request asynchronously
|
|
4888
|
+
:return: Subject
|
|
5344
4889
|
"""
|
|
5345
4890
|
|
|
5346
4891
|
all_params = ['subject_id','body',] # noqa: E501
|
|
@@ -5426,29 +4971,18 @@ class SubjectsApi(object):
|
|
|
5426
4971
|
Upload a file to a(n) subject.
|
|
5427
4972
|
This method makes a synchronous HTTP request by default.
|
|
5428
4973
|
|
|
5429
|
-
:param container_id:
|
|
5430
|
-
:
|
|
5431
|
-
:param
|
|
5432
|
-
:
|
|
5433
|
-
:param
|
|
5434
|
-
:
|
|
5435
|
-
:param
|
|
5436
|
-
:
|
|
5437
|
-
:param
|
|
5438
|
-
:
|
|
5439
|
-
:param
|
|
5440
|
-
:
|
|
5441
|
-
:param job:
|
|
5442
|
-
:type job: str, optional
|
|
5443
|
-
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5444
|
-
:type metadata: object, optional
|
|
5445
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
5446
|
-
:type x_accept_feature: list[str], optional
|
|
5447
|
-
:param content_type:
|
|
5448
|
-
:type content_type: str, optional
|
|
5449
|
-
:param async_: Perform the request asynchronously
|
|
5450
|
-
:type async_: bool, optional
|
|
5451
|
-
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
4974
|
+
:param str container_id: (required)
|
|
4975
|
+
:param str file: The file to upload (required)
|
|
4976
|
+
:param bool preserve_metadata:
|
|
4977
|
+
:param str ticket:
|
|
4978
|
+
:param str id:
|
|
4979
|
+
:param ContainerType level:
|
|
4980
|
+
:param str job:
|
|
4981
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4982
|
+
:param list[str] x_accept_feature: redirect header
|
|
4983
|
+
:param str content_type:
|
|
4984
|
+
:param bool async_: Perform the request asynchronously
|
|
4985
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
5452
4986
|
"""
|
|
5453
4987
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5454
4988
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5472,29 +5006,18 @@ class SubjectsApi(object):
|
|
|
5472
5006
|
Upload a file to a(n) subject.
|
|
5473
5007
|
This method makes a synchronous HTTP request by default.
|
|
5474
5008
|
|
|
5475
|
-
:param container_id:
|
|
5476
|
-
:
|
|
5477
|
-
:param
|
|
5478
|
-
:
|
|
5479
|
-
:param
|
|
5480
|
-
:
|
|
5481
|
-
:param
|
|
5482
|
-
:
|
|
5483
|
-
:param
|
|
5484
|
-
:
|
|
5485
|
-
:param
|
|
5486
|
-
:
|
|
5487
|
-
:param job:
|
|
5488
|
-
:type job: str, optional
|
|
5489
|
-
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5490
|
-
:type metadata: object, optional
|
|
5491
|
-
:param x_accept_feature: redirect header, defaults to []
|
|
5492
|
-
:type x_accept_feature: list[str], optional
|
|
5493
|
-
:param content_type:
|
|
5494
|
-
:type content_type: str, optional
|
|
5495
|
-
:param async_: Perform the request asynchronously
|
|
5496
|
-
:type async_: bool, optional
|
|
5497
|
-
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
5009
|
+
:param str container_id: (required)
|
|
5010
|
+
:param str file: The file to upload (required)
|
|
5011
|
+
:param bool preserve_metadata:
|
|
5012
|
+
:param str ticket:
|
|
5013
|
+
:param str id:
|
|
5014
|
+
:param ContainerType level:
|
|
5015
|
+
:param str job:
|
|
5016
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
5017
|
+
:param list[str] x_accept_feature: redirect header
|
|
5018
|
+
:param str content_type:
|
|
5019
|
+
:param bool async_: Perform the request asynchronously
|
|
5020
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
5498
5021
|
"""
|
|
5499
5022
|
|
|
5500
5023
|
all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|
|
@@ -5590,25 +5113,16 @@ class SubjectsApi(object):
|
|
|
5590
5113
|
Upload an output file to an analysis
|
|
5591
5114
|
This method makes a synchronous HTTP request by default.
|
|
5592
5115
|
|
|
5593
|
-
:param cid:
|
|
5594
|
-
:
|
|
5595
|
-
:param
|
|
5596
|
-
:
|
|
5597
|
-
:param
|
|
5598
|
-
:
|
|
5599
|
-
:param
|
|
5600
|
-
:
|
|
5601
|
-
:param
|
|
5602
|
-
:
|
|
5603
|
-
:param level:
|
|
5604
|
-
:type level: ContainerType, optional
|
|
5605
|
-
:param job:
|
|
5606
|
-
:type job: str, optional
|
|
5607
|
-
:param content_type:
|
|
5608
|
-
:type content_type: str, optional
|
|
5609
|
-
:param async_: Perform the request asynchronously
|
|
5610
|
-
:type async_: bool, optional
|
|
5611
|
-
:rtype: list[FileOutput]
|
|
5116
|
+
:param str cid: (required)
|
|
5117
|
+
:param str analysis_id: (required)
|
|
5118
|
+
:param str file: The file to upload (required)
|
|
5119
|
+
:param str ticket:
|
|
5120
|
+
:param str id:
|
|
5121
|
+
:param ContainerType level:
|
|
5122
|
+
:param str job:
|
|
5123
|
+
:param str content_type:
|
|
5124
|
+
:param bool async_: Perform the request asynchronously
|
|
5125
|
+
:return: list[FileOutput]
|
|
5612
5126
|
"""
|
|
5613
5127
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5614
5128
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5632,25 +5146,16 @@ class SubjectsApi(object):
|
|
|
5632
5146
|
Upload an output file to an analysis
|
|
5633
5147
|
This method makes a synchronous HTTP request by default.
|
|
5634
5148
|
|
|
5635
|
-
:param cid:
|
|
5636
|
-
:
|
|
5637
|
-
:param
|
|
5638
|
-
:
|
|
5639
|
-
:param
|
|
5640
|
-
:
|
|
5641
|
-
:param
|
|
5642
|
-
:
|
|
5643
|
-
:param
|
|
5644
|
-
:
|
|
5645
|
-
:param level:
|
|
5646
|
-
:type level: ContainerType, optional
|
|
5647
|
-
:param job:
|
|
5648
|
-
:type job: str, optional
|
|
5649
|
-
:param content_type:
|
|
5650
|
-
:type content_type: str, optional
|
|
5651
|
-
:param async_: Perform the request asynchronously
|
|
5652
|
-
:type async_: bool, optional
|
|
5653
|
-
:rtype: list[FileOutput]
|
|
5149
|
+
:param str cid: (required)
|
|
5150
|
+
:param str analysis_id: (required)
|
|
5151
|
+
:param str file: The file to upload (required)
|
|
5152
|
+
:param str ticket:
|
|
5153
|
+
:param str id:
|
|
5154
|
+
:param ContainerType level:
|
|
5155
|
+
:param str job:
|
|
5156
|
+
:param str content_type:
|
|
5157
|
+
:param bool async_: Perform the request asynchronously
|
|
5158
|
+
:return: list[FileOutput]
|
|
5654
5159
|
"""
|
|
5655
5160
|
|
|
5656
5161
|
all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
|
|
@@ -5745,11 +5250,9 @@ class SubjectsApi(object):
|
|
|
5745
5250
|
Verify that the given master subject code exists or not
|
|
5746
5251
|
This method makes a synchronous HTTP request by default.
|
|
5747
5252
|
|
|
5748
|
-
:param code: code id
|
|
5749
|
-
:
|
|
5750
|
-
:
|
|
5751
|
-
:type async_: bool, optional
|
|
5752
|
-
:rtype: MasterSubjectCodeOutput
|
|
5253
|
+
:param str code: code id (required)
|
|
5254
|
+
:param bool async_: Perform the request asynchronously
|
|
5255
|
+
:return: MasterSubjectCodeOutput
|
|
5753
5256
|
"""
|
|
5754
5257
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
5755
5258
|
kwargs['_return_http_data_only'] = True
|
|
@@ -5773,11 +5276,9 @@ class SubjectsApi(object):
|
|
|
5773
5276
|
Verify that the given master subject code exists or not
|
|
5774
5277
|
This method makes a synchronous HTTP request by default.
|
|
5775
5278
|
|
|
5776
|
-
:param code: code id
|
|
5777
|
-
:
|
|
5778
|
-
:
|
|
5779
|
-
:type async_: bool, optional
|
|
5780
|
-
:rtype: MasterSubjectCodeOutput
|
|
5279
|
+
:param str code: code id (required)
|
|
5280
|
+
:param bool async_: Perform the request asynchronously
|
|
5281
|
+
:return: MasterSubjectCodeOutput
|
|
5781
5282
|
"""
|
|
5782
5283
|
|
|
5783
5284
|
all_params = ['code',] # noqa: E501
|