flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flywheel/__init__.py +6 -8
- flywheel/api/acquisitions_api.py +1033 -569
- flywheel/api/analyses_api.py +786 -432
- flywheel/api/audit_trail_api.py +78 -51
- flywheel/api/auth_api.py +6 -11
- flywheel/api/batch_api.py +60 -43
- flywheel/api/bulk_api.py +10 -13
- flywheel/api/change_log_api.py +40 -29
- flywheel/api/collections_api.py +740 -410
- flywheel/api/config_api.py +18 -19
- flywheel/api/container_tasks_api.py +14 -15
- flywheel/api/container_type_api.py +14 -15
- flywheel/api/containers_api.py +989 -545
- flywheel/api/custom_filters_api.py +64 -43
- flywheel/api/data_view_executions_api.py +94 -59
- flywheel/api/dataexplorer_api.py +158 -99
- flywheel/api/devices_api.py +132 -83
- flywheel/api/dimse_api.py +72 -51
- flywheel/api/download_api.py +46 -32
- flywheel/api/files_api.py +266 -157
- flywheel/api/form_responses_api.py +100 -63
- flywheel/api/gears_api.py +278 -163
- flywheel/api/groups_api.py +426 -245
- flywheel/api/jobs_api.py +288 -173
- flywheel/api/jupyterlab_servers_api.py +24 -21
- flywheel/api/modalities_api.py +78 -51
- flywheel/api/packfiles_api.py +6 -11
- flywheel/api/projects_api.py +1661 -856
- flywheel/api/protocols_api.py +94 -61
- flywheel/api/reports_api.py +196 -115
- flywheel/api/resolve_api.py +48 -33
- flywheel/api/roles_api.py +82 -53
- flywheel/api/sessions_api.py +1137 -623
- flywheel/api/site_api.py +182 -113
- flywheel/api/staffing_pools_api.py +88 -57
- flywheel/api/subjects_api.py +1095 -603
- flywheel/api/tasks_api.py +108 -69
- flywheel/api/tree_api.py +52 -35
- flywheel/api/uids_api.py +10 -13
- flywheel/api/upload_api.py +162 -95
- flywheel/api/users_api.py +418 -235
- flywheel/api/views_api.py +222 -127
- flywheel/api_client.py +19 -18
- flywheel/configuration.py +2 -9
- flywheel/file_spec.py +0 -7
- flywheel/flywheel.py +818 -4423
- flywheel/gear_context.py +10 -10
- flywheel/models/__init__.py +6 -8
- flywheel/models/access_level.py +0 -7
- flywheel/models/access_permission.py +13 -14
- flywheel/models/access_permission_output.py +13 -14
- flywheel/models/access_permission_update.py +8 -11
- flywheel/models/access_type.py +0 -7
- flywheel/models/accumulator.py +0 -7
- flywheel/models/acquisition.py +0 -7
- flywheel/models/acquisition_container_output.py +0 -7
- flywheel/models/acquisition_copy_input.py +18 -17
- flywheel/models/acquisition_input.py +33 -26
- flywheel/models/acquisition_list_output.py +118 -77
- flywheel/models/acquisition_modify_input.py +33 -26
- flywheel/models/acquisition_node.py +0 -7
- flywheel/models/acquisition_output.py +118 -77
- flywheel/models/acquisition_parents.py +23 -20
- flywheel/models/acquisition_template_options.py +28 -23
- flywheel/models/acquisition_upsert_input.py +48 -35
- flywheel/models/acquisition_upsert_output.py +23 -20
- flywheel/models/action.py +1 -7
- flywheel/models/adhoc_analysis_input.py +23 -20
- flywheel/models/analysis.py +0 -7
- flywheel/models/analysis_container_output.py +0 -7
- flywheel/models/analysis_files_create_ticket_output.py +23 -20
- flywheel/models/analysis_input.py +33 -26
- flywheel/models/analysis_input_legacy.py +0 -7
- flywheel/models/analysis_list_output.py +103 -68
- flywheel/models/analysis_list_output_inflated_job.py +98 -65
- flywheel/models/analysis_modify_input.py +13 -14
- flywheel/models/analysis_node.py +0 -7
- flywheel/models/analysis_output.py +103 -68
- flywheel/models/analysis_output_inflated_job.py +103 -68
- flywheel/models/analysis_parents.py +28 -23
- flywheel/models/analysis_update.py +0 -7
- flywheel/models/api_key_input_with_optional_label.py +13 -14
- flywheel/models/api_key_output.py +33 -26
- flywheel/models/as_storage.py +33 -26
- flywheel/models/assignee.py +13 -14
- flywheel/models/assignee_type.py +0 -7
- flywheel/models/audit_trail_report.py +68 -47
- flywheel/models/audit_trail_report_status.py +0 -7
- flywheel/models/auth0_auth_out.py +38 -29
- flywheel/models/auth0_options_out.py +38 -29
- flywheel/models/auth_out.py +34 -82
- flywheel/models/auth_session_output.py +28 -23
- flywheel/models/avatars.py +18 -17
- flywheel/models/aws_creds.py +13 -14
- flywheel/models/aws_storage.py +43 -32
- flywheel/models/azure_creds.py +13 -14
- flywheel/models/base_aet.py +23 -20
- flywheel/models/base_compute.py +58 -41
- flywheel/models/batch.py +43 -32
- flywheel/models/batch_cancel_output.py +0 -7
- flywheel/models/batch_create_filters.py +18 -17
- flywheel/models/batch_job_analysis_input.py +28 -23
- flywheel/models/batch_jobs_proposal_input.py +0 -7
- flywheel/models/batch_proposal.py +0 -7
- flywheel/models/batch_proposal_detail.py +0 -7
- flywheel/models/batch_proposal_input.py +0 -7
- flywheel/models/body.py +0 -7
- flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
- flywheel/models/body_region.py +0 -7
- flywheel/models/bookmark.py +13 -14
- flywheel/models/bulk_move_input.py +28 -23
- flywheel/models/bulk_move_sessions.py +0 -7
- flywheel/models/callbacks_virus_scan_input.py +0 -7
- flywheel/models/cancelled_batch_output.py +8 -11
- flywheel/models/catalog_list_output.py +53 -38
- flywheel/models/central_out.py +33 -26
- flywheel/models/change.py +80 -39
- flywheel/models/change_log_container_type.py +0 -7
- flywheel/models/change_log_document.py +23 -20
- flywheel/models/change_method.py +1 -7
- flywheel/models/classic_batch_job_output.py +43 -32
- flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
- flywheel/models/classic_batch_proposal_input.py +48 -35
- flywheel/models/classic_batch_proposal_output.py +63 -44
- flywheel/models/classification_add_delete.py +0 -7
- flywheel/models/classification_replace.py +0 -7
- flywheel/models/classification_update_input.py +0 -7
- flywheel/models/cohort.py +0 -7
- flywheel/models/collection.py +0 -7
- flywheel/models/collection_container_output.py +0 -7
- flywheel/models/collection_input.py +18 -17
- flywheel/models/collection_input_with_contents.py +23 -20
- flywheel/models/collection_node.py +13 -14
- flywheel/models/collection_node_level.py +0 -7
- flywheel/models/collection_operation.py +13 -14
- flywheel/models/collection_operation_type.py +0 -7
- flywheel/models/collection_output.py +93 -62
- flywheel/models/collection_with_stats.py +93 -62
- flywheel/models/column.py +28 -23
- flywheel/models/column_type.py +0 -7
- flywheel/models/common_classification.py +3 -8
- flywheel/models/common_deleted_count.py +0 -7
- flywheel/models/common_editions.py +0 -7
- flywheel/models/common_info.py +3 -8
- flywheel/models/common_join_origins.py +0 -7
- flywheel/models/common_key.py +0 -7
- flywheel/models/common_modified_count.py +0 -7
- flywheel/models/common_object_created.py +0 -7
- flywheel/models/common_project_settings.py +0 -7
- flywheel/models/common_settings.py +0 -7
- flywheel/models/complete_multipart_upload_output.py +13 -14
- flywheel/models/complete_s3_multipart_upload_input.py +23 -20
- flywheel/models/config_feature_map.py +0 -7
- flywheel/models/config_out.py +48 -35
- flywheel/models/config_output.py +0 -7
- flywheel/models/config_site_config_output.py +0 -7
- flywheel/models/config_site_settings.py +0 -7
- flywheel/models/config_site_settings_input.py +0 -7
- flywheel/models/conflict_types.py +0 -7
- flywheel/models/container_delete_reason.py +0 -7
- flywheel/models/container_filter.py +13 -14
- flywheel/models/container_id_view_input.py +73 -50
- flywheel/models/container_id_view_input_execute_and_save.py +33 -26
- flywheel/models/container_modify.py +73 -50
- flywheel/models/container_new_output.py +0 -7
- flywheel/models/container_node_min.py +43 -32
- flywheel/models/container_output.py +0 -7
- flywheel/models/container_output_with_files.py +28 -23
- flywheel/models/container_parents.py +33 -26
- flywheel/models/container_pipeline_input.py +73 -50
- flywheel/models/container_project_parents.py +0 -7
- flywheel/models/container_reference.py +13 -14
- flywheel/models/container_reference_with_label.py +18 -17
- flywheel/models/container_session_parents.py +0 -7
- flywheel/models/container_subject_parents.py +0 -7
- flywheel/models/container_type.py +0 -7
- flywheel/models/container_uidcheck.py +23 -20
- flywheel/models/container_update.py +3 -8
- flywheel/models/context_input.py +18 -17
- flywheel/models/copy_filter.py +33 -26
- flywheel/models/copy_status.py +0 -7
- flywheel/models/core_models_api_key_api_key_input.py +13 -14
- flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
- flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
- flywheel/models/core_models_common_source.py +13 -14
- flywheel/models/core_models_jobs_api_key_input.py +13 -14
- flywheel/models/core_models_search_parent_type.py +0 -7
- flywheel/models/core_workflows_form_responses_models_form_parents.py +33 -26
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
- flywheel/models/creds.py +3 -8
- flywheel/models/curator.py +18 -17
- flywheel/models/current_user_output.py +108 -71
- flywheel/models/custom_field.py +58 -41
- flywheel/models/custom_form.py +23 -20
- flywheel/models/cvat_info.py +28 -23
- flywheel/models/cvat_settings.py +28 -23
- flywheel/models/cvat_settings_input.py +28 -23
- flywheel/models/cvat_sync_state.py +0 -7
- flywheel/models/daily_report_usage.py +78 -53
- flywheel/models/data_strategy.py +0 -7
- flywheel/models/data_view.py +0 -7
- flywheel/models/data_view_analysis_file_spec.py +18 -17
- flywheel/models/data_view_analysis_filter_spec.py +18 -17
- flywheel/models/data_view_column_alias.py +38 -29
- flywheel/models/data_view_column_spec.py +28 -23
- flywheel/models/data_view_execution.py +68 -47
- flywheel/models/data_view_execution_state.py +0 -7
- flywheel/models/data_view_file_spec.py +48 -35
- flywheel/models/data_view_group_by.py +8 -11
- flywheel/models/data_view_group_by_column.py +13 -14
- flywheel/models/data_view_name_filter_spec.py +13 -14
- flywheel/models/data_view_output.py +0 -7
- flywheel/models/data_view_save_data_view_input.py +0 -7
- flywheel/models/data_view_zip_filter_spec.py +18 -17
- flywheel/models/default_flywheel_role.py +0 -7
- flywheel/models/deid_log_skip_reason.py +0 -7
- flywheel/models/delete_by_search_query.py +23 -20
- flywheel/models/delete_status.py +25 -0
- flywheel/models/deleted_file.py +73 -50
- flywheel/models/deleted_result.py +50 -19
- flywheel/models/deprecated_action.py +0 -7
- flywheel/models/destination_container_type.py +0 -7
- flywheel/models/device.py +58 -41
- flywheel/models/device_admin_update.py +13 -14
- flywheel/models/device_create.py +18 -17
- flywheel/models/device_self_update.py +28 -23
- flywheel/models/device_status.py +0 -7
- flywheel/models/device_status_entry.py +18 -17
- flywheel/models/device_storage_strategy_update.py +13 -14
- flywheel/models/dimse_project_input.py +0 -7
- flywheel/models/dimse_project_output.py +0 -7
- flywheel/models/dimse_service_input.py +0 -7
- flywheel/models/dimse_service_output.py +0 -7
- flywheel/models/download.py +23 -20
- flywheel/models/download_container_filter.py +8 -11
- flywheel/models/download_container_filter_definition.py +18 -17
- flywheel/models/download_filter.py +18 -17
- flywheel/models/download_filter_definition.py +13 -14
- flywheel/models/download_format.py +0 -7
- flywheel/models/download_input.py +0 -7
- flywheel/models/download_node.py +13 -14
- flywheel/models/download_strategy.py +0 -7
- flywheel/models/download_ticket.py +0 -7
- flywheel/models/download_ticket_stub.py +23 -20
- flywheel/models/download_ticket_with_summary.py +0 -7
- flywheel/models/e_signature.py +23 -20
- flywheel/models/edition.py +8 -11
- flywheel/models/egress_device.py +88 -59
- flywheel/models/egress_device_page.py +18 -17
- flywheel/models/egress_provider.py +53 -38
- flywheel/models/egress_provider_id.py +8 -11
- flywheel/models/exchange_storage.py +23 -20
- flywheel/models/executor_info.py +43 -32
- flywheel/models/export_templates.py +13 -14
- flywheel/models/features.py +348 -225
- flywheel/models/field_change.py +28 -23
- flywheel/models/field_change_log_document.py +23 -20
- flywheel/models/field_type.py +0 -7
- flywheel/models/file.py +188 -119
- flywheel/models/file_classification_delta.py +23 -20
- flywheel/models/file_container_type.py +0 -7
- flywheel/models/file_entry.py +108 -71
- flywheel/models/file_export_templates.py +28 -23
- flywheel/models/file_format.py +0 -7
- flywheel/models/file_gear_info.py +18 -17
- flywheel/models/file_group.py +0 -7
- flywheel/models/file_list_output.py +183 -116
- flywheel/models/file_modify_input.py +13 -14
- flywheel/models/file_move_input.py +18 -17
- flywheel/models/file_node.py +188 -119
- flywheel/models/file_node_min.py +38 -29
- flywheel/models/file_origin.py +28 -23
- flywheel/models/file_output.py +183 -116
- flywheel/models/file_parents.py +33 -26
- flywheel/models/file_reference.py +18 -17
- flywheel/models/file_suggestion.py +23 -20
- flywheel/models/file_template_options.py +33 -26
- flywheel/models/file_upsert_input.py +88 -59
- flywheel/models/file_upsert_origin.py +0 -7
- flywheel/models/file_upsert_output.py +188 -119
- flywheel/models/file_version.py +13 -14
- flywheel/models/file_version_copy_of.py +28 -23
- flywheel/models/file_version_output.py +38 -29
- flywheel/models/file_via.py +23 -20
- flywheel/models/file_zip_entry.py +0 -7
- flywheel/models/file_zip_info.py +0 -7
- flywheel/models/filter.py +43 -32
- flywheel/models/filter_input.py +18 -17
- flywheel/models/filter_values.py +13 -14
- flywheel/models/filter_view.py +0 -7
- flywheel/models/fixed_file_version_input.py +18 -17
- flywheel/models/fixed_input.py +33 -26
- flywheel/models/form_definition.py +8 -11
- flywheel/models/form_response_base.py +33 -26
- flywheel/models/form_response_create.py +13 -14
- flywheel/models/gcp_creds.py +53 -38
- flywheel/models/gcp_storage.py +33 -26
- flywheel/models/gear.py +88 -59
- flywheel/models/gear_category.py +0 -7
- flywheel/models/gear_config.py +3 -8
- flywheel/models/gear_context_input.py +8 -11
- flywheel/models/gear_context_lookup.py +0 -7
- flywheel/models/gear_context_lookup_item.py +0 -7
- flywheel/models/gear_context_value_output.py +28 -23
- flywheel/models/gear_context_value_output_unfound.py +8 -11
- flywheel/models/gear_custom.py +3 -8
- flywheel/models/gear_directive.py +3 -8
- flywheel/models/gear_doc.py +0 -7
- flywheel/models/gear_document.py +38 -29
- flywheel/models/gear_document_input.py +33 -26
- flywheel/models/gear_document_legacy_input.py +33 -26
- flywheel/models/gear_environment.py +3 -8
- flywheel/models/gear_exchange.py +18 -17
- flywheel/models/gear_file_input.py +13 -14
- flywheel/models/gear_id_output.py +8 -11
- flywheel/models/gear_info.py +23 -20
- flywheel/models/gear_input_item.py +18 -17
- flywheel/models/gear_inputs.py +3 -8
- flywheel/models/gear_key_input.py +13 -14
- flywheel/models/gear_manifest.py +93 -62
- flywheel/models/gear_mixin.py +26 -6
- flywheel/models/gear_node.py +43 -32
- flywheel/models/gear_output_configuration.py +8 -11
- flywheel/models/gear_permissions.py +13 -14
- flywheel/models/gear_permissions_input.py +8 -11
- flywheel/models/gear_permissions_type.py +0 -7
- flywheel/models/gear_return_ticket.py +0 -7
- flywheel/models/gear_rule.py +133 -69
- flywheel/models/gear_rule_condition.py +18 -17
- flywheel/models/gear_rule_condition_type.py +0 -7
- flywheel/models/gear_rule_input.py +108 -54
- flywheel/models/gear_rule_modify_input.py +103 -51
- flywheel/models/gear_rule_output.py +133 -69
- flywheel/models/gear_save_submission.py +18 -17
- flywheel/models/gear_series.py +33 -26
- flywheel/models/gear_series_update.py +8 -11
- flywheel/models/gear_suggestion_output.py +33 -26
- flywheel/models/gear_ticket.py +23 -20
- flywheel/models/gear_ticket_output.py +8 -11
- flywheel/models/graph_filter.py +38 -29
- flywheel/models/group.py +0 -7
- flywheel/models/group_by.py +8 -11
- flywheel/models/group_by_column.py +0 -7
- flywheel/models/group_container_output.py +0 -7
- flywheel/models/group_input.py +23 -20
- flywheel/models/group_metadata_input.py +0 -7
- flywheel/models/group_node.py +0 -7
- flywheel/models/group_output.py +63 -44
- flywheel/models/group_report.py +18 -17
- flywheel/models/group_role.py +8 -11
- flywheel/models/group_settings_output.py +23 -20
- flywheel/models/group_update.py +23 -20
- flywheel/models/header_feature.py +0 -7
- flywheel/models/hierarchy_export_templates.py +28 -23
- flywheel/models/http_validation_error.py +8 -11
- flywheel/models/info.py +18 -17
- flywheel/models/info_add_remove.py +0 -7
- flywheel/models/info_container_type.py +0 -7
- flywheel/models/info_replace.py +0 -7
- flywheel/models/info_update_input.py +0 -7
- flywheel/models/ingress_provider.py +33 -26
- flywheel/models/ingress_providers.py +28 -23
- flywheel/models/ingress_site_settings.py +29 -52
- flywheel/models/ingress_update_provider.py +18 -17
- flywheel/models/inline_response200.py +8 -11
- flywheel/models/inline_response2001.py +8 -11
- flywheel/models/inline_response2002.py +8 -11
- flywheel/models/inline_response2003.py +0 -7
- flywheel/models/inline_response2005.py +0 -7
- flywheel/models/input_filter.py +18 -17
- flywheel/models/input_job.py +73 -50
- flywheel/models/input_job_profile.py +28 -23
- flywheel/models/inserted_id.py +8 -11
- flywheel/models/job.py +128 -83
- flywheel/models/job_analysis_input.py +28 -23
- flywheel/models/job_ask.py +33 -26
- flywheel/models/job_ask_response.py +13 -14
- flywheel/models/job_ask_response_job.py +158 -101
- flywheel/models/job_ask_return.py +0 -7
- flywheel/models/job_ask_return_criteria.py +23 -20
- flywheel/models/job_ask_state.py +0 -7
- flywheel/models/job_ask_state_response.py +8 -11
- flywheel/models/job_complete.py +18 -17
- flywheel/models/job_completion_input.py +0 -7
- flywheel/models/job_completion_ticket.py +0 -7
- flywheel/models/job_config.py +3 -8
- flywheel/models/job_config_input.py +28 -23
- flywheel/models/job_config_inputs.py +0 -7
- flywheel/models/job_config_output.py +0 -7
- flywheel/models/job_container_detail.py +0 -7
- flywheel/models/job_destination.py +13 -14
- flywheel/models/job_detail.py +148 -95
- flywheel/models/job_detail_container.py +13 -14
- flywheel/models/job_detail_file_entry.py +13 -14
- flywheel/models/job_detail_group.py +13 -14
- flywheel/models/job_detail_parent_info.py +33 -26
- flywheel/models/job_executor_info.py +43 -32
- flywheel/models/job_file_input.py +23 -20
- flywheel/models/job_file_input_list_output.py +23 -20
- flywheel/models/job_file_object.py +58 -41
- flywheel/models/job_file_object_list_output.py +53 -38
- flywheel/models/job_gear_match.py +0 -7
- flywheel/models/job_inputs_array_item.py +33 -26
- flywheel/models/job_inputs_item.py +23 -20
- flywheel/models/job_inputs_object.py +3 -8
- flywheel/models/job_list_entry.py +0 -7
- flywheel/models/job_list_output.py +158 -101
- flywheel/models/job_list_output_config.py +18 -17
- flywheel/models/job_log.py +13 -14
- flywheel/models/job_log_column.py +0 -7
- flywheel/models/job_log_record.py +13 -14
- flywheel/models/job_modify.py +13 -14
- flywheel/models/job_origin.py +13 -14
- flywheel/models/job_output.py +163 -104
- flywheel/models/job_output_config.py +23 -20
- flywheel/models/job_parents.py +33 -26
- flywheel/models/job_priority.py +0 -7
- flywheel/models/job_priority_update.py +13 -14
- flywheel/models/job_profile.py +53 -38
- flywheel/models/job_profile_input.py +0 -7
- flywheel/models/job_request.py +18 -17
- flywheel/models/job_request_item.py +23 -20
- flywheel/models/job_request_item_type.py +0 -7
- flywheel/models/job_request_target.py +28 -23
- flywheel/models/job_state.py +0 -7
- flywheel/models/job_state_counts.py +0 -7
- flywheel/models/job_stats_by_state.py +0 -7
- flywheel/models/job_ticket_output.py +8 -11
- flywheel/models/job_transition_times.py +23 -20
- flywheel/models/job_version_info.py +3 -8
- flywheel/models/jobs_by_state.py +28 -23
- flywheel/models/jobs_list.py +8 -11
- flywheel/models/join_origin_device.py +8 -11
- flywheel/models/join_origin_job.py +18 -17
- flywheel/models/join_origin_user.py +13 -14
- flywheel/models/join_origins.py +18 -17
- flywheel/models/join_type.py +0 -7
- flywheel/models/jupyterhub_workspace.py +8 -11
- flywheel/models/jupyterlab_server_modify.py +28 -23
- flywheel/models/jupyterlab_server_origin.py +0 -7
- flywheel/models/jupyterlab_server_output.py +0 -7
- flywheel/models/jupyterlab_server_response.py +53 -38
- flywheel/models/jupyterlab_server_update.py +0 -7
- flywheel/models/ldap_sync.py +0 -7
- flywheel/models/ldap_sync_config.py +8 -11
- flywheel/models/ldap_sync_input.py +0 -7
- flywheel/models/ldap_sync_status.py +23 -20
- flywheel/models/legacy_api_key_output.py +28 -23
- flywheel/models/legacy_input.py +23 -20
- flywheel/models/legacy_usage_report.py +33 -26
- flywheel/models/legacys_usage_project_entry.py +13 -14
- flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
- flywheel/models/libs_workflows_models_parent_type.py +0 -7
- flywheel/models/libs_workflows_models_task_status.py +0 -7
- flywheel/models/local_storage.py +18 -17
- flywheel/models/location.py +13 -14
- flywheel/models/locked.py +18 -17
- flywheel/models/master_subject_code_dob_input.py +28 -23
- flywheel/models/master_subject_code_input.py +28 -23
- flywheel/models/master_subject_code_output.py +8 -11
- flywheel/models/matched_acquisition_output.py +73 -50
- flywheel/models/measurement_config.py +222 -0
- flywheel/models/measurement_item_config.py +217 -0
- flywheel/models/mfa_channel.py +0 -7
- flywheel/models/mfa_settings.py +8 -11
- flywheel/models/ml_set_filter.py +13 -14
- flywheel/models/ml_type.py +0 -7
- flywheel/models/modality.py +23 -20
- flywheel/models/modality_input.py +23 -20
- flywheel/models/modality_modify.py +18 -17
- flywheel/models/modality_output.py +28 -23
- flywheel/models/modified_result.py +13 -14
- flywheel/models/modify_user_input.py +63 -44
- flywheel/models/move_conflict.py +33 -26
- flywheel/models/note.py +48 -35
- flywheel/models/note_input.py +8 -11
- flywheel/models/optional_input_policy.py +0 -7
- flywheel/models/order.py +0 -7
- flywheel/models/organ_system.py +0 -7
- flywheel/models/origin.py +13 -14
- flywheel/models/origin_type.py +0 -7
- flywheel/models/orphaned_count.py +8 -11
- flywheel/models/output_user_page.py +18 -17
- flywheel/models/packfile_cleanup_output.py +8 -11
- flywheel/models/packfile_removed_output.py +13 -14
- flywheel/models/page.py +18 -17
- flywheel/models/page_generic_file_output.py +18 -17
- flywheel/models/page_generic_filter.py +18 -17
- flywheel/models/page_generic_form_response_output.py +18 -17
- flywheel/models/page_generic_protocol.py +23 -20
- flywheel/models/page_generic_reader_task_output.py +23 -20
- flywheel/models/page_generic_staffing_pool.py +23 -20
- flywheel/models/parsed_query_response.py +13 -14
- flywheel/models/permission_access_permission.py +0 -7
- flywheel/models/premade_jobs_batch_job_output.py +33 -26
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
- flywheel/models/premade_jobs_batch_proposal.py +38 -29
- flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
- flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
- flywheel/models/project.py +0 -7
- flywheel/models/project_acquisition_upsert_input.py +0 -7
- flywheel/models/project_acquisition_upsert_output.py +0 -7
- flywheel/models/project_aet.py +38 -29
- flywheel/models/project_aet_input.py +23 -20
- flywheel/models/project_catalog_list_output.py +0 -7
- flywheel/models/project_contact.py +13 -14
- flywheel/models/project_container_output.py +1 -7
- flywheel/models/project_copy_input.py +23 -20
- flywheel/models/project_copy_output.py +18 -17
- flywheel/models/project_counters.py +76 -36
- flywheel/models/project_delete_status_output.py +192 -0
- flywheel/models/project_group_info.py +13 -14
- flywheel/models/project_hierarchy_input.py +28 -23
- flywheel/models/project_hierarchy_output.py +18 -17
- flywheel/models/project_hierarchy_upsert_input.py +0 -7
- flywheel/models/project_hierarchy_upsert_output.py +0 -7
- flywheel/models/project_input.py +48 -35
- flywheel/models/project_institution.py +13 -14
- flywheel/models/project_list_output.py +207 -96
- flywheel/models/project_locking_reason.py +0 -7
- flywheel/models/project_modify.py +116 -42
- flywheel/models/project_node.py +1 -7
- flywheel/models/project_output.py +208 -96
- flywheel/models/project_parents.py +8 -11
- flywheel/models/project_report.py +63 -44
- flywheel/models/project_report_list.py +8 -11
- flywheel/models/project_session_upsert_input.py +0 -7
- flywheel/models/project_session_upsert_output.py +0 -7
- flywheel/models/project_settings_input.py +38 -29
- flywheel/models/project_settings_output.py +38 -29
- flywheel/models/project_settings_sharing.py +38 -29
- flywheel/models/project_settings_sharing_input.py +38 -29
- flywheel/models/project_settings_workspaces.py +8 -11
- flywheel/models/project_settings_workspaces_input.py +8 -11
- flywheel/models/project_share_level.py +0 -7
- flywheel/models/project_sharing_settings_project_contact.py +0 -7
- flywheel/models/project_sharing_settings_project_counters.py +0 -7
- flywheel/models/project_sharing_settings_project_institution.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
- flywheel/models/project_sharing_settings_project_stats.py +0 -7
- flywheel/models/project_stats.py +28 -23
- flywheel/models/project_subject_upsert_input.py +0 -7
- flywheel/models/project_subject_upsert_output.py +0 -7
- flywheel/models/project_template.py +13 -14
- flywheel/models/project_template_input.py +13 -14
- flywheel/models/project_template_list_input.py +8 -11
- flywheel/models/project_template_requirement.py +0 -7
- flywheel/models/project_template_session_template.py +0 -7
- flywheel/models/project_upsert_origin.py +0 -7
- flywheel/models/protocol.py +78 -53
- flywheel/models/protocol_e_signature_config.py +13 -14
- flywheel/models/protocol_input.py +43 -32
- flywheel/models/protocol_modify.py +28 -23
- flywheel/models/protocol_status.py +0 -7
- flywheel/models/provider.py +63 -44
- flywheel/models/provider_access_type.py +0 -7
- flywheel/models/provider_class.py +0 -7
- flywheel/models/provider_deletion_status.py +13 -14
- flywheel/models/provider_input.py +0 -7
- flywheel/models/provider_links.py +28 -23
- flywheel/models/provider_type.py +0 -7
- flywheel/models/providers.py +28 -23
- flywheel/models/reader_batch_create.py +63 -44
- flywheel/models/reader_task.py +113 -74
- flywheel/models/reader_task_config.py +49 -18
- flywheel/models/reader_task_create.py +78 -53
- flywheel/models/reader_task_modify.py +33 -26
- flywheel/models/reader_task_output.py +118 -77
- flywheel/models/reader_task_parent_details.py +38 -29
- flywheel/models/report_access_log_context.py +33 -26
- flywheel/models/report_access_log_context_entry.py +13 -14
- flywheel/models/report_access_log_context_file_entry.py +8 -11
- flywheel/models/report_access_log_entry.py +88 -59
- flywheel/models/report_access_log_origin.py +13 -14
- flywheel/models/report_availability_list.py +8 -11
- flywheel/models/report_daily_usage_entry.py +68 -47
- flywheel/models/report_demographics_grid.py +0 -7
- flywheel/models/report_ethnicity_grid.py +23 -20
- flywheel/models/report_gender_count.py +18 -17
- flywheel/models/report_group_report.py +18 -17
- flywheel/models/report_legacy_usage_entry.py +0 -7
- flywheel/models/report_legacy_usage_project_entry.py +0 -7
- flywheel/models/report_project.py +0 -7
- flywheel/models/report_site.py +13 -14
- flywheel/models/report_time_period.py +13 -14
- flywheel/models/report_usage.py +88 -59
- flywheel/models/report_usage_entry.py +0 -7
- flywheel/models/resolve_input.py +8 -11
- flywheel/models/resolve_output.py +13 -14
- flywheel/models/resolver_acquisition_node.py +0 -7
- flywheel/models/resolver_analysis_node.py +0 -7
- flywheel/models/resolver_file_node.py +0 -7
- flywheel/models/resolver_gear_node.py +0 -7
- flywheel/models/resolver_group_node.py +0 -7
- flywheel/models/resolver_input.py +0 -7
- flywheel/models/resolver_node.py +8 -11
- flywheel/models/resolver_output.py +0 -7
- flywheel/models/resolver_project_node.py +0 -7
- flywheel/models/resolver_session_node.py +0 -7
- flywheel/models/resolver_subject_node.py +0 -7
- flywheel/models/role_input.py +13 -14
- flywheel/models/role_output.py +28 -23
- flywheel/models/role_permission.py +13 -14
- flywheel/models/role_permission_output.py +13 -14
- flywheel/models/role_permission_update.py +8 -11
- flywheel/models/role_type.py +0 -7
- flywheel/models/role_update.py +13 -14
- flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
- flywheel/models/roles_group_role_pool_input.py +0 -7
- flywheel/models/roles_role.py +0 -7
- flywheel/models/roles_role_assignment.py +13 -14
- flywheel/models/roles_role_input.py +0 -7
- flywheel/models/rule.py +63 -44
- flywheel/models/rule_any.py +18 -17
- flywheel/models/s3_addressing_style.py +0 -7
- flywheel/models/s3_compat_storage.py +48 -35
- flywheel/models/save_search.py +33 -26
- flywheel/models/save_search_input.py +18 -17
- flywheel/models/save_search_output.py +33 -26
- flywheel/models/save_search_page.py +18 -17
- flywheel/models/save_search_parent.py +13 -14
- flywheel/models/save_search_update.py +13 -14
- flywheel/models/search_acquisition_response.py +23 -20
- flywheel/models/search_analysis_response.py +23 -20
- flywheel/models/search_collection_response.py +23 -20
- flywheel/models/search_file_response.py +33 -26
- flywheel/models/search_group_response.py +13 -14
- flywheel/models/search_parent_acquisition.py +0 -7
- flywheel/models/search_parent_analysis.py +0 -7
- flywheel/models/search_parent_collection.py +0 -7
- flywheel/models/search_parent_project.py +1 -7
- flywheel/models/search_parent_response.py +13 -14
- flywheel/models/search_parent_session.py +0 -7
- flywheel/models/search_parent_subject.py +0 -7
- flywheel/models/search_parse_error.py +23 -20
- flywheel/models/search_parse_search_query_result.py +0 -7
- flywheel/models/search_project_response.py +13 -14
- flywheel/models/search_query.py +38 -29
- flywheel/models/search_query_suggestions.py +0 -7
- flywheel/models/search_response.py +58 -41
- flywheel/models/search_return_type.py +0 -7
- flywheel/models/search_save_search.py +0 -7
- flywheel/models/search_save_search_input.py +0 -7
- flywheel/models/search_save_search_parent.py +0 -7
- flywheel/models/search_save_search_update.py +0 -7
- flywheel/models/search_session_response.py +23 -20
- flywheel/models/search_status.py +8 -11
- flywheel/models/search_structured_search_query.py +0 -7
- flywheel/models/search_subject_response.py +18 -17
- flywheel/models/search_suggestion.py +0 -7
- flywheel/models/select_item.py +13 -14
- flywheel/models/server_state.py +33 -26
- flywheel/models/service_aet.py +33 -26
- flywheel/models/service_aet_input.py +28 -23
- flywheel/models/session.py +0 -7
- flywheel/models/session_container_output.py +0 -7
- flywheel/models/session_copy_input.py +23 -20
- flywheel/models/session_embedded_subject.py +33 -26
- flywheel/models/session_input.py +58 -41
- flywheel/models/session_list_output.py +143 -92
- flywheel/models/session_metadata_input.py +0 -7
- flywheel/models/session_modify.py +63 -44
- flywheel/models/session_node.py +0 -7
- flywheel/models/session_output.py +143 -92
- flywheel/models/session_parents.py +18 -17
- flywheel/models/session_template_options.py +18 -17
- flywheel/models/session_template_recalc_output.py +8 -11
- flywheel/models/session_upsert_input.py +63 -44
- flywheel/models/session_upsert_output.py +23 -20
- flywheel/models/sharing_filter_options.py +43 -32
- flywheel/models/signed_fs_upload_output.py +13 -14
- flywheel/models/signed_url_cleanup_input.py +13 -14
- flywheel/models/signed_url_upload_input.py +13 -14
- flywheel/models/signed_url_upload_output.py +43 -32
- flywheel/models/site.py +93 -62
- flywheel/models/site_report.py +13 -14
- flywheel/models/site_settings.py +48 -35
- flywheel/models/sort.py +13 -14
- flywheel/models/stable_api_key_input.py +0 -7
- flywheel/models/staffing_pool.py +38 -29
- flywheel/models/staffing_pool_create.py +18 -17
- flywheel/models/staffing_pool_list.py +8 -11
- flywheel/models/staffing_pool_modify.py +18 -17
- flywheel/models/state.py +0 -7
- flywheel/models/static_compute.py +18 -17
- flywheel/models/status_transitions.py +23 -20
- flywheel/models/status_type.py +0 -7
- flywheel/models/status_value.py +0 -7
- flywheel/models/storage_strategy.py +0 -7
- flywheel/models/storage_strategy_config.py +13 -14
- flywheel/models/structured_query.py +8 -11
- flywheel/models/structured_query_suggestions.py +13 -14
- flywheel/models/structured_query_value_suggestion.py +23 -20
- flywheel/models/subject.py +0 -7
- flywheel/models/subject_container_output.py +0 -7
- flywheel/models/subject_copy_input.py +18 -17
- flywheel/models/subject_input.py +93 -62
- flywheel/models/subject_modify.py +103 -68
- flywheel/models/subject_node.py +0 -7
- flywheel/models/subject_output.py +163 -104
- flywheel/models/subject_output_for_list.py +163 -104
- flywheel/models/subject_parents.py +13 -14
- flywheel/models/subject_role_permission.py +13 -14
- flywheel/models/subject_state.py +0 -7
- flywheel/models/subject_template_options.py +13 -14
- flywheel/models/subject_upsert_input.py +83 -56
- flywheel/models/subject_upsert_output.py +18 -17
- flywheel/models/sync_user_input.py +38 -29
- flywheel/models/tag.py +8 -11
- flywheel/models/task_assign.py +13 -14
- flywheel/models/task_facet.py +0 -7
- flywheel/models/task_parent_ref.py +23 -20
- flywheel/models/task_parent_ref_input.py +18 -17
- flywheel/models/task_priority.py +0 -7
- flywheel/models/task_submission.py +13 -14
- flywheel/models/therapeutic_area.py +0 -7
- flywheel/models/toolbar_config.py +161 -0
- flywheel/models/transitions.py +28 -23
- flywheel/models/tree_container_request_spec.py +28 -23
- flywheel/models/tree_graph.py +3 -8
- flywheel/models/tree_graph_connection.py +23 -20
- flywheel/models/tree_graph_connections.py +3 -8
- flywheel/models/tree_graph_node.py +8 -11
- flywheel/models/tree_request.py +0 -7
- flywheel/models/tree_response_item.py +3 -8
- flywheel/models/type_str.py +0 -7
- flywheel/models/uid_check_input_acquisitions.py +23 -20
- flywheel/models/uid_check_input_sessions.py +23 -20
- flywheel/models/uid_check_output.py +13 -14
- flywheel/models/upload_complete_s3_multipart_input.py +0 -7
- flywheel/models/upload_complete_s3_multipart_output.py +0 -7
- flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
- flywheel/models/upload_signed_upload_url_input.py +0 -7
- flywheel/models/upload_signed_upload_url_output.py +0 -7
- flywheel/models/upload_ticket_output.py +18 -17
- flywheel/models/upload_token_output.py +8 -11
- flywheel/models/upsert_result.py +0 -7
- flywheel/models/user.py +113 -74
- flywheel/models/user_api_key.py +18 -17
- flywheel/models/user_input.py +63 -44
- flywheel/models/user_jobs.py +18 -17
- flywheel/models/user_jobs_output.py +0 -7
- flywheel/models/user_output.py +0 -7
- flywheel/models/user_output_id.py +8 -11
- flywheel/models/user_preferences.py +3 -8
- flywheel/models/user_wechat.py +3 -8
- flywheel/models/validation_error.py +18 -17
- flywheel/models/validation_rule.py +13 -14
- flywheel/models/version.py +43 -32
- flywheel/models/version_output.py +0 -7
- flywheel/models/view_id_output.py +8 -11
- flywheel/models/view_output.py +58 -41
- flywheel/models/viewer_app.py +48 -35
- flywheel/models/viewer_app_input.py +48 -35
- flywheel/models/viewer_app_type.py +0 -7
- flywheel/models/virus_scan.py +8 -11
- flywheel/models/virus_scan_state.py +0 -7
- flywheel/models/work_in_progress_features.py +3 -8
- flywheel/models/zipfile_info.py +13 -14
- flywheel/models/zipfile_member_info.py +23 -20
- flywheel/partial_reader.py +0 -7
- flywheel/rest.py +0 -7
- flywheel/view_builder.py +2 -1
- {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
- flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
- flywheel/models/google_auth_out.py +0 -299
- flywheel_sdk-21.3.0.dist-info/RECORD +0 -773
- {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +0 -0
- {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
flywheel/api/analyses_api.py
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
Flywheel
|
|
5
|
-
|
|
6
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
|
|
7
|
-
|
|
8
|
-
OpenAPI spec version: 0.0.1
|
|
9
|
-
|
|
10
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
4
|
"""
|
|
12
5
|
|
|
13
6
|
|
|
@@ -37,10 +30,13 @@ class AnalysesApi(object):
|
|
|
37
30
|
Add a note to a(n) analysis.
|
|
38
31
|
This method makes a synchronous HTTP request by default.
|
|
39
32
|
|
|
40
|
-
:param
|
|
41
|
-
:
|
|
42
|
-
:param
|
|
43
|
-
:
|
|
33
|
+
:param container_id:
|
|
34
|
+
:type container_id: str
|
|
35
|
+
:param body:
|
|
36
|
+
:type body: NoteInput
|
|
37
|
+
:param async_: Perform the request asynchronously
|
|
38
|
+
:type async_: bool, optional
|
|
39
|
+
:rtype: Note
|
|
44
40
|
"""
|
|
45
41
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
46
42
|
kwargs['_return_http_data_only'] = True
|
|
@@ -64,10 +60,13 @@ class AnalysesApi(object):
|
|
|
64
60
|
Add a note to a(n) analysis.
|
|
65
61
|
This method makes a synchronous HTTP request by default.
|
|
66
62
|
|
|
67
|
-
:param
|
|
68
|
-
:
|
|
69
|
-
:param
|
|
70
|
-
:
|
|
63
|
+
:param container_id:
|
|
64
|
+
:type container_id: str
|
|
65
|
+
:param body:
|
|
66
|
+
:type body: NoteInput
|
|
67
|
+
:param async_: Perform the request asynchronously
|
|
68
|
+
:type async_: bool, optional
|
|
69
|
+
:rtype: Note
|
|
71
70
|
"""
|
|
72
71
|
|
|
73
72
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -153,10 +152,13 @@ class AnalysesApi(object):
|
|
|
153
152
|
Propagates changes to projects, sessions and acquisitions
|
|
154
153
|
This method makes a synchronous HTTP request by default.
|
|
155
154
|
|
|
156
|
-
:param
|
|
157
|
-
:
|
|
158
|
-
:param
|
|
159
|
-
:
|
|
155
|
+
:param container_id:
|
|
156
|
+
:type container_id: str
|
|
157
|
+
:param body:
|
|
158
|
+
:type body: Tag
|
|
159
|
+
:param async_: Perform the request asynchronously
|
|
160
|
+
:type async_: bool, optional
|
|
161
|
+
:rtype: ModifiedResult
|
|
160
162
|
"""
|
|
161
163
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
162
164
|
kwargs['_return_http_data_only'] = True
|
|
@@ -180,10 +182,13 @@ class AnalysesApi(object):
|
|
|
180
182
|
Propagates changes to projects, sessions and acquisitions
|
|
181
183
|
This method makes a synchronous HTTP request by default.
|
|
182
184
|
|
|
183
|
-
:param
|
|
184
|
-
:
|
|
185
|
-
:param
|
|
186
|
-
:
|
|
185
|
+
:param container_id:
|
|
186
|
+
:type container_id: str
|
|
187
|
+
:param body:
|
|
188
|
+
:type body: Tag
|
|
189
|
+
:param async_: Perform the request asynchronously
|
|
190
|
+
:type async_: bool, optional
|
|
191
|
+
:rtype: ModifiedResult
|
|
187
192
|
"""
|
|
188
193
|
|
|
189
194
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -269,10 +274,13 @@ class AnalysesApi(object):
|
|
|
269
274
|
Delete multiple analyses by ID list
|
|
270
275
|
This method makes a synchronous HTTP request by default.
|
|
271
276
|
|
|
272
|
-
:param
|
|
273
|
-
:
|
|
274
|
-
:param
|
|
275
|
-
:
|
|
277
|
+
:param body: List of IDs to delete
|
|
278
|
+
:type body: list[str]
|
|
279
|
+
:param delete_reason:
|
|
280
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
281
|
+
:param async_: Perform the request asynchronously
|
|
282
|
+
:type async_: bool, optional
|
|
283
|
+
:rtype: DeletedResult
|
|
276
284
|
"""
|
|
277
285
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
278
286
|
kwargs['_return_http_data_only'] = True
|
|
@@ -296,10 +304,13 @@ class AnalysesApi(object):
|
|
|
296
304
|
Delete multiple analyses by ID list
|
|
297
305
|
This method makes a synchronous HTTP request by default.
|
|
298
306
|
|
|
299
|
-
:param
|
|
300
|
-
:
|
|
301
|
-
:param
|
|
302
|
-
:
|
|
307
|
+
:param body: List of IDs to delete
|
|
308
|
+
:type body: list[str]
|
|
309
|
+
:param delete_reason:
|
|
310
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
311
|
+
:param async_: Perform the request asynchronously
|
|
312
|
+
:type async_: bool, optional
|
|
313
|
+
:rtype: DeletedResult
|
|
303
314
|
"""
|
|
304
315
|
|
|
305
316
|
all_params = ['body','delete_reason',] # noqa: E501
|
|
@@ -374,10 +385,13 @@ class AnalysesApi(object):
|
|
|
374
385
|
Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when audit-trail is enabled)
|
|
375
386
|
This method makes a synchronous HTTP request by default.
|
|
376
387
|
|
|
377
|
-
:param
|
|
378
|
-
:
|
|
379
|
-
:param
|
|
380
|
-
:
|
|
388
|
+
:param analysis_id: 24-char hex analysis id
|
|
389
|
+
:type analysis_id: str
|
|
390
|
+
:param delete_reason:
|
|
391
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
392
|
+
:param async_: Perform the request asynchronously
|
|
393
|
+
:type async_: bool, optional
|
|
394
|
+
:rtype: DeletedResult
|
|
381
395
|
"""
|
|
382
396
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
383
397
|
kwargs['_return_http_data_only'] = True
|
|
@@ -401,10 +415,13 @@ class AnalysesApi(object):
|
|
|
401
415
|
Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when audit-trail is enabled)
|
|
402
416
|
This method makes a synchronous HTTP request by default.
|
|
403
417
|
|
|
404
|
-
:param
|
|
405
|
-
:
|
|
406
|
-
:param
|
|
407
|
-
:
|
|
418
|
+
:param analysis_id: 24-char hex analysis id
|
|
419
|
+
:type analysis_id: str
|
|
420
|
+
:param delete_reason:
|
|
421
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
422
|
+
:param async_: Perform the request asynchronously
|
|
423
|
+
:type async_: bool, optional
|
|
424
|
+
:rtype: DeletedResult
|
|
408
425
|
"""
|
|
409
426
|
|
|
410
427
|
all_params = ['analysis_id','delete_reason',] # noqa: E501
|
|
@@ -475,12 +492,17 @@ class AnalysesApi(object):
|
|
|
475
492
|
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.
|
|
476
493
|
This method makes a synchronous HTTP request by default.
|
|
477
494
|
|
|
478
|
-
:param
|
|
479
|
-
:
|
|
480
|
-
:param
|
|
481
|
-
:
|
|
482
|
-
:param
|
|
483
|
-
:
|
|
495
|
+
:param cid:
|
|
496
|
+
:type cid: str
|
|
497
|
+
:param filename:
|
|
498
|
+
:type filename: str
|
|
499
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
500
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
501
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
502
|
+
:type force: bool, optional
|
|
503
|
+
:param async_: Perform the request asynchronously
|
|
504
|
+
:type async_: bool, optional
|
|
505
|
+
:rtype: DeletedResult
|
|
484
506
|
"""
|
|
485
507
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
486
508
|
kwargs['_return_http_data_only'] = True
|
|
@@ -504,12 +526,17 @@ class AnalysesApi(object):
|
|
|
504
526
|
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.
|
|
505
527
|
This method makes a synchronous HTTP request by default.
|
|
506
528
|
|
|
507
|
-
:param
|
|
508
|
-
:
|
|
509
|
-
:param
|
|
510
|
-
:
|
|
511
|
-
:param
|
|
512
|
-
:
|
|
529
|
+
:param cid:
|
|
530
|
+
:type cid: str
|
|
531
|
+
:param filename:
|
|
532
|
+
:type filename: str
|
|
533
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
534
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
535
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
536
|
+
:type force: bool, optional
|
|
537
|
+
:param async_: Perform the request asynchronously
|
|
538
|
+
:type async_: bool, optional
|
|
539
|
+
:rtype: DeletedResult
|
|
513
540
|
"""
|
|
514
541
|
|
|
515
542
|
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
@@ -588,10 +615,13 @@ class AnalysesApi(object):
|
|
|
588
615
|
Remove a note from a(n) analysis
|
|
589
616
|
This method makes a synchronous HTTP request by default.
|
|
590
617
|
|
|
591
|
-
:param
|
|
592
|
-
:
|
|
593
|
-
:param
|
|
594
|
-
:
|
|
618
|
+
:param container_id:
|
|
619
|
+
:type container_id: str
|
|
620
|
+
:param note_id:
|
|
621
|
+
:type note_id: str
|
|
622
|
+
:param async_: Perform the request asynchronously
|
|
623
|
+
:type async_: bool, optional
|
|
624
|
+
:rtype: DeletedResult
|
|
595
625
|
"""
|
|
596
626
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
597
627
|
kwargs['_return_http_data_only'] = True
|
|
@@ -615,10 +645,13 @@ class AnalysesApi(object):
|
|
|
615
645
|
Remove a note from a(n) analysis
|
|
616
646
|
This method makes a synchronous HTTP request by default.
|
|
617
647
|
|
|
618
|
-
:param
|
|
619
|
-
:
|
|
620
|
-
:param
|
|
621
|
-
:
|
|
648
|
+
:param container_id:
|
|
649
|
+
:type container_id: str
|
|
650
|
+
:param note_id:
|
|
651
|
+
:type note_id: str
|
|
652
|
+
:param async_: Perform the request asynchronously
|
|
653
|
+
:type async_: bool, optional
|
|
654
|
+
:rtype: DeletedResult
|
|
622
655
|
"""
|
|
623
656
|
|
|
624
657
|
all_params = ['container_id','note_id',] # noqa: E501
|
|
@@ -693,10 +726,13 @@ class AnalysesApi(object):
|
|
|
693
726
|
Delete a tag
|
|
694
727
|
This method makes a synchronous HTTP request by default.
|
|
695
728
|
|
|
696
|
-
:param
|
|
697
|
-
:
|
|
698
|
-
:param
|
|
699
|
-
:
|
|
729
|
+
:param container_id:
|
|
730
|
+
:type container_id: str
|
|
731
|
+
:param value: The tag to interact with
|
|
732
|
+
:type value: str
|
|
733
|
+
:param async_: Perform the request asynchronously
|
|
734
|
+
:type async_: bool, optional
|
|
735
|
+
:rtype: DeletedResult
|
|
700
736
|
"""
|
|
701
737
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
702
738
|
kwargs['_return_http_data_only'] = True
|
|
@@ -720,10 +756,13 @@ class AnalysesApi(object):
|
|
|
720
756
|
Delete a tag
|
|
721
757
|
This method makes a synchronous HTTP request by default.
|
|
722
758
|
|
|
723
|
-
:param
|
|
724
|
-
:
|
|
725
|
-
:param
|
|
726
|
-
:
|
|
759
|
+
:param container_id:
|
|
760
|
+
:type container_id: str
|
|
761
|
+
:param value: The tag to interact with
|
|
762
|
+
:type value: str
|
|
763
|
+
:param async_: Perform the request asynchronously
|
|
764
|
+
:type async_: bool, optional
|
|
765
|
+
:rtype: DeletedResult
|
|
727
766
|
"""
|
|
728
767
|
|
|
729
768
|
all_params = ['container_id','value',] # noqa: E501
|
|
@@ -798,18 +837,29 @@ class AnalysesApi(object):
|
|
|
798
837
|
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.
|
|
799
838
|
This method makes a synchronous HTTP request by default.
|
|
800
839
|
|
|
801
|
-
:param
|
|
802
|
-
:
|
|
803
|
-
:param
|
|
804
|
-
:
|
|
805
|
-
:param
|
|
806
|
-
:
|
|
807
|
-
:param
|
|
808
|
-
:
|
|
809
|
-
:param
|
|
810
|
-
:
|
|
811
|
-
:param
|
|
812
|
-
:
|
|
840
|
+
:param analysis_id: 24-character hex ID
|
|
841
|
+
:type analysis_id: str
|
|
842
|
+
:param file_name: output file name
|
|
843
|
+
:type file_name: str
|
|
844
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
845
|
+
:type info: bool, optional
|
|
846
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
847
|
+
:type member: str, optional
|
|
848
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
849
|
+
:type view: bool, optional
|
|
850
|
+
:param version: version of the file to download
|
|
851
|
+
:type version: int, optional
|
|
852
|
+
:param hash: file hash for comparison
|
|
853
|
+
:type hash: str, optional
|
|
854
|
+
:param range: byte ranges to return
|
|
855
|
+
:type range: str, optional
|
|
856
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
857
|
+
:type x_accept_feature: list[str], optional
|
|
858
|
+
:param dest_file: Destination file path
|
|
859
|
+
:type dest_file: str
|
|
860
|
+
:param async_: Perform the request asynchronously
|
|
861
|
+
:type async_: bool, optional
|
|
862
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
813
863
|
"""
|
|
814
864
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
815
865
|
kwargs['_return_http_data_only'] = True
|
|
@@ -832,17 +882,27 @@ class AnalysesApi(object):
|
|
|
832
882
|
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.
|
|
833
883
|
This method makes a synchronous HTTP request by default.
|
|
834
884
|
|
|
835
|
-
:param
|
|
836
|
-
:
|
|
837
|
-
:param
|
|
838
|
-
:
|
|
839
|
-
:param
|
|
840
|
-
:
|
|
841
|
-
:param
|
|
842
|
-
:
|
|
843
|
-
:param
|
|
844
|
-
:
|
|
845
|
-
:
|
|
885
|
+
:param analysis_id: 24-character hex ID
|
|
886
|
+
:type analysis_id: str
|
|
887
|
+
:param file_name: output file name
|
|
888
|
+
:type file_name: str
|
|
889
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
890
|
+
:type info: bool, optional
|
|
891
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
892
|
+
:type member: str, optional
|
|
893
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
894
|
+
:type view: bool, optional
|
|
895
|
+
:param version: version of the file to download
|
|
896
|
+
:type version: int, optional
|
|
897
|
+
:param hash: file hash for comparison
|
|
898
|
+
:type hash: str, optional
|
|
899
|
+
:param range: byte ranges to return
|
|
900
|
+
:type range: str, optional
|
|
901
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
902
|
+
:type x_accept_feature: list[str], optional
|
|
903
|
+
:param async_: Perform the request asynchronously
|
|
904
|
+
:type async_: bool, optional
|
|
905
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
846
906
|
"""
|
|
847
907
|
|
|
848
908
|
all_params = ['analysis_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -932,18 +992,29 @@ class AnalysesApi(object):
|
|
|
932
992
|
Does not work on files whose names contain a forward slash.
|
|
933
993
|
This method makes a synchronous HTTP request by default.
|
|
934
994
|
|
|
935
|
-
:param
|
|
936
|
-
:
|
|
937
|
-
:param
|
|
938
|
-
:
|
|
939
|
-
:param
|
|
940
|
-
:
|
|
941
|
-
:param
|
|
942
|
-
:
|
|
943
|
-
:param
|
|
944
|
-
:
|
|
945
|
-
:param
|
|
946
|
-
:
|
|
995
|
+
:param analysis_id: 24-character hex ID
|
|
996
|
+
:type analysis_id: str
|
|
997
|
+
:param file_name: output file name
|
|
998
|
+
:type file_name: str
|
|
999
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1000
|
+
:type ticket: str, optional
|
|
1001
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1002
|
+
:type info: bool, optional
|
|
1003
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1004
|
+
:type member: str, optional
|
|
1005
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1006
|
+
:type view: bool, optional
|
|
1007
|
+
:param version: version of the file to download
|
|
1008
|
+
:type version: int, optional
|
|
1009
|
+
:param hash: file hash for comparison
|
|
1010
|
+
:type hash: str, optional
|
|
1011
|
+
:param range: byte ranges to return
|
|
1012
|
+
:type range: str, optional
|
|
1013
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1014
|
+
:type x_accept_feature: list[str], optional
|
|
1015
|
+
:param async_: Perform the request asynchronously
|
|
1016
|
+
:type async_: bool, optional
|
|
1017
|
+
:rtype: FileZipInfo
|
|
947
1018
|
"""
|
|
948
1019
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
949
1020
|
kwargs['_return_http_data_only'] = True
|
|
@@ -967,18 +1038,29 @@ class AnalysesApi(object):
|
|
|
967
1038
|
Does not work on files whose names contain a forward slash.
|
|
968
1039
|
This method makes a synchronous HTTP request by default.
|
|
969
1040
|
|
|
970
|
-
:param
|
|
971
|
-
:
|
|
972
|
-
:param
|
|
973
|
-
:
|
|
974
|
-
:param
|
|
975
|
-
:
|
|
976
|
-
:param
|
|
977
|
-
:
|
|
978
|
-
:param
|
|
979
|
-
:
|
|
980
|
-
:param
|
|
981
|
-
:
|
|
1041
|
+
:param analysis_id: 24-character hex ID
|
|
1042
|
+
:type analysis_id: str
|
|
1043
|
+
:param file_name: output file name
|
|
1044
|
+
:type file_name: str
|
|
1045
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1046
|
+
:type ticket: str, optional
|
|
1047
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1048
|
+
:type info: bool, optional
|
|
1049
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1050
|
+
:type member: str, optional
|
|
1051
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1052
|
+
:type view: bool, optional
|
|
1053
|
+
:param version: version of the file to download
|
|
1054
|
+
:type version: int, optional
|
|
1055
|
+
:param hash: file hash for comparison
|
|
1056
|
+
:type hash: str, optional
|
|
1057
|
+
:param range: byte ranges to return
|
|
1058
|
+
:type range: str, optional
|
|
1059
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1060
|
+
:type x_accept_feature: list[str], optional
|
|
1061
|
+
:param async_: Perform the request asynchronously
|
|
1062
|
+
:type async_: bool, optional
|
|
1063
|
+
:rtype: FileZipInfo
|
|
982
1064
|
"""
|
|
983
1065
|
|
|
984
1066
|
all_params = ['analysis_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1071,18 +1153,29 @@ class AnalysesApi(object):
|
|
|
1071
1153
|
|
|
1072
1154
|
This method makes a synchronous HTTP request by default.
|
|
1073
1155
|
|
|
1074
|
-
:param
|
|
1075
|
-
:
|
|
1076
|
-
:param
|
|
1077
|
-
:
|
|
1078
|
-
:param
|
|
1079
|
-
:
|
|
1080
|
-
:param
|
|
1081
|
-
:
|
|
1082
|
-
:param
|
|
1083
|
-
:
|
|
1084
|
-
:param
|
|
1085
|
-
:
|
|
1156
|
+
:param analysis_id: 24-character hex ID
|
|
1157
|
+
:type analysis_id: str
|
|
1158
|
+
:param file_name: output file name
|
|
1159
|
+
:type file_name: str
|
|
1160
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1161
|
+
:type ticket: str, optional
|
|
1162
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1163
|
+
:type info: bool, optional
|
|
1164
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1165
|
+
:type member: str, optional
|
|
1166
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1167
|
+
:type view: bool, optional
|
|
1168
|
+
:param version: version of the file to download
|
|
1169
|
+
:type version: int, optional
|
|
1170
|
+
:param hash: file hash for comparison
|
|
1171
|
+
:type hash: str, optional
|
|
1172
|
+
:param range: byte ranges to return
|
|
1173
|
+
:type range: str, optional
|
|
1174
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1175
|
+
:type x_accept_feature: list[str], optional
|
|
1176
|
+
:param async_: Perform the request asynchronously
|
|
1177
|
+
:type async_: bool, optional
|
|
1178
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1086
1179
|
"""
|
|
1087
1180
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1088
1181
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1105,18 +1198,29 @@ class AnalysesApi(object):
|
|
|
1105
1198
|
|
|
1106
1199
|
This method makes a synchronous HTTP request by default.
|
|
1107
1200
|
|
|
1108
|
-
:param
|
|
1109
|
-
:
|
|
1110
|
-
:param
|
|
1111
|
-
:
|
|
1112
|
-
:param
|
|
1113
|
-
:
|
|
1114
|
-
:param
|
|
1115
|
-
:
|
|
1116
|
-
:param
|
|
1117
|
-
:
|
|
1118
|
-
:param
|
|
1119
|
-
:
|
|
1201
|
+
:param analysis_id: 24-character hex ID
|
|
1202
|
+
:type analysis_id: str
|
|
1203
|
+
:param file_name: output file name
|
|
1204
|
+
:type file_name: str
|
|
1205
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1206
|
+
:type ticket: str, optional
|
|
1207
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1208
|
+
:type info: bool, optional
|
|
1209
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1210
|
+
:type member: str, optional
|
|
1211
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1212
|
+
:type view: bool, optional
|
|
1213
|
+
:param version: version of the file to download
|
|
1214
|
+
:type version: int, optional
|
|
1215
|
+
:param hash: file hash for comparison
|
|
1216
|
+
:type hash: str, optional
|
|
1217
|
+
:param range: byte ranges to return
|
|
1218
|
+
:type range: str, optional
|
|
1219
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1220
|
+
:type x_accept_feature: list[str], optional
|
|
1221
|
+
:param async_: Perform the request asynchronously
|
|
1222
|
+
:type async_: bool, optional
|
|
1223
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1120
1224
|
"""
|
|
1121
1225
|
|
|
1122
1226
|
all_params = ['analysis_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1208,16 +1312,25 @@ class AnalysesApi(object):
|
|
|
1208
1312
|
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.
|
|
1209
1313
|
This method makes a synchronous HTTP request by default.
|
|
1210
1314
|
|
|
1211
|
-
:param
|
|
1212
|
-
:
|
|
1213
|
-
:param
|
|
1214
|
-
:
|
|
1215
|
-
:param
|
|
1216
|
-
:
|
|
1217
|
-
:param
|
|
1218
|
-
:
|
|
1219
|
-
:param
|
|
1220
|
-
:
|
|
1315
|
+
:param analysis_id: 24-character hex ID
|
|
1316
|
+
:type analysis_id: str
|
|
1317
|
+
:param filename: input filename
|
|
1318
|
+
:type filename: str
|
|
1319
|
+
:param info: get file info only, defaults to false
|
|
1320
|
+
:type info: bool, optional
|
|
1321
|
+
:param member: get zipfile member
|
|
1322
|
+
:type member: str, optional
|
|
1323
|
+
:param view: feature flag for view/download, defaults to false
|
|
1324
|
+
:type view: bool, optional
|
|
1325
|
+
:param range: byte ranges to return
|
|
1326
|
+
:type range: str, optional
|
|
1327
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1328
|
+
:type x_accept_feature: list[str], optional
|
|
1329
|
+
:param dest_file: Destination file path
|
|
1330
|
+
:type dest_file: str
|
|
1331
|
+
:param async_: Perform the request asynchronously
|
|
1332
|
+
:type async_: bool, optional
|
|
1333
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1221
1334
|
"""
|
|
1222
1335
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1223
1336
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1240,15 +1353,23 @@ class AnalysesApi(object):
|
|
|
1240
1353
|
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.
|
|
1241
1354
|
This method makes a synchronous HTTP request by default.
|
|
1242
1355
|
|
|
1243
|
-
:param
|
|
1244
|
-
:
|
|
1245
|
-
:param
|
|
1246
|
-
:
|
|
1247
|
-
:param
|
|
1248
|
-
:
|
|
1249
|
-
:param
|
|
1250
|
-
:
|
|
1251
|
-
:
|
|
1356
|
+
:param analysis_id: 24-character hex ID
|
|
1357
|
+
:type analysis_id: str
|
|
1358
|
+
:param filename: input filename
|
|
1359
|
+
:type filename: str
|
|
1360
|
+
:param info: get file info only, defaults to false
|
|
1361
|
+
:type info: bool, optional
|
|
1362
|
+
:param member: get zipfile member
|
|
1363
|
+
:type member: str, optional
|
|
1364
|
+
:param view: feature flag for view/download, defaults to false
|
|
1365
|
+
:type view: bool, optional
|
|
1366
|
+
:param range: byte ranges to return
|
|
1367
|
+
:type range: str, optional
|
|
1368
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1369
|
+
:type x_accept_feature: list[str], optional
|
|
1370
|
+
:param async_: Perform the request asynchronously
|
|
1371
|
+
:type async_: bool, optional
|
|
1372
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1252
1373
|
"""
|
|
1253
1374
|
|
|
1254
1375
|
all_params = ['analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1334,16 +1455,25 @@ class AnalysesApi(object):
|
|
|
1334
1455
|
Does not work on files whose names contain a forward slash.
|
|
1335
1456
|
This method makes a synchronous HTTP request by default.
|
|
1336
1457
|
|
|
1337
|
-
:param
|
|
1338
|
-
:
|
|
1339
|
-
:param
|
|
1340
|
-
:
|
|
1341
|
-
:param
|
|
1342
|
-
:
|
|
1343
|
-
:param
|
|
1344
|
-
:
|
|
1345
|
-
:param
|
|
1346
|
-
:
|
|
1458
|
+
:param analysis_id: 24-character hex ID
|
|
1459
|
+
:type analysis_id: str
|
|
1460
|
+
:param filename: input filename
|
|
1461
|
+
:type filename: str
|
|
1462
|
+
:param ticket: 24-char hex ticket id
|
|
1463
|
+
:type ticket: str, optional
|
|
1464
|
+
:param info: get file info only, defaults to false
|
|
1465
|
+
:type info: bool, optional
|
|
1466
|
+
:param member: get zipfile member
|
|
1467
|
+
:type member: str, optional
|
|
1468
|
+
:param view: feature flag for view/download, defaults to false
|
|
1469
|
+
:type view: bool, optional
|
|
1470
|
+
:param range: byte ranges to return
|
|
1471
|
+
:type range: str, optional
|
|
1472
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1473
|
+
:type x_accept_feature: list[str], optional
|
|
1474
|
+
:param async_: Perform the request asynchronously
|
|
1475
|
+
:type async_: bool, optional
|
|
1476
|
+
:rtype: FileZipInfo
|
|
1347
1477
|
"""
|
|
1348
1478
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1349
1479
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1367,16 +1497,25 @@ class AnalysesApi(object):
|
|
|
1367
1497
|
Does not work on files whose names contain a forward slash.
|
|
1368
1498
|
This method makes a synchronous HTTP request by default.
|
|
1369
1499
|
|
|
1370
|
-
:param
|
|
1371
|
-
:
|
|
1372
|
-
:param
|
|
1373
|
-
:
|
|
1374
|
-
:param
|
|
1375
|
-
:
|
|
1376
|
-
:param
|
|
1377
|
-
:
|
|
1378
|
-
:param
|
|
1379
|
-
:
|
|
1500
|
+
:param analysis_id: 24-character hex ID
|
|
1501
|
+
:type analysis_id: str
|
|
1502
|
+
:param filename: input filename
|
|
1503
|
+
:type filename: str
|
|
1504
|
+
:param ticket: 24-char hex ticket id
|
|
1505
|
+
:type ticket: str, optional
|
|
1506
|
+
:param info: get file info only, defaults to false
|
|
1507
|
+
:type info: bool, optional
|
|
1508
|
+
:param member: get zipfile member
|
|
1509
|
+
:type member: str, optional
|
|
1510
|
+
:param view: feature flag for view/download, defaults to false
|
|
1511
|
+
:type view: bool, optional
|
|
1512
|
+
:param range: byte ranges to return
|
|
1513
|
+
:type range: str, optional
|
|
1514
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1515
|
+
:type x_accept_feature: list[str], optional
|
|
1516
|
+
:param async_: Perform the request asynchronously
|
|
1517
|
+
:type async_: bool, optional
|
|
1518
|
+
:rtype: FileZipInfo
|
|
1380
1519
|
"""
|
|
1381
1520
|
|
|
1382
1521
|
all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1465,16 +1604,25 @@ class AnalysesApi(object):
|
|
|
1465
1604
|
|
|
1466
1605
|
This method makes a synchronous HTTP request by default.
|
|
1467
1606
|
|
|
1468
|
-
:param
|
|
1469
|
-
:
|
|
1470
|
-
:param
|
|
1471
|
-
:
|
|
1472
|
-
:param
|
|
1473
|
-
:
|
|
1474
|
-
:param
|
|
1475
|
-
:
|
|
1476
|
-
:param
|
|
1477
|
-
:
|
|
1607
|
+
:param analysis_id: 24-character hex ID
|
|
1608
|
+
:type analysis_id: str
|
|
1609
|
+
:param filename: input filename
|
|
1610
|
+
:type filename: str
|
|
1611
|
+
:param ticket: 24-char hex ticket id
|
|
1612
|
+
:type ticket: str, optional
|
|
1613
|
+
:param info: get file info only, defaults to false
|
|
1614
|
+
:type info: bool, optional
|
|
1615
|
+
:param member: get zipfile member
|
|
1616
|
+
:type member: str, optional
|
|
1617
|
+
:param view: feature flag for view/download, defaults to false
|
|
1618
|
+
:type view: bool, optional
|
|
1619
|
+
:param range: byte ranges to return
|
|
1620
|
+
:type range: str, optional
|
|
1621
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1622
|
+
:type x_accept_feature: list[str], optional
|
|
1623
|
+
:param async_: Perform the request asynchronously
|
|
1624
|
+
:type async_: bool, optional
|
|
1625
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1478
1626
|
"""
|
|
1479
1627
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1480
1628
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1497,16 +1645,25 @@ class AnalysesApi(object):
|
|
|
1497
1645
|
|
|
1498
1646
|
This method makes a synchronous HTTP request by default.
|
|
1499
1647
|
|
|
1500
|
-
:param
|
|
1501
|
-
:
|
|
1502
|
-
:param
|
|
1503
|
-
:
|
|
1504
|
-
:param
|
|
1505
|
-
:
|
|
1506
|
-
:param
|
|
1507
|
-
:
|
|
1508
|
-
:param
|
|
1509
|
-
:
|
|
1648
|
+
:param analysis_id: 24-character hex ID
|
|
1649
|
+
:type analysis_id: str
|
|
1650
|
+
:param filename: input filename
|
|
1651
|
+
:type filename: str
|
|
1652
|
+
:param ticket: 24-char hex ticket id
|
|
1653
|
+
:type ticket: str, optional
|
|
1654
|
+
:param info: get file info only, defaults to false
|
|
1655
|
+
:type info: bool, optional
|
|
1656
|
+
:param member: get zipfile member
|
|
1657
|
+
:type member: str, optional
|
|
1658
|
+
:param view: feature flag for view/download, defaults to false
|
|
1659
|
+
:type view: bool, optional
|
|
1660
|
+
:param range: byte ranges to return
|
|
1661
|
+
:type range: str, optional
|
|
1662
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1663
|
+
:type x_accept_feature: list[str], optional
|
|
1664
|
+
:param async_: Perform the request asynchronously
|
|
1665
|
+
:type async_: bool, optional
|
|
1666
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1510
1667
|
"""
|
|
1511
1668
|
|
|
1512
1669
|
all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1594,16 +1751,25 @@ class AnalysesApi(object):
|
|
|
1594
1751
|
Download output file from analysis
|
|
1595
1752
|
This method makes a synchronous HTTP request by default.
|
|
1596
1753
|
|
|
1597
|
-
:param
|
|
1598
|
-
:
|
|
1599
|
-
:param
|
|
1600
|
-
:
|
|
1601
|
-
:param
|
|
1602
|
-
:
|
|
1603
|
-
:param
|
|
1604
|
-
:
|
|
1605
|
-
:param
|
|
1606
|
-
:
|
|
1754
|
+
:param analysis_id: Container ID
|
|
1755
|
+
:type analysis_id: str
|
|
1756
|
+
:param filename: output file name
|
|
1757
|
+
:type filename: str
|
|
1758
|
+
:param info: get file info only, defaults to false
|
|
1759
|
+
:type info: bool, optional
|
|
1760
|
+
:param member: get zipfile member
|
|
1761
|
+
:type member: str, optional
|
|
1762
|
+
:param view: feature flag for view/download, defaults to false
|
|
1763
|
+
:type view: bool, optional
|
|
1764
|
+
:param range: byte ranges to return
|
|
1765
|
+
:type range: str, optional
|
|
1766
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1767
|
+
:type x_accept_feature: list[str], optional
|
|
1768
|
+
:param dest_file: Destination file path
|
|
1769
|
+
:type dest_file: str
|
|
1770
|
+
:param async_: Perform the request asynchronously
|
|
1771
|
+
:type async_: bool, optional
|
|
1772
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1607
1773
|
"""
|
|
1608
1774
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1609
1775
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1626,15 +1792,23 @@ class AnalysesApi(object):
|
|
|
1626
1792
|
Download output file from analysis
|
|
1627
1793
|
This method makes a synchronous HTTP request by default.
|
|
1628
1794
|
|
|
1629
|
-
:param
|
|
1630
|
-
:
|
|
1631
|
-
:param
|
|
1632
|
-
:
|
|
1633
|
-
:param
|
|
1634
|
-
:
|
|
1635
|
-
:param
|
|
1636
|
-
:
|
|
1637
|
-
:
|
|
1795
|
+
:param analysis_id: Container ID
|
|
1796
|
+
:type analysis_id: str
|
|
1797
|
+
:param filename: output file name
|
|
1798
|
+
:type filename: str
|
|
1799
|
+
:param info: get file info only, defaults to false
|
|
1800
|
+
:type info: bool, optional
|
|
1801
|
+
:param member: get zipfile member
|
|
1802
|
+
:type member: str, optional
|
|
1803
|
+
:param view: feature flag for view/download, defaults to false
|
|
1804
|
+
:type view: bool, optional
|
|
1805
|
+
:param range: byte ranges to return
|
|
1806
|
+
:type range: str, optional
|
|
1807
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1808
|
+
:type x_accept_feature: list[str], optional
|
|
1809
|
+
:param async_: Perform the request asynchronously
|
|
1810
|
+
:type async_: bool, optional
|
|
1811
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1638
1812
|
"""
|
|
1639
1813
|
|
|
1640
1814
|
all_params = ['analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1720,16 +1894,25 @@ class AnalysesApi(object):
|
|
|
1720
1894
|
Does not work on files whose names contain a forward slash.
|
|
1721
1895
|
This method makes a synchronous HTTP request by default.
|
|
1722
1896
|
|
|
1723
|
-
:param
|
|
1724
|
-
:
|
|
1725
|
-
:param
|
|
1726
|
-
:
|
|
1727
|
-
:param
|
|
1728
|
-
:
|
|
1729
|
-
:param
|
|
1730
|
-
:
|
|
1731
|
-
:param
|
|
1732
|
-
:
|
|
1897
|
+
:param analysis_id: Container ID
|
|
1898
|
+
:type analysis_id: str
|
|
1899
|
+
:param filename: output file name
|
|
1900
|
+
:type filename: str
|
|
1901
|
+
:param ticket: 24-char hex ticket id
|
|
1902
|
+
:type ticket: str, optional
|
|
1903
|
+
:param info: get file info only, defaults to false
|
|
1904
|
+
:type info: bool, optional
|
|
1905
|
+
:param member: get zipfile member
|
|
1906
|
+
:type member: str, optional
|
|
1907
|
+
:param view: feature flag for view/download, defaults to false
|
|
1908
|
+
:type view: bool, optional
|
|
1909
|
+
:param range: byte ranges to return
|
|
1910
|
+
:type range: str, optional
|
|
1911
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1912
|
+
:type x_accept_feature: list[str], optional
|
|
1913
|
+
:param async_: Perform the request asynchronously
|
|
1914
|
+
:type async_: bool, optional
|
|
1915
|
+
:rtype: FileZipInfo
|
|
1733
1916
|
"""
|
|
1734
1917
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1735
1918
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1753,16 +1936,25 @@ class AnalysesApi(object):
|
|
|
1753
1936
|
Does not work on files whose names contain a forward slash.
|
|
1754
1937
|
This method makes a synchronous HTTP request by default.
|
|
1755
1938
|
|
|
1756
|
-
:param
|
|
1757
|
-
:
|
|
1758
|
-
:param
|
|
1759
|
-
:
|
|
1760
|
-
:param
|
|
1761
|
-
:
|
|
1762
|
-
:param
|
|
1763
|
-
:
|
|
1764
|
-
:param
|
|
1765
|
-
:
|
|
1939
|
+
:param analysis_id: Container ID
|
|
1940
|
+
:type analysis_id: str
|
|
1941
|
+
:param filename: output file name
|
|
1942
|
+
:type filename: str
|
|
1943
|
+
:param ticket: 24-char hex ticket id
|
|
1944
|
+
:type ticket: str, optional
|
|
1945
|
+
:param info: get file info only, defaults to false
|
|
1946
|
+
:type info: bool, optional
|
|
1947
|
+
:param member: get zipfile member
|
|
1948
|
+
:type member: str, optional
|
|
1949
|
+
:param view: feature flag for view/download, defaults to false
|
|
1950
|
+
:type view: bool, optional
|
|
1951
|
+
:param range: byte ranges to return
|
|
1952
|
+
:type range: str, optional
|
|
1953
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1954
|
+
:type x_accept_feature: list[str], optional
|
|
1955
|
+
:param async_: Perform the request asynchronously
|
|
1956
|
+
:type async_: bool, optional
|
|
1957
|
+
:rtype: FileZipInfo
|
|
1766
1958
|
"""
|
|
1767
1959
|
|
|
1768
1960
|
all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1851,16 +2043,25 @@ class AnalysesApi(object):
|
|
|
1851
2043
|
|
|
1852
2044
|
This method makes a synchronous HTTP request by default.
|
|
1853
2045
|
|
|
1854
|
-
:param
|
|
1855
|
-
:
|
|
1856
|
-
:param
|
|
1857
|
-
:
|
|
1858
|
-
:param
|
|
1859
|
-
:
|
|
1860
|
-
:param
|
|
1861
|
-
:
|
|
1862
|
-
:param
|
|
1863
|
-
:
|
|
2046
|
+
:param analysis_id: Container ID
|
|
2047
|
+
:type analysis_id: str
|
|
2048
|
+
:param filename: output file name
|
|
2049
|
+
:type filename: str
|
|
2050
|
+
:param ticket: 24-char hex ticket id
|
|
2051
|
+
:type ticket: str, optional
|
|
2052
|
+
:param info: get file info only, defaults to false
|
|
2053
|
+
:type info: bool, optional
|
|
2054
|
+
:param member: get zipfile member
|
|
2055
|
+
:type member: str, optional
|
|
2056
|
+
:param view: feature flag for view/download, defaults to false
|
|
2057
|
+
:type view: bool, optional
|
|
2058
|
+
:param range: byte ranges to return
|
|
2059
|
+
:type range: str, optional
|
|
2060
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2061
|
+
:type x_accept_feature: list[str], optional
|
|
2062
|
+
:param async_: Perform the request asynchronously
|
|
2063
|
+
:type async_: bool, optional
|
|
2064
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1864
2065
|
"""
|
|
1865
2066
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1866
2067
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1883,16 +2084,25 @@ class AnalysesApi(object):
|
|
|
1883
2084
|
|
|
1884
2085
|
This method makes a synchronous HTTP request by default.
|
|
1885
2086
|
|
|
1886
|
-
:param
|
|
1887
|
-
:
|
|
1888
|
-
:param
|
|
1889
|
-
:
|
|
1890
|
-
:param
|
|
1891
|
-
:
|
|
1892
|
-
:param
|
|
1893
|
-
:
|
|
1894
|
-
:param
|
|
1895
|
-
:
|
|
2087
|
+
:param analysis_id: Container ID
|
|
2088
|
+
:type analysis_id: str
|
|
2089
|
+
:param filename: output file name
|
|
2090
|
+
:type filename: str
|
|
2091
|
+
:param ticket: 24-char hex ticket id
|
|
2092
|
+
:type ticket: str, optional
|
|
2093
|
+
:param info: get file info only, defaults to false
|
|
2094
|
+
:type info: bool, optional
|
|
2095
|
+
:param member: get zipfile member
|
|
2096
|
+
:type member: str, optional
|
|
2097
|
+
:param view: feature flag for view/download, defaults to false
|
|
2098
|
+
:type view: bool, optional
|
|
2099
|
+
:param range: byte ranges to return
|
|
2100
|
+
:type range: str, optional
|
|
2101
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
2102
|
+
:type x_accept_feature: list[str], optional
|
|
2103
|
+
:param async_: Perform the request asynchronously
|
|
2104
|
+
:type async_: bool, optional
|
|
2105
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1896
2106
|
"""
|
|
1897
2107
|
|
|
1898
2108
|
all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
@@ -1980,17 +2190,27 @@ class AnalysesApi(object):
|
|
|
1980
2190
|
Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
|
|
1981
2191
|
This method makes a synchronous HTTP request by default.
|
|
1982
2192
|
|
|
1983
|
-
:param
|
|
1984
|
-
:
|
|
1985
|
-
:param
|
|
1986
|
-
:
|
|
1987
|
-
:param
|
|
1988
|
-
:
|
|
1989
|
-
:param
|
|
1990
|
-
:
|
|
1991
|
-
:param
|
|
1992
|
-
:
|
|
1993
|
-
:
|
|
2193
|
+
:param inflate_job: Return job as an object instead of an id, defaults to false
|
|
2194
|
+
:type inflate_job: bool, optional
|
|
2195
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
2196
|
+
:type include_all_info: bool, optional
|
|
2197
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
2198
|
+
:type filter: str, optional
|
|
2199
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2200
|
+
:type sort: str, optional
|
|
2201
|
+
:param limit: The maximum number of entries to return.
|
|
2202
|
+
:type limit: int, optional
|
|
2203
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2204
|
+
:type skip: int, optional
|
|
2205
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2206
|
+
:type page: int, optional
|
|
2207
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2208
|
+
:type after_id: str, optional
|
|
2209
|
+
:param x_accept_feature:, defaults to []
|
|
2210
|
+
:type x_accept_feature: list[str], optional
|
|
2211
|
+
:param async_: Perform the request asynchronously
|
|
2212
|
+
:type async_: bool, optional
|
|
2213
|
+
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
1994
2214
|
"""
|
|
1995
2215
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1996
2216
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2014,17 +2234,27 @@ class AnalysesApi(object):
|
|
|
2014
2234
|
Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
|
|
2015
2235
|
This method makes a synchronous HTTP request by default.
|
|
2016
2236
|
|
|
2017
|
-
:param
|
|
2018
|
-
:
|
|
2019
|
-
:param
|
|
2020
|
-
:
|
|
2021
|
-
:param
|
|
2022
|
-
:
|
|
2023
|
-
:param
|
|
2024
|
-
:
|
|
2025
|
-
:param
|
|
2026
|
-
:
|
|
2027
|
-
:
|
|
2237
|
+
:param inflate_job: Return job as an object instead of an id, defaults to false
|
|
2238
|
+
:type inflate_job: bool, optional
|
|
2239
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
2240
|
+
:type include_all_info: bool, optional
|
|
2241
|
+
:param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
|
|
2242
|
+
:type filter: str, optional
|
|
2243
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2244
|
+
:type sort: str, optional
|
|
2245
|
+
:param limit: The maximum number of entries to return.
|
|
2246
|
+
:type limit: int, optional
|
|
2247
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2248
|
+
:type skip: int, optional
|
|
2249
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2250
|
+
:type page: int, optional
|
|
2251
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2252
|
+
:type after_id: str, optional
|
|
2253
|
+
:param x_accept_feature:, defaults to []
|
|
2254
|
+
:type x_accept_feature: list[str], optional
|
|
2255
|
+
:param async_: Perform the request asynchronously
|
|
2256
|
+
:type async_: bool, optional
|
|
2257
|
+
:rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
2028
2258
|
"""
|
|
2029
2259
|
|
|
2030
2260
|
all_params = ['inflate_job','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -2106,11 +2336,15 @@ class AnalysesApi(object):
|
|
|
2106
2336
|
Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: `projects/{ProjectId}/acquisitions/analyses` will return any analyses that have an acquisition that is under that project as a parent. The `all` keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.
|
|
2107
2337
|
This method makes a synchronous HTTP request by default.
|
|
2108
2338
|
|
|
2109
|
-
:param
|
|
2110
|
-
:
|
|
2111
|
-
:param
|
|
2112
|
-
:
|
|
2113
|
-
:
|
|
2339
|
+
:param container_name: The parent container type
|
|
2340
|
+
:type container_name: str
|
|
2341
|
+
:param container_id: The parent container id
|
|
2342
|
+
:type container_id: str
|
|
2343
|
+
:param subcontainer_name: The sub container type
|
|
2344
|
+
:type subcontainer_name: str
|
|
2345
|
+
:param async_: Perform the request asynchronously
|
|
2346
|
+
:type async_: bool, optional
|
|
2347
|
+
:rtype: list[AnalysisListOutput]
|
|
2114
2348
|
"""
|
|
2115
2349
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2116
2350
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2134,11 +2368,15 @@ class AnalysesApi(object):
|
|
|
2134
2368
|
Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: `projects/{ProjectId}/acquisitions/analyses` will return any analyses that have an acquisition that is under that project as a parent. The `all` keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.
|
|
2135
2369
|
This method makes a synchronous HTTP request by default.
|
|
2136
2370
|
|
|
2137
|
-
:param
|
|
2138
|
-
:
|
|
2139
|
-
:param
|
|
2140
|
-
:
|
|
2141
|
-
:
|
|
2371
|
+
:param container_name: The parent container type
|
|
2372
|
+
:type container_name: str
|
|
2373
|
+
:param container_id: The parent container id
|
|
2374
|
+
:type container_id: str
|
|
2375
|
+
:param subcontainer_name: The sub container type
|
|
2376
|
+
:type subcontainer_name: str
|
|
2377
|
+
:param async_: Perform the request asynchronously
|
|
2378
|
+
:type async_: bool, optional
|
|
2379
|
+
:rtype: list[AnalysisListOutput]
|
|
2142
2380
|
"""
|
|
2143
2381
|
|
|
2144
2382
|
all_params = ['container_name','container_id','subcontainer_name',] # noqa: E501
|
|
@@ -2219,12 +2457,17 @@ class AnalysesApi(object):
|
|
|
2219
2457
|
Get an analysis by its id
|
|
2220
2458
|
This method makes a synchronous HTTP request by default.
|
|
2221
2459
|
|
|
2222
|
-
:param
|
|
2223
|
-
:
|
|
2224
|
-
:param
|
|
2225
|
-
:
|
|
2226
|
-
:param
|
|
2227
|
-
:
|
|
2460
|
+
:param analysis_id: 24-char hex analysis id
|
|
2461
|
+
:type analysis_id: str
|
|
2462
|
+
:param inflate_job: expand job info, defaults to false
|
|
2463
|
+
:type inflate_job: bool, optional
|
|
2464
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
2465
|
+
:type join_avatars: bool, optional
|
|
2466
|
+
:param join:
|
|
2467
|
+
:type join: JoinType, optional
|
|
2468
|
+
:param async_: Perform the request asynchronously
|
|
2469
|
+
:type async_: bool, optional
|
|
2470
|
+
:rtype: union[AnalysisOutput,AnalysisOutputInflatedJob]
|
|
2228
2471
|
"""
|
|
2229
2472
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2230
2473
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2248,12 +2491,17 @@ class AnalysesApi(object):
|
|
|
2248
2491
|
Get an analysis by its id
|
|
2249
2492
|
This method makes a synchronous HTTP request by default.
|
|
2250
2493
|
|
|
2251
|
-
:param
|
|
2252
|
-
:
|
|
2253
|
-
:param
|
|
2254
|
-
:
|
|
2255
|
-
:param
|
|
2256
|
-
:
|
|
2494
|
+
:param analysis_id: 24-char hex analysis id
|
|
2495
|
+
:type analysis_id: str
|
|
2496
|
+
:param inflate_job: expand job info, defaults to false
|
|
2497
|
+
:type inflate_job: bool, optional
|
|
2498
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
2499
|
+
:type join_avatars: bool, optional
|
|
2500
|
+
:param join:
|
|
2501
|
+
:type join: JoinType, optional
|
|
2502
|
+
:param async_: Perform the request asynchronously
|
|
2503
|
+
:type async_: bool, optional
|
|
2504
|
+
:rtype: union[AnalysisOutput,AnalysisOutputInflatedJob]
|
|
2257
2505
|
"""
|
|
2258
2506
|
|
|
2259
2507
|
all_params = ['analysis_id','inflate_job','join_avatars','join',] # noqa: E501
|
|
@@ -2330,10 +2578,13 @@ class AnalysesApi(object):
|
|
|
2330
2578
|
Get metadata for an input file of an analysis.
|
|
2331
2579
|
This method makes a synchronous HTTP request by default.
|
|
2332
2580
|
|
|
2333
|
-
:param
|
|
2334
|
-
:
|
|
2335
|
-
:param
|
|
2336
|
-
:
|
|
2581
|
+
:param container_id: Container Id
|
|
2582
|
+
:type container_id: str
|
|
2583
|
+
:param filename:
|
|
2584
|
+
:type filename: str
|
|
2585
|
+
:param async_: Perform the request asynchronously
|
|
2586
|
+
:type async_: bool, optional
|
|
2587
|
+
:rtype: FileOutput
|
|
2337
2588
|
"""
|
|
2338
2589
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2339
2590
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2357,10 +2608,13 @@ class AnalysesApi(object):
|
|
|
2357
2608
|
Get metadata for an input file of an analysis.
|
|
2358
2609
|
This method makes a synchronous HTTP request by default.
|
|
2359
2610
|
|
|
2360
|
-
:param
|
|
2361
|
-
:
|
|
2362
|
-
:param
|
|
2363
|
-
:
|
|
2611
|
+
:param container_id: Container Id
|
|
2612
|
+
:type container_id: str
|
|
2613
|
+
:param filename:
|
|
2614
|
+
:type filename: str
|
|
2615
|
+
:param async_: Perform the request asynchronously
|
|
2616
|
+
:type async_: bool, optional
|
|
2617
|
+
:rtype: FileOutput
|
|
2364
2618
|
"""
|
|
2365
2619
|
|
|
2366
2620
|
all_params = ['container_id','filename',] # noqa: E501
|
|
@@ -2435,10 +2689,13 @@ class AnalysesApi(object):
|
|
|
2435
2689
|
Get metadata for input file(s) for an analysis. There may be more than one since input filenames are not guaranteed to be unique.
|
|
2436
2690
|
This method makes a synchronous HTTP request by default.
|
|
2437
2691
|
|
|
2438
|
-
:param
|
|
2439
|
-
:
|
|
2440
|
-
:param
|
|
2441
|
-
:
|
|
2692
|
+
:param container_id: Container Id
|
|
2693
|
+
:type container_id: str
|
|
2694
|
+
:param filename:
|
|
2695
|
+
:type filename: str
|
|
2696
|
+
:param async_: Perform the request asynchronously
|
|
2697
|
+
:type async_: bool, optional
|
|
2698
|
+
:rtype: list[FileOutput]
|
|
2442
2699
|
"""
|
|
2443
2700
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2444
2701
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2462,10 +2719,13 @@ class AnalysesApi(object):
|
|
|
2462
2719
|
Get metadata for input file(s) for an analysis. There may be more than one since input filenames are not guaranteed to be unique.
|
|
2463
2720
|
This method makes a synchronous HTTP request by default.
|
|
2464
2721
|
|
|
2465
|
-
:param
|
|
2466
|
-
:
|
|
2467
|
-
:param
|
|
2468
|
-
:
|
|
2722
|
+
:param container_id: Container Id
|
|
2723
|
+
:type container_id: str
|
|
2724
|
+
:param filename:
|
|
2725
|
+
:type filename: str
|
|
2726
|
+
:param async_: Perform the request asynchronously
|
|
2727
|
+
:type async_: bool, optional
|
|
2728
|
+
:rtype: list[FileOutput]
|
|
2469
2729
|
"""
|
|
2470
2730
|
|
|
2471
2731
|
all_params = ['container_id','filename',] # noqa: E501
|
|
@@ -2540,10 +2800,13 @@ class AnalysesApi(object):
|
|
|
2540
2800
|
Get a note of a(n) analysis
|
|
2541
2801
|
This method makes a synchronous HTTP request by default.
|
|
2542
2802
|
|
|
2543
|
-
:param
|
|
2544
|
-
:
|
|
2545
|
-
:param
|
|
2546
|
-
:
|
|
2803
|
+
:param container_id:
|
|
2804
|
+
:type container_id: str
|
|
2805
|
+
:param note_id:
|
|
2806
|
+
:type note_id: str
|
|
2807
|
+
:param async_: Perform the request asynchronously
|
|
2808
|
+
:type async_: bool, optional
|
|
2809
|
+
:rtype: Note
|
|
2547
2810
|
"""
|
|
2548
2811
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2549
2812
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2567,10 +2830,13 @@ class AnalysesApi(object):
|
|
|
2567
2830
|
Get a note of a(n) analysis
|
|
2568
2831
|
This method makes a synchronous HTTP request by default.
|
|
2569
2832
|
|
|
2570
|
-
:param
|
|
2571
|
-
:
|
|
2572
|
-
:param
|
|
2573
|
-
:
|
|
2833
|
+
:param container_id:
|
|
2834
|
+
:type container_id: str
|
|
2835
|
+
:param note_id:
|
|
2836
|
+
:type note_id: str
|
|
2837
|
+
:param async_: Perform the request asynchronously
|
|
2838
|
+
:type async_: bool, optional
|
|
2839
|
+
:rtype: Note
|
|
2574
2840
|
"""
|
|
2575
2841
|
|
|
2576
2842
|
all_params = ['container_id','note_id',] # noqa: E501
|
|
@@ -2645,11 +2911,15 @@ class AnalysesApi(object):
|
|
|
2645
2911
|
Get metadata for an output file of an analysis.
|
|
2646
2912
|
This method makes a synchronous HTTP request by default.
|
|
2647
2913
|
|
|
2648
|
-
:param
|
|
2649
|
-
:
|
|
2650
|
-
:param
|
|
2651
|
-
:
|
|
2652
|
-
:
|
|
2914
|
+
:param cid: Container Id
|
|
2915
|
+
:type cid: str
|
|
2916
|
+
:param filename:
|
|
2917
|
+
:type filename: str
|
|
2918
|
+
:param ctype:
|
|
2919
|
+
:type ctype: FileContainerType, optional
|
|
2920
|
+
:param async_: Perform the request asynchronously
|
|
2921
|
+
:type async_: bool, optional
|
|
2922
|
+
:rtype: FileOutput
|
|
2653
2923
|
"""
|
|
2654
2924
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2655
2925
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2673,11 +2943,15 @@ class AnalysesApi(object):
|
|
|
2673
2943
|
Get metadata for an output file of an analysis.
|
|
2674
2944
|
This method makes a synchronous HTTP request by default.
|
|
2675
2945
|
|
|
2676
|
-
:param
|
|
2677
|
-
:
|
|
2678
|
-
:param
|
|
2679
|
-
:
|
|
2680
|
-
:
|
|
2946
|
+
:param cid: Container Id
|
|
2947
|
+
:type cid: str
|
|
2948
|
+
:param filename:
|
|
2949
|
+
:type filename: str
|
|
2950
|
+
:param ctype:
|
|
2951
|
+
:type ctype: FileContainerType, optional
|
|
2952
|
+
:param async_: Perform the request asynchronously
|
|
2953
|
+
:type async_: bool, optional
|
|
2954
|
+
:rtype: FileOutput
|
|
2681
2955
|
"""
|
|
2682
2956
|
|
|
2683
2957
|
all_params = ['cid','filename','ctype',] # noqa: E501
|
|
@@ -2754,10 +3028,13 @@ class AnalysesApi(object):
|
|
|
2754
3028
|
Get the value of a tag, by name
|
|
2755
3029
|
This method makes a synchronous HTTP request by default.
|
|
2756
3030
|
|
|
2757
|
-
:param
|
|
2758
|
-
:
|
|
2759
|
-
:param
|
|
2760
|
-
:
|
|
3031
|
+
:param container_id:
|
|
3032
|
+
:type container_id: str
|
|
3033
|
+
:param value: The tag to interact with
|
|
3034
|
+
:type value: str
|
|
3035
|
+
:param async_: Perform the request asynchronously
|
|
3036
|
+
:type async_: bool, optional
|
|
3037
|
+
:rtype: str
|
|
2761
3038
|
"""
|
|
2762
3039
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2763
3040
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2781,10 +3058,13 @@ class AnalysesApi(object):
|
|
|
2781
3058
|
Get the value of a tag, by name
|
|
2782
3059
|
This method makes a synchronous HTTP request by default.
|
|
2783
3060
|
|
|
2784
|
-
:param
|
|
2785
|
-
:
|
|
2786
|
-
:param
|
|
2787
|
-
:
|
|
3061
|
+
:param container_id:
|
|
3062
|
+
:type container_id: str
|
|
3063
|
+
:param value: The tag to interact with
|
|
3064
|
+
:type value: str
|
|
3065
|
+
:param async_: Perform the request asynchronously
|
|
3066
|
+
:type async_: bool, optional
|
|
3067
|
+
:rtype: str
|
|
2788
3068
|
"""
|
|
2789
3069
|
|
|
2790
3070
|
all_params = ['container_id','value',] # noqa: E501
|
|
@@ -2859,10 +3139,13 @@ class AnalysesApi(object):
|
|
|
2859
3139
|
Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session
|
|
2860
3140
|
This method makes a synchronous HTTP request by default.
|
|
2861
3141
|
|
|
2862
|
-
:param
|
|
2863
|
-
:
|
|
2864
|
-
:param
|
|
2865
|
-
:
|
|
3142
|
+
:param analysis_id: 24-char hex analysis id
|
|
3143
|
+
:type analysis_id: str
|
|
3144
|
+
:param body:
|
|
3145
|
+
:type body: AnalysisModifyInput
|
|
3146
|
+
:param async_: Perform the request asynchronously
|
|
3147
|
+
:type async_: bool, optional
|
|
3148
|
+
:rtype: ModifiedResult
|
|
2866
3149
|
"""
|
|
2867
3150
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2868
3151
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2886,10 +3169,13 @@ class AnalysesApi(object):
|
|
|
2886
3169
|
Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session
|
|
2887
3170
|
This method makes a synchronous HTTP request by default.
|
|
2888
3171
|
|
|
2889
|
-
:param
|
|
2890
|
-
:
|
|
2891
|
-
:param
|
|
2892
|
-
:
|
|
3172
|
+
:param analysis_id: 24-char hex analysis id
|
|
3173
|
+
:type analysis_id: str
|
|
3174
|
+
:param body:
|
|
3175
|
+
:type body: AnalysisModifyInput
|
|
3176
|
+
:param async_: Perform the request asynchronously
|
|
3177
|
+
:type async_: bool, optional
|
|
3178
|
+
:rtype: ModifiedResult
|
|
2893
3179
|
"""
|
|
2894
3180
|
|
|
2895
3181
|
all_params = ['analysis_id','body',] # noqa: E501
|
|
@@ -2975,11 +3261,15 @@ class AnalysesApi(object):
|
|
|
2975
3261
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2976
3262
|
This method makes a synchronous HTTP request by default.
|
|
2977
3263
|
|
|
2978
|
-
:param
|
|
2979
|
-
:
|
|
2980
|
-
:param
|
|
2981
|
-
:
|
|
2982
|
-
:
|
|
3264
|
+
:param cid:
|
|
3265
|
+
:type cid: str
|
|
3266
|
+
:param filename:
|
|
3267
|
+
:type filename: str
|
|
3268
|
+
:param body:
|
|
3269
|
+
:type body: FileModifyInput
|
|
3270
|
+
:param async_: Perform the request asynchronously
|
|
3271
|
+
:type async_: bool, optional
|
|
3272
|
+
:rtype: ModifiedResult
|
|
2983
3273
|
"""
|
|
2984
3274
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2985
3275
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3003,11 +3293,15 @@ class AnalysesApi(object):
|
|
|
3003
3293
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3004
3294
|
This method makes a synchronous HTTP request by default.
|
|
3005
3295
|
|
|
3006
|
-
:param
|
|
3007
|
-
:
|
|
3008
|
-
:param
|
|
3009
|
-
:
|
|
3010
|
-
:
|
|
3296
|
+
:param cid:
|
|
3297
|
+
:type cid: str
|
|
3298
|
+
:param filename:
|
|
3299
|
+
:type filename: str
|
|
3300
|
+
:param body:
|
|
3301
|
+
:type body: FileModifyInput
|
|
3302
|
+
:param async_: Perform the request asynchronously
|
|
3303
|
+
:type async_: bool, optional
|
|
3304
|
+
:rtype: ModifiedResult
|
|
3011
3305
|
"""
|
|
3012
3306
|
|
|
3013
3307
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3099,11 +3393,15 @@ class AnalysesApi(object):
|
|
|
3099
3393
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3100
3394
|
This method makes a synchronous HTTP request by default.
|
|
3101
3395
|
|
|
3102
|
-
:param
|
|
3103
|
-
:
|
|
3104
|
-
:param
|
|
3105
|
-
:
|
|
3106
|
-
:
|
|
3396
|
+
:param cid:
|
|
3397
|
+
:type cid: str
|
|
3398
|
+
:param filename:
|
|
3399
|
+
:type filename: str
|
|
3400
|
+
:param body:
|
|
3401
|
+
:type body: FileClassificationDelta
|
|
3402
|
+
:param async_: Perform the request asynchronously
|
|
3403
|
+
:type async_: bool, optional
|
|
3404
|
+
:rtype: ModifiedResult
|
|
3107
3405
|
"""
|
|
3108
3406
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3109
3407
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3127,11 +3425,15 @@ class AnalysesApi(object):
|
|
|
3127
3425
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3128
3426
|
This method makes a synchronous HTTP request by default.
|
|
3129
3427
|
|
|
3130
|
-
:param
|
|
3131
|
-
:
|
|
3132
|
-
:param
|
|
3133
|
-
:
|
|
3134
|
-
:
|
|
3428
|
+
:param cid:
|
|
3429
|
+
:type cid: str
|
|
3430
|
+
:param filename:
|
|
3431
|
+
:type filename: str
|
|
3432
|
+
:param body:
|
|
3433
|
+
:type body: FileClassificationDelta
|
|
3434
|
+
:param async_: Perform the request asynchronously
|
|
3435
|
+
:type async_: bool, optional
|
|
3436
|
+
:rtype: ModifiedResult
|
|
3135
3437
|
"""
|
|
3136
3438
|
|
|
3137
3439
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3223,11 +3525,15 @@ class AnalysesApi(object):
|
|
|
3223
3525
|
Modify and return the file 'info' field
|
|
3224
3526
|
This method makes a synchronous HTTP request by default.
|
|
3225
3527
|
|
|
3226
|
-
:param
|
|
3227
|
-
:
|
|
3228
|
-
:param
|
|
3229
|
-
:
|
|
3230
|
-
:
|
|
3528
|
+
:param cid:
|
|
3529
|
+
:type cid: str
|
|
3530
|
+
:param filename:
|
|
3531
|
+
:type filename: str
|
|
3532
|
+
:param body:
|
|
3533
|
+
:type body: Info
|
|
3534
|
+
:param async_: Perform the request asynchronously
|
|
3535
|
+
:type async_: bool, optional
|
|
3536
|
+
:rtype: ModifiedResult
|
|
3231
3537
|
"""
|
|
3232
3538
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3233
3539
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3251,11 +3557,15 @@ class AnalysesApi(object):
|
|
|
3251
3557
|
Modify and return the file 'info' field
|
|
3252
3558
|
This method makes a synchronous HTTP request by default.
|
|
3253
3559
|
|
|
3254
|
-
:param
|
|
3255
|
-
:
|
|
3256
|
-
:param
|
|
3257
|
-
:
|
|
3258
|
-
:
|
|
3560
|
+
:param cid:
|
|
3561
|
+
:type cid: str
|
|
3562
|
+
:param filename:
|
|
3563
|
+
:type filename: str
|
|
3564
|
+
:param body:
|
|
3565
|
+
:type body: Info
|
|
3566
|
+
:param async_: Perform the request asynchronously
|
|
3567
|
+
:type async_: bool, optional
|
|
3568
|
+
:rtype: ModifiedResult
|
|
3259
3569
|
"""
|
|
3260
3570
|
|
|
3261
3571
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3347,10 +3657,13 @@ class AnalysesApi(object):
|
|
|
3347
3657
|
Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
3348
3658
|
This method makes a synchronous HTTP request by default.
|
|
3349
3659
|
|
|
3350
|
-
:param
|
|
3351
|
-
:
|
|
3352
|
-
:param
|
|
3353
|
-
:
|
|
3660
|
+
:param container_id:
|
|
3661
|
+
:type container_id: str
|
|
3662
|
+
:param body:
|
|
3663
|
+
:type body: Info
|
|
3664
|
+
:param async_: Perform the request asynchronously
|
|
3665
|
+
:type async_: bool, optional
|
|
3666
|
+
:rtype: ModifiedResult
|
|
3354
3667
|
"""
|
|
3355
3668
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3356
3669
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3374,10 +3687,13 @@ class AnalysesApi(object):
|
|
|
3374
3687
|
Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
3375
3688
|
This method makes a synchronous HTTP request by default.
|
|
3376
3689
|
|
|
3377
|
-
:param
|
|
3378
|
-
:
|
|
3379
|
-
:param
|
|
3380
|
-
:
|
|
3690
|
+
:param container_id:
|
|
3691
|
+
:type container_id: str
|
|
3692
|
+
:param body:
|
|
3693
|
+
:type body: Info
|
|
3694
|
+
:param async_: Perform the request asynchronously
|
|
3695
|
+
:type async_: bool, optional
|
|
3696
|
+
:rtype: ModifiedResult
|
|
3381
3697
|
"""
|
|
3382
3698
|
|
|
3383
3699
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -3463,11 +3779,15 @@ class AnalysesApi(object):
|
|
|
3463
3779
|
Update a note of a(n) analysis
|
|
3464
3780
|
This method makes a synchronous HTTP request by default.
|
|
3465
3781
|
|
|
3466
|
-
:param
|
|
3467
|
-
:
|
|
3468
|
-
:param
|
|
3469
|
-
:
|
|
3470
|
-
:
|
|
3782
|
+
:param container_id:
|
|
3783
|
+
:type container_id: str
|
|
3784
|
+
:param note_id:
|
|
3785
|
+
:type note_id: str
|
|
3786
|
+
:param body:
|
|
3787
|
+
:type body: NoteInput
|
|
3788
|
+
:param async_: Perform the request asynchronously
|
|
3789
|
+
:type async_: bool, optional
|
|
3790
|
+
:rtype: int
|
|
3471
3791
|
"""
|
|
3472
3792
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3473
3793
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3491,11 +3811,15 @@ class AnalysesApi(object):
|
|
|
3491
3811
|
Update a note of a(n) analysis
|
|
3492
3812
|
This method makes a synchronous HTTP request by default.
|
|
3493
3813
|
|
|
3494
|
-
:param
|
|
3495
|
-
:
|
|
3496
|
-
:param
|
|
3497
|
-
:
|
|
3498
|
-
:
|
|
3814
|
+
:param container_id:
|
|
3815
|
+
:type container_id: str
|
|
3816
|
+
:param note_id:
|
|
3817
|
+
:type note_id: str
|
|
3818
|
+
:param body:
|
|
3819
|
+
:type body: NoteInput
|
|
3820
|
+
:param async_: Perform the request asynchronously
|
|
3821
|
+
:type async_: bool, optional
|
|
3822
|
+
:rtype: int
|
|
3499
3823
|
"""
|
|
3500
3824
|
|
|
3501
3825
|
all_params = ['container_id','note_id','body',] # noqa: E501
|
|
@@ -3587,11 +3911,15 @@ class AnalysesApi(object):
|
|
|
3587
3911
|
Rename a tag
|
|
3588
3912
|
This method makes a synchronous HTTP request by default.
|
|
3589
3913
|
|
|
3590
|
-
:param
|
|
3591
|
-
:
|
|
3592
|
-
:param
|
|
3593
|
-
:
|
|
3594
|
-
:
|
|
3914
|
+
:param container_id:
|
|
3915
|
+
:type container_id: str
|
|
3916
|
+
:param value: The tag to interact with
|
|
3917
|
+
:type value: str
|
|
3918
|
+
:param body:
|
|
3919
|
+
:type body: Tag
|
|
3920
|
+
:param async_: Perform the request asynchronously
|
|
3921
|
+
:type async_: bool, optional
|
|
3922
|
+
:rtype: str
|
|
3595
3923
|
"""
|
|
3596
3924
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3597
3925
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3615,11 +3943,15 @@ class AnalysesApi(object):
|
|
|
3615
3943
|
Rename a tag
|
|
3616
3944
|
This method makes a synchronous HTTP request by default.
|
|
3617
3945
|
|
|
3618
|
-
:param
|
|
3619
|
-
:
|
|
3620
|
-
:param
|
|
3621
|
-
:
|
|
3622
|
-
:
|
|
3946
|
+
:param container_id:
|
|
3947
|
+
:type container_id: str
|
|
3948
|
+
:param value: The tag to interact with
|
|
3949
|
+
:type value: str
|
|
3950
|
+
:param body:
|
|
3951
|
+
:type body: Tag
|
|
3952
|
+
:param async_: Perform the request asynchronously
|
|
3953
|
+
:type async_: bool, optional
|
|
3954
|
+
:rtype: str
|
|
3623
3955
|
"""
|
|
3624
3956
|
|
|
3625
3957
|
all_params = ['container_id','value','body',] # noqa: E501
|
|
@@ -3711,18 +4043,29 @@ class AnalysesApi(object):
|
|
|
3711
4043
|
Upload an output file to an analysis
|
|
3712
4044
|
This method makes a synchronous HTTP request by default.
|
|
3713
4045
|
|
|
3714
|
-
:param
|
|
3715
|
-
:
|
|
3716
|
-
:param
|
|
3717
|
-
:
|
|
3718
|
-
:param
|
|
3719
|
-
:
|
|
3720
|
-
:param
|
|
3721
|
-
:
|
|
3722
|
-
:param
|
|
3723
|
-
:
|
|
3724
|
-
:param
|
|
3725
|
-
:
|
|
4046
|
+
:param container_id:
|
|
4047
|
+
:type container_id: str
|
|
4048
|
+
:param file: The file to upload
|
|
4049
|
+
:type file: str
|
|
4050
|
+
:param ticket:
|
|
4051
|
+
:type ticket: str, optional
|
|
4052
|
+
:param preserve_metadata:, defaults to false
|
|
4053
|
+
:type preserve_metadata: bool, optional
|
|
4054
|
+
:param id:
|
|
4055
|
+
:type id: str, optional
|
|
4056
|
+
:param level:
|
|
4057
|
+
:type level: ContainerType, optional
|
|
4058
|
+
:param job:
|
|
4059
|
+
:type job: str, optional
|
|
4060
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4061
|
+
:type metadata: object, optional
|
|
4062
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
4063
|
+
:type x_accept_feature: list[str], optional
|
|
4064
|
+
:param content_type:
|
|
4065
|
+
:type content_type: str, optional
|
|
4066
|
+
:param async_: Perform the request asynchronously
|
|
4067
|
+
:type async_: bool, optional
|
|
4068
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
3726
4069
|
"""
|
|
3727
4070
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3728
4071
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3746,18 +4089,29 @@ class AnalysesApi(object):
|
|
|
3746
4089
|
Upload an output file to an analysis
|
|
3747
4090
|
This method makes a synchronous HTTP request by default.
|
|
3748
4091
|
|
|
3749
|
-
:param
|
|
3750
|
-
:
|
|
3751
|
-
:param
|
|
3752
|
-
:
|
|
3753
|
-
:param
|
|
3754
|
-
:
|
|
3755
|
-
:param
|
|
3756
|
-
:
|
|
3757
|
-
:param
|
|
3758
|
-
:
|
|
3759
|
-
:param
|
|
3760
|
-
:
|
|
4092
|
+
:param container_id:
|
|
4093
|
+
:type container_id: str
|
|
4094
|
+
:param file: The file to upload
|
|
4095
|
+
:type file: str
|
|
4096
|
+
:param ticket:
|
|
4097
|
+
:type ticket: str, optional
|
|
4098
|
+
:param preserve_metadata:, defaults to false
|
|
4099
|
+
:type preserve_metadata: bool, optional
|
|
4100
|
+
:param id:
|
|
4101
|
+
:type id: str, optional
|
|
4102
|
+
:param level:
|
|
4103
|
+
:type level: ContainerType, optional
|
|
4104
|
+
:param job:
|
|
4105
|
+
:type job: str, optional
|
|
4106
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4107
|
+
:type metadata: object, optional
|
|
4108
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
4109
|
+
:type x_accept_feature: list[str], optional
|
|
4110
|
+
:param content_type:
|
|
4111
|
+
:type content_type: str, optional
|
|
4112
|
+
:param async_: Perform the request asynchronously
|
|
4113
|
+
:type async_: bool, optional
|
|
4114
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
3761
4115
|
"""
|
|
3762
4116
|
|
|
3763
4117
|
all_params = ['container_id','file','ticket','preserve_metadata','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|