flywheel-sdk 21.3.0rc0__py3-none-any.whl → 21.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flywheel/__init__.py +7 -8
- flywheel/api/acquisitions_api.py +1033 -569
- flywheel/api/analyses_api.py +786 -432
- flywheel/api/audit_trail_api.py +78 -51
- flywheel/api/auth_api.py +6 -11
- flywheel/api/batch_api.py +60 -43
- flywheel/api/bulk_api.py +10 -13
- flywheel/api/change_log_api.py +40 -29
- flywheel/api/collections_api.py +740 -410
- flywheel/api/config_api.py +18 -19
- flywheel/api/container_tasks_api.py +14 -15
- flywheel/api/container_type_api.py +14 -15
- flywheel/api/containers_api.py +989 -545
- flywheel/api/custom_filters_api.py +64 -43
- flywheel/api/data_view_executions_api.py +94 -59
- flywheel/api/dataexplorer_api.py +158 -99
- flywheel/api/devices_api.py +132 -83
- flywheel/api/dimse_api.py +72 -51
- flywheel/api/download_api.py +46 -32
- flywheel/api/files_api.py +266 -157
- flywheel/api/form_responses_api.py +100 -63
- flywheel/api/gears_api.py +278 -163
- flywheel/api/groups_api.py +426 -245
- flywheel/api/jobs_api.py +288 -173
- flywheel/api/jupyterlab_servers_api.py +24 -21
- flywheel/api/modalities_api.py +78 -51
- flywheel/api/packfiles_api.py +6 -11
- flywheel/api/projects_api.py +1661 -856
- flywheel/api/protocols_api.py +94 -61
- flywheel/api/reports_api.py +196 -115
- flywheel/api/resolve_api.py +48 -33
- flywheel/api/roles_api.py +82 -53
- flywheel/api/sessions_api.py +1137 -623
- flywheel/api/site_api.py +182 -113
- flywheel/api/staffing_pools_api.py +88 -57
- flywheel/api/subjects_api.py +1095 -603
- flywheel/api/tasks_api.py +108 -69
- flywheel/api/tree_api.py +52 -35
- flywheel/api/uids_api.py +10 -13
- flywheel/api/upload_api.py +162 -95
- flywheel/api/users_api.py +418 -235
- flywheel/api/views_api.py +222 -127
- flywheel/api_client.py +19 -18
- flywheel/configuration.py +2 -9
- flywheel/file_spec.py +0 -7
- flywheel/flywheel.py +818 -4423
- flywheel/gear_context.py +10 -10
- flywheel/models/__init__.py +7 -8
- flywheel/models/access_level.py +0 -7
- flywheel/models/access_permission.py +13 -14
- flywheel/models/access_permission_output.py +13 -14
- flywheel/models/access_permission_update.py +8 -11
- flywheel/models/access_type.py +0 -7
- flywheel/models/accumulator.py +0 -7
- flywheel/models/acquisition.py +0 -7
- flywheel/models/acquisition_container_output.py +0 -7
- flywheel/models/acquisition_copy_input.py +18 -17
- flywheel/models/acquisition_input.py +33 -26
- flywheel/models/acquisition_list_output.py +118 -77
- flywheel/models/acquisition_modify_input.py +33 -26
- flywheel/models/acquisition_node.py +0 -7
- flywheel/models/acquisition_output.py +118 -77
- flywheel/models/acquisition_parents.py +23 -20
- flywheel/models/acquisition_template_options.py +28 -23
- flywheel/models/acquisition_upsert_input.py +48 -35
- flywheel/models/acquisition_upsert_output.py +23 -20
- flywheel/models/action.py +1 -7
- flywheel/models/adhoc_analysis_input.py +23 -20
- flywheel/models/analysis.py +0 -7
- flywheel/models/analysis_container_output.py +0 -7
- flywheel/models/analysis_files_create_ticket_output.py +23 -20
- flywheel/models/analysis_input.py +33 -26
- flywheel/models/analysis_input_legacy.py +0 -7
- flywheel/models/analysis_list_output.py +103 -68
- flywheel/models/analysis_list_output_inflated_job.py +98 -65
- flywheel/models/analysis_modify_input.py +13 -14
- flywheel/models/analysis_node.py +0 -7
- flywheel/models/analysis_output.py +103 -68
- flywheel/models/analysis_output_inflated_job.py +103 -68
- flywheel/models/analysis_parents.py +28 -23
- flywheel/models/analysis_update.py +0 -7
- flywheel/models/api_key_input_with_optional_label.py +13 -14
- flywheel/models/api_key_output.py +33 -26
- flywheel/models/as_storage.py +33 -26
- flywheel/models/assignee.py +13 -14
- flywheel/models/assignee_type.py +0 -7
- flywheel/models/audit_trail_report.py +68 -47
- flywheel/models/audit_trail_report_status.py +0 -7
- flywheel/models/auth0_auth_out.py +38 -29
- flywheel/models/auth0_options_out.py +38 -29
- flywheel/models/auth_out.py +34 -82
- flywheel/models/auth_session_output.py +28 -23
- flywheel/models/avatars.py +18 -17
- flywheel/models/aws_creds.py +13 -14
- flywheel/models/aws_storage.py +43 -32
- flywheel/models/azure_creds.py +13 -14
- flywheel/models/base_aet.py +23 -20
- flywheel/models/base_compute.py +58 -41
- flywheel/models/batch.py +43 -32
- flywheel/models/batch_cancel_output.py +0 -7
- flywheel/models/batch_create_filters.py +18 -17
- flywheel/models/batch_job_analysis_input.py +28 -23
- flywheel/models/batch_jobs_proposal_input.py +0 -7
- flywheel/models/batch_proposal.py +0 -7
- flywheel/models/batch_proposal_detail.py +0 -7
- flywheel/models/batch_proposal_input.py +0 -7
- flywheel/models/body.py +0 -7
- flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
- flywheel/models/body_region.py +0 -7
- flywheel/models/bookmark.py +13 -14
- flywheel/models/bulk_move_input.py +28 -23
- flywheel/models/bulk_move_sessions.py +0 -7
- flywheel/models/callbacks_virus_scan_input.py +0 -7
- flywheel/models/cancelled_batch_output.py +8 -11
- flywheel/models/catalog_list_output.py +53 -38
- flywheel/models/central_out.py +33 -26
- flywheel/models/change.py +80 -39
- flywheel/models/change_log_container_type.py +0 -7
- flywheel/models/change_log_document.py +23 -20
- flywheel/models/change_method.py +1 -7
- flywheel/models/classic_batch_job_output.py +43 -32
- flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
- flywheel/models/classic_batch_proposal_input.py +48 -35
- flywheel/models/classic_batch_proposal_output.py +63 -44
- flywheel/models/classification_add_delete.py +0 -7
- flywheel/models/classification_replace.py +0 -7
- flywheel/models/classification_update_input.py +0 -7
- flywheel/models/cohort.py +0 -7
- flywheel/models/collection.py +0 -7
- flywheel/models/collection_container_output.py +0 -7
- flywheel/models/collection_input.py +18 -17
- flywheel/models/collection_input_with_contents.py +23 -20
- flywheel/models/collection_node.py +13 -14
- flywheel/models/collection_node_level.py +0 -7
- flywheel/models/collection_operation.py +13 -14
- flywheel/models/collection_operation_type.py +0 -7
- flywheel/models/collection_output.py +93 -62
- flywheel/models/collection_with_stats.py +93 -62
- flywheel/models/column.py +28 -23
- flywheel/models/column_type.py +0 -7
- flywheel/models/common_classification.py +3 -8
- flywheel/models/common_deleted_count.py +0 -7
- flywheel/models/common_editions.py +0 -7
- flywheel/models/common_info.py +3 -8
- flywheel/models/common_join_origins.py +0 -7
- flywheel/models/common_key.py +0 -7
- flywheel/models/common_modified_count.py +0 -7
- flywheel/models/common_object_created.py +0 -7
- flywheel/models/common_project_settings.py +0 -7
- flywheel/models/common_settings.py +0 -7
- flywheel/models/complete_multipart_upload_output.py +13 -14
- flywheel/models/complete_s3_multipart_upload_input.py +23 -20
- flywheel/models/config_feature_map.py +0 -7
- flywheel/models/config_out.py +48 -35
- flywheel/models/config_output.py +0 -7
- flywheel/models/config_site_config_output.py +0 -7
- flywheel/models/config_site_settings.py +0 -7
- flywheel/models/config_site_settings_input.py +0 -7
- flywheel/models/conflict_types.py +0 -7
- flywheel/models/container_delete_reason.py +0 -7
- flywheel/models/container_filter.py +13 -14
- flywheel/models/container_id_view_input.py +73 -50
- flywheel/models/container_id_view_input_execute_and_save.py +33 -26
- flywheel/models/container_modify.py +73 -50
- flywheel/models/container_new_output.py +0 -7
- flywheel/models/container_node_min.py +43 -32
- flywheel/models/container_output.py +0 -7
- flywheel/models/container_output_with_files.py +28 -23
- flywheel/models/container_parents.py +33 -26
- flywheel/models/container_pipeline_input.py +73 -50
- flywheel/models/container_project_parents.py +0 -7
- flywheel/models/container_reference.py +13 -14
- flywheel/models/container_reference_with_label.py +18 -17
- flywheel/models/container_session_parents.py +0 -7
- flywheel/models/container_subject_parents.py +0 -7
- flywheel/models/container_type.py +2 -7
- flywheel/models/container_uidcheck.py +23 -20
- flywheel/models/container_update.py +3 -8
- flywheel/models/context_input.py +18 -17
- flywheel/models/copy_filter.py +33 -26
- flywheel/models/copy_status.py +0 -7
- flywheel/models/core_models_api_key_api_key_input.py +13 -14
- flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
- flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
- flywheel/models/core_models_common_source.py +13 -14
- flywheel/models/core_models_jobs_api_key_input.py +13 -14
- flywheel/models/core_models_search_parent_type.py +0 -7
- flywheel/models/core_workflows_form_responses_models_form_parents.py +157 -15
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
- flywheel/models/creds.py +3 -8
- flywheel/models/curator.py +18 -17
- flywheel/models/current_user_output.py +108 -71
- flywheel/models/custom_field.py +61 -44
- flywheel/models/custom_form.py +23 -20
- flywheel/models/cvat_info.py +28 -23
- flywheel/models/cvat_settings.py +28 -23
- flywheel/models/cvat_settings_input.py +28 -23
- flywheel/models/cvat_sync_state.py +0 -7
- flywheel/models/daily_report_usage.py +78 -53
- flywheel/models/data_strategy.py +0 -7
- flywheel/models/data_view.py +0 -7
- flywheel/models/data_view_analysis_file_spec.py +18 -17
- flywheel/models/data_view_analysis_filter_spec.py +18 -17
- flywheel/models/data_view_column_alias.py +38 -29
- flywheel/models/data_view_column_spec.py +28 -23
- flywheel/models/data_view_execution.py +68 -47
- flywheel/models/data_view_execution_state.py +0 -7
- flywheel/models/data_view_file_spec.py +48 -35
- flywheel/models/data_view_group_by.py +8 -11
- flywheel/models/data_view_group_by_column.py +13 -14
- flywheel/models/data_view_name_filter_spec.py +13 -14
- flywheel/models/data_view_output.py +0 -7
- flywheel/models/data_view_save_data_view_input.py +0 -7
- flywheel/models/data_view_zip_filter_spec.py +18 -17
- flywheel/models/default_flywheel_role.py +0 -7
- flywheel/models/deid_log_skip_reason.py +0 -7
- flywheel/models/delete_by_search_query.py +23 -20
- flywheel/models/delete_status.py +25 -0
- flywheel/models/deleted_file.py +73 -50
- flywheel/models/deleted_result.py +50 -19
- flywheel/models/deprecated_action.py +0 -7
- flywheel/models/destination_container_type.py +0 -7
- flywheel/models/device.py +58 -41
- flywheel/models/device_admin_update.py +13 -14
- flywheel/models/device_create.py +18 -17
- flywheel/models/device_self_update.py +28 -23
- flywheel/models/device_status.py +0 -7
- flywheel/models/device_status_entry.py +18 -17
- flywheel/models/device_storage_strategy_update.py +13 -14
- flywheel/models/dimse_project_input.py +0 -7
- flywheel/models/dimse_project_output.py +0 -7
- flywheel/models/dimse_service_input.py +0 -7
- flywheel/models/dimse_service_output.py +0 -7
- flywheel/models/download.py +23 -20
- flywheel/models/download_container_filter.py +8 -11
- flywheel/models/download_container_filter_definition.py +18 -17
- flywheel/models/download_filter.py +18 -17
- flywheel/models/download_filter_definition.py +13 -14
- flywheel/models/download_format.py +0 -7
- flywheel/models/download_input.py +0 -7
- flywheel/models/download_node.py +13 -14
- flywheel/models/download_strategy.py +0 -7
- flywheel/models/download_ticket.py +0 -7
- flywheel/models/download_ticket_stub.py +23 -20
- flywheel/models/download_ticket_with_summary.py +0 -7
- flywheel/models/e_signature.py +23 -20
- flywheel/models/edition.py +8 -11
- flywheel/models/egress_device.py +88 -59
- flywheel/models/egress_device_page.py +18 -17
- flywheel/models/egress_provider.py +53 -38
- flywheel/models/egress_provider_id.py +8 -11
- flywheel/models/exchange_storage.py +23 -20
- flywheel/models/executor_info.py +43 -32
- flywheel/models/export_templates.py +13 -14
- flywheel/models/features.py +457 -307
- flywheel/models/field_change.py +28 -23
- flywheel/models/field_change_log_document.py +23 -20
- flywheel/models/field_type.py +0 -7
- flywheel/models/file.py +188 -119
- flywheel/models/file_classification_delta.py +23 -20
- flywheel/models/file_container_type.py +0 -7
- flywheel/models/file_entry.py +108 -71
- flywheel/models/file_export_templates.py +28 -23
- flywheel/models/file_format.py +0 -7
- flywheel/models/file_gear_info.py +18 -17
- flywheel/models/file_group.py +0 -7
- flywheel/models/file_list_output.py +183 -116
- flywheel/models/file_modify_input.py +13 -14
- flywheel/models/file_move_input.py +18 -17
- flywheel/models/file_node.py +188 -119
- flywheel/models/file_node_min.py +38 -29
- flywheel/models/file_origin.py +28 -23
- flywheel/models/file_output.py +183 -116
- flywheel/models/file_parents.py +33 -26
- flywheel/models/file_reference.py +18 -17
- flywheel/models/file_suggestion.py +23 -20
- flywheel/models/file_template_options.py +33 -26
- flywheel/models/file_upsert_input.py +88 -59
- flywheel/models/file_upsert_origin.py +0 -7
- flywheel/models/file_upsert_output.py +188 -119
- flywheel/models/file_version.py +13 -14
- flywheel/models/file_version_copy_of.py +28 -23
- flywheel/models/file_version_output.py +38 -29
- flywheel/models/file_via.py +23 -20
- flywheel/models/file_zip_entry.py +0 -7
- flywheel/models/file_zip_info.py +0 -7
- flywheel/models/filter.py +43 -32
- flywheel/models/filter_input.py +18 -17
- flywheel/models/filter_values.py +13 -14
- flywheel/models/filter_view.py +0 -7
- flywheel/models/fixed_file_version_input.py +18 -17
- flywheel/models/fixed_input.py +33 -26
- flywheel/models/form_definition.py +8 -11
- flywheel/models/form_response_base.py +33 -26
- flywheel/models/form_response_create.py +13 -14
- flywheel/models/gcp_creds.py +53 -38
- flywheel/models/gcp_storage.py +33 -26
- flywheel/models/gear.py +88 -59
- flywheel/models/gear_category.py +0 -7
- flywheel/models/gear_config.py +3 -8
- flywheel/models/gear_context_input.py +8 -11
- flywheel/models/gear_context_lookup.py +0 -7
- flywheel/models/gear_context_lookup_item.py +0 -7
- flywheel/models/gear_context_value_output.py +28 -23
- flywheel/models/gear_context_value_output_unfound.py +8 -11
- flywheel/models/gear_custom.py +3 -8
- flywheel/models/gear_directive.py +3 -8
- flywheel/models/gear_doc.py +0 -7
- flywheel/models/gear_document.py +38 -29
- flywheel/models/gear_document_input.py +33 -26
- flywheel/models/gear_document_legacy_input.py +33 -26
- flywheel/models/gear_environment.py +3 -8
- flywheel/models/gear_exchange.py +18 -17
- flywheel/models/gear_file_input.py +13 -14
- flywheel/models/gear_id_output.py +8 -11
- flywheel/models/gear_info.py +23 -20
- flywheel/models/gear_input_item.py +18 -17
- flywheel/models/gear_inputs.py +3 -8
- flywheel/models/gear_key_input.py +13 -14
- flywheel/models/gear_manifest.py +93 -62
- flywheel/models/gear_mixin.py +26 -6
- flywheel/models/gear_node.py +43 -32
- flywheel/models/gear_output_configuration.py +8 -11
- flywheel/models/gear_permissions.py +13 -14
- flywheel/models/gear_permissions_input.py +8 -11
- flywheel/models/gear_permissions_type.py +0 -7
- flywheel/models/gear_return_ticket.py +0 -7
- flywheel/models/gear_rule.py +133 -69
- flywheel/models/gear_rule_condition.py +18 -17
- flywheel/models/gear_rule_condition_type.py +0 -7
- flywheel/models/gear_rule_input.py +108 -54
- flywheel/models/gear_rule_modify_input.py +103 -51
- flywheel/models/gear_rule_output.py +133 -69
- flywheel/models/gear_save_submission.py +18 -17
- flywheel/models/gear_series.py +33 -26
- flywheel/models/gear_series_update.py +8 -11
- flywheel/models/gear_suggestion_output.py +33 -26
- flywheel/models/gear_ticket.py +23 -20
- flywheel/models/gear_ticket_output.py +8 -11
- flywheel/models/graph_filter.py +38 -29
- flywheel/models/group.py +0 -7
- flywheel/models/group_by.py +8 -11
- flywheel/models/group_by_column.py +0 -7
- flywheel/models/group_container_output.py +0 -7
- flywheel/models/group_input.py +23 -20
- flywheel/models/group_metadata_input.py +0 -7
- flywheel/models/group_node.py +0 -7
- flywheel/models/group_output.py +63 -44
- flywheel/models/group_report.py +18 -17
- flywheel/models/group_role.py +8 -11
- flywheel/models/group_settings_output.py +23 -20
- flywheel/models/group_update.py +23 -20
- flywheel/models/header_feature.py +0 -7
- flywheel/models/hierarchy_export_templates.py +28 -23
- flywheel/models/http_validation_error.py +8 -11
- flywheel/models/info.py +18 -17
- flywheel/models/info_add_remove.py +0 -7
- flywheel/models/info_container_type.py +0 -7
- flywheel/models/info_replace.py +0 -7
- flywheel/models/info_update_input.py +0 -7
- flywheel/models/ingress_provider.py +33 -26
- flywheel/models/ingress_providers.py +28 -23
- flywheel/models/ingress_site_settings.py +29 -52
- flywheel/models/ingress_update_provider.py +18 -17
- flywheel/models/inline_response200.py +8 -11
- flywheel/models/inline_response2001.py +8 -11
- flywheel/models/inline_response2002.py +8 -11
- flywheel/models/inline_response2003.py +0 -7
- flywheel/models/inline_response2005.py +0 -7
- flywheel/models/input_filter.py +18 -17
- flywheel/models/input_job.py +73 -50
- flywheel/models/input_job_profile.py +28 -23
- flywheel/models/inserted_id.py +8 -11
- flywheel/models/job.py +128 -83
- flywheel/models/job_analysis_input.py +28 -23
- flywheel/models/job_ask.py +33 -26
- flywheel/models/job_ask_response.py +13 -14
- flywheel/models/job_ask_response_job.py +158 -101
- flywheel/models/job_ask_return.py +0 -7
- flywheel/models/job_ask_return_criteria.py +23 -20
- flywheel/models/job_ask_state.py +0 -7
- flywheel/models/job_ask_state_response.py +8 -11
- flywheel/models/job_complete.py +18 -17
- flywheel/models/job_completion_input.py +0 -7
- flywheel/models/job_completion_ticket.py +0 -7
- flywheel/models/job_config.py +3 -8
- flywheel/models/job_config_input.py +28 -23
- flywheel/models/job_config_inputs.py +0 -7
- flywheel/models/job_config_output.py +0 -7
- flywheel/models/job_container_detail.py +0 -7
- flywheel/models/job_destination.py +13 -14
- flywheel/models/job_detail.py +148 -95
- flywheel/models/job_detail_container.py +13 -14
- flywheel/models/job_detail_file_entry.py +13 -14
- flywheel/models/job_detail_group.py +13 -14
- flywheel/models/job_detail_parent_info.py +33 -26
- flywheel/models/job_executor_info.py +43 -32
- flywheel/models/job_file_input.py +23 -20
- flywheel/models/job_file_input_list_output.py +23 -20
- flywheel/models/job_file_object.py +58 -41
- flywheel/models/job_file_object_list_output.py +53 -38
- flywheel/models/job_gear_match.py +0 -7
- flywheel/models/job_inputs_array_item.py +33 -26
- flywheel/models/job_inputs_item.py +23 -20
- flywheel/models/job_inputs_object.py +3 -8
- flywheel/models/job_list_entry.py +0 -7
- flywheel/models/job_list_output.py +158 -101
- flywheel/models/job_list_output_config.py +18 -17
- flywheel/models/job_log.py +13 -14
- flywheel/models/job_log_column.py +0 -7
- flywheel/models/job_log_record.py +13 -14
- flywheel/models/job_modify.py +13 -14
- flywheel/models/job_origin.py +13 -14
- flywheel/models/job_output.py +163 -104
- flywheel/models/job_output_config.py +23 -20
- flywheel/models/job_parents.py +33 -26
- flywheel/models/job_priority.py +0 -7
- flywheel/models/job_priority_update.py +13 -14
- flywheel/models/job_profile.py +53 -38
- flywheel/models/job_profile_input.py +0 -7
- flywheel/models/job_request.py +18 -17
- flywheel/models/job_request_item.py +23 -20
- flywheel/models/job_request_item_type.py +0 -7
- flywheel/models/job_request_target.py +28 -23
- flywheel/models/job_state.py +0 -7
- flywheel/models/job_state_counts.py +0 -7
- flywheel/models/job_stats_by_state.py +0 -7
- flywheel/models/job_ticket_output.py +8 -11
- flywheel/models/job_transition_times.py +23 -20
- flywheel/models/job_version_info.py +3 -8
- flywheel/models/jobs_by_state.py +28 -23
- flywheel/models/jobs_list.py +8 -11
- flywheel/models/join_origin_device.py +8 -11
- flywheel/models/join_origin_job.py +18 -17
- flywheel/models/join_origin_user.py +13 -14
- flywheel/models/join_origins.py +18 -17
- flywheel/models/join_type.py +0 -7
- flywheel/models/jupyterhub_workspace.py +8 -11
- flywheel/models/jupyterlab_server_modify.py +28 -23
- flywheel/models/jupyterlab_server_origin.py +0 -7
- flywheel/models/jupyterlab_server_output.py +0 -7
- flywheel/models/jupyterlab_server_response.py +53 -38
- flywheel/models/jupyterlab_server_update.py +0 -7
- flywheel/models/ldap_sync.py +0 -7
- flywheel/models/ldap_sync_config.py +8 -11
- flywheel/models/ldap_sync_input.py +0 -7
- flywheel/models/ldap_sync_status.py +23 -20
- flywheel/models/legacy_api_key_output.py +28 -23
- flywheel/models/legacy_input.py +23 -20
- flywheel/models/legacy_usage_report.py +33 -26
- flywheel/models/legacys_usage_project_entry.py +13 -14
- flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
- flywheel/models/libs_workflows_models_parent_type.py +0 -7
- flywheel/models/libs_workflows_models_task_status.py +0 -7
- flywheel/models/local_storage.py +18 -17
- flywheel/models/location.py +13 -14
- flywheel/models/locked.py +18 -17
- flywheel/models/master_subject_code_dob_input.py +28 -23
- flywheel/models/master_subject_code_input.py +28 -23
- flywheel/models/master_subject_code_output.py +8 -11
- flywheel/models/matched_acquisition_output.py +73 -50
- flywheel/models/measurement_config.py +222 -0
- flywheel/models/measurement_item_config.py +217 -0
- flywheel/models/mfa_channel.py +0 -7
- flywheel/models/mfa_settings.py +8 -11
- flywheel/models/ml_set_filter.py +13 -14
- flywheel/models/ml_type.py +0 -7
- flywheel/models/modality.py +23 -20
- flywheel/models/modality_input.py +23 -20
- flywheel/models/modality_modify.py +18 -17
- flywheel/models/modality_output.py +28 -23
- flywheel/models/modified_result.py +13 -14
- flywheel/models/modify_user_input.py +63 -44
- flywheel/models/move_conflict.py +33 -26
- flywheel/models/note.py +48 -35
- flywheel/models/note_input.py +8 -11
- flywheel/models/optional_input_policy.py +0 -7
- flywheel/models/order.py +0 -7
- flywheel/models/organ_system.py +0 -7
- flywheel/models/origin.py +13 -14
- flywheel/models/origin_type.py +0 -7
- flywheel/models/orphaned_count.py +8 -11
- flywheel/models/output_user_page.py +18 -17
- flywheel/models/packfile_cleanup_output.py +8 -11
- flywheel/models/packfile_removed_output.py +13 -14
- flywheel/models/page.py +18 -17
- flywheel/models/page_generic_file_output.py +18 -17
- flywheel/models/page_generic_filter.py +18 -17
- flywheel/models/page_generic_form_response_output.py +18 -17
- flywheel/models/page_generic_protocol.py +23 -20
- flywheel/models/page_generic_reader_task_output.py +23 -20
- flywheel/models/page_generic_staffing_pool.py +23 -20
- flywheel/models/parsed_query_response.py +13 -14
- flywheel/models/permission_access_permission.py +0 -7
- flywheel/models/premade_jobs_batch_job_output.py +33 -26
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
- flywheel/models/premade_jobs_batch_proposal.py +38 -29
- flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
- flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
- flywheel/models/project.py +0 -7
- flywheel/models/project_acquisition_upsert_input.py +0 -7
- flywheel/models/project_acquisition_upsert_output.py +0 -7
- flywheel/models/project_aet.py +38 -29
- flywheel/models/project_aet_input.py +23 -20
- flywheel/models/project_catalog_list_output.py +0 -7
- flywheel/models/project_contact.py +13 -14
- flywheel/models/project_container_output.py +2 -7
- flywheel/models/project_copy_input.py +23 -20
- flywheel/models/project_copy_output.py +18 -17
- flywheel/models/project_counters.py +76 -36
- flywheel/models/project_delete_status_output.py +192 -0
- flywheel/models/project_group_info.py +189 -0
- flywheel/models/project_hierarchy_input.py +28 -23
- flywheel/models/project_hierarchy_output.py +18 -17
- flywheel/models/project_hierarchy_upsert_input.py +0 -7
- flywheel/models/project_hierarchy_upsert_output.py +0 -7
- flywheel/models/project_input.py +48 -35
- flywheel/models/project_institution.py +13 -14
- flywheel/models/project_list_output.py +234 -93
- flywheel/models/project_locking_reason.py +0 -7
- flywheel/models/project_modify.py +116 -42
- flywheel/models/project_node.py +2 -7
- flywheel/models/project_output.py +235 -93
- flywheel/models/project_parents.py +8 -11
- flywheel/models/project_report.py +63 -44
- flywheel/models/project_report_list.py +8 -11
- flywheel/models/project_session_upsert_input.py +0 -7
- flywheel/models/project_session_upsert_output.py +0 -7
- flywheel/models/project_settings_input.py +38 -29
- flywheel/models/project_settings_output.py +38 -29
- flywheel/models/project_settings_sharing.py +38 -29
- flywheel/models/project_settings_sharing_input.py +38 -29
- flywheel/models/project_settings_workspaces.py +8 -11
- flywheel/models/project_settings_workspaces_input.py +8 -11
- flywheel/models/project_share_level.py +0 -7
- flywheel/models/project_sharing_settings_project_contact.py +0 -7
- flywheel/models/project_sharing_settings_project_counters.py +0 -7
- flywheel/models/project_sharing_settings_project_institution.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
- flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
- flywheel/models/project_sharing_settings_project_stats.py +0 -7
- flywheel/models/project_stats.py +28 -23
- flywheel/models/project_subject_upsert_input.py +0 -7
- flywheel/models/project_subject_upsert_output.py +0 -7
- flywheel/models/project_template.py +13 -14
- flywheel/models/project_template_input.py +13 -14
- flywheel/models/project_template_list_input.py +8 -11
- flywheel/models/project_template_requirement.py +0 -7
- flywheel/models/project_template_session_template.py +0 -7
- flywheel/models/project_upsert_origin.py +0 -7
- flywheel/models/protocol.py +78 -53
- flywheel/models/protocol_e_signature_config.py +13 -14
- flywheel/models/protocol_input.py +43 -32
- flywheel/models/protocol_modify.py +28 -23
- flywheel/models/protocol_status.py +0 -7
- flywheel/models/provider.py +63 -44
- flywheel/models/provider_access_type.py +0 -7
- flywheel/models/provider_class.py +0 -7
- flywheel/models/provider_deletion_status.py +13 -14
- flywheel/models/provider_input.py +0 -7
- flywheel/models/provider_links.py +28 -23
- flywheel/models/provider_type.py +0 -7
- flywheel/models/providers.py +28 -23
- flywheel/models/reader_batch_create.py +63 -44
- flywheel/models/reader_task.py +113 -74
- flywheel/models/reader_task_config.py +49 -18
- flywheel/models/reader_task_create.py +78 -53
- flywheel/models/reader_task_modify.py +33 -26
- flywheel/models/reader_task_output.py +118 -77
- flywheel/models/reader_task_parent_details.py +38 -29
- flywheel/models/report_access_log_context.py +33 -26
- flywheel/models/report_access_log_context_entry.py +13 -14
- flywheel/models/report_access_log_context_file_entry.py +8 -11
- flywheel/models/report_access_log_entry.py +88 -59
- flywheel/models/report_access_log_origin.py +13 -14
- flywheel/models/report_availability_list.py +8 -11
- flywheel/models/report_daily_usage_entry.py +68 -47
- flywheel/models/report_demographics_grid.py +0 -7
- flywheel/models/report_ethnicity_grid.py +23 -20
- flywheel/models/report_gender_count.py +18 -17
- flywheel/models/report_group_report.py +18 -17
- flywheel/models/report_legacy_usage_entry.py +0 -7
- flywheel/models/report_legacy_usage_project_entry.py +0 -7
- flywheel/models/report_project.py +0 -7
- flywheel/models/report_site.py +13 -14
- flywheel/models/report_time_period.py +13 -14
- flywheel/models/report_usage.py +88 -59
- flywheel/models/report_usage_entry.py +0 -7
- flywheel/models/resolve_input.py +8 -11
- flywheel/models/resolve_output.py +13 -14
- flywheel/models/resolver_acquisition_node.py +0 -7
- flywheel/models/resolver_analysis_node.py +0 -7
- flywheel/models/resolver_file_node.py +0 -7
- flywheel/models/resolver_gear_node.py +0 -7
- flywheel/models/resolver_group_node.py +0 -7
- flywheel/models/resolver_input.py +0 -7
- flywheel/models/resolver_node.py +8 -11
- flywheel/models/resolver_output.py +0 -7
- flywheel/models/resolver_project_node.py +0 -7
- flywheel/models/resolver_session_node.py +0 -7
- flywheel/models/resolver_subject_node.py +0 -7
- flywheel/models/role_input.py +13 -14
- flywheel/models/role_output.py +28 -23
- flywheel/models/role_permission.py +13 -14
- flywheel/models/role_permission_output.py +13 -14
- flywheel/models/role_permission_update.py +8 -11
- flywheel/models/role_type.py +0 -7
- flywheel/models/role_update.py +13 -14
- flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
- flywheel/models/roles_group_role_pool_input.py +0 -7
- flywheel/models/roles_role.py +0 -7
- flywheel/models/roles_role_assignment.py +13 -14
- flywheel/models/roles_role_input.py +0 -7
- flywheel/models/rule.py +63 -44
- flywheel/models/rule_any.py +18 -17
- flywheel/models/s3_addressing_style.py +0 -7
- flywheel/models/s3_compat_storage.py +48 -35
- flywheel/models/save_search.py +33 -26
- flywheel/models/save_search_input.py +18 -17
- flywheel/models/save_search_output.py +33 -26
- flywheel/models/save_search_page.py +18 -17
- flywheel/models/save_search_parent.py +13 -14
- flywheel/models/save_search_update.py +13 -14
- flywheel/models/search_acquisition_response.py +23 -20
- flywheel/models/search_analysis_response.py +23 -20
- flywheel/models/search_collection_response.py +23 -20
- flywheel/models/search_file_response.py +33 -26
- flywheel/models/search_group_response.py +13 -14
- flywheel/models/search_parent_acquisition.py +0 -7
- flywheel/models/search_parent_analysis.py +0 -7
- flywheel/models/search_parent_collection.py +0 -7
- flywheel/models/search_parent_project.py +2 -7
- flywheel/models/search_parent_response.py +13 -14
- flywheel/models/search_parent_session.py +0 -7
- flywheel/models/search_parent_subject.py +0 -7
- flywheel/models/search_parse_error.py +23 -20
- flywheel/models/search_parse_search_query_result.py +0 -7
- flywheel/models/search_project_response.py +13 -14
- flywheel/models/search_query.py +38 -29
- flywheel/models/search_query_suggestions.py +0 -7
- flywheel/models/search_response.py +58 -41
- flywheel/models/search_return_type.py +0 -7
- flywheel/models/search_save_search.py +0 -7
- flywheel/models/search_save_search_input.py +0 -7
- flywheel/models/search_save_search_parent.py +0 -7
- flywheel/models/search_save_search_update.py +0 -7
- flywheel/models/search_session_response.py +23 -20
- flywheel/models/search_status.py +8 -11
- flywheel/models/search_structured_search_query.py +0 -7
- flywheel/models/search_subject_response.py +18 -17
- flywheel/models/search_suggestion.py +0 -7
- flywheel/models/select_item.py +13 -14
- flywheel/models/server_state.py +33 -26
- flywheel/models/service_aet.py +33 -26
- flywheel/models/service_aet_input.py +28 -23
- flywheel/models/session.py +0 -7
- flywheel/models/session_container_output.py +0 -7
- flywheel/models/session_copy_input.py +23 -20
- flywheel/models/session_embedded_subject.py +33 -26
- flywheel/models/session_input.py +58 -41
- flywheel/models/session_list_output.py +143 -92
- flywheel/models/session_metadata_input.py +0 -7
- flywheel/models/session_modify.py +63 -44
- flywheel/models/session_node.py +0 -7
- flywheel/models/session_output.py +143 -92
- flywheel/models/session_parents.py +18 -17
- flywheel/models/session_template_options.py +18 -17
- flywheel/models/session_template_recalc_output.py +8 -11
- flywheel/models/session_upsert_input.py +63 -44
- flywheel/models/session_upsert_output.py +23 -20
- flywheel/models/sharing_filter_options.py +43 -32
- flywheel/models/signed_fs_upload_output.py +13 -14
- flywheel/models/signed_url_cleanup_input.py +13 -14
- flywheel/models/signed_url_upload_input.py +13 -14
- flywheel/models/signed_url_upload_output.py +43 -32
- flywheel/models/site.py +93 -62
- flywheel/models/site_report.py +13 -14
- flywheel/models/site_settings.py +48 -35
- flywheel/models/sort.py +13 -14
- flywheel/models/stable_api_key_input.py +0 -7
- flywheel/models/staffing_pool.py +38 -29
- flywheel/models/staffing_pool_create.py +18 -17
- flywheel/models/staffing_pool_list.py +8 -11
- flywheel/models/staffing_pool_modify.py +18 -17
- flywheel/models/state.py +0 -7
- flywheel/models/static_compute.py +18 -17
- flywheel/models/status_transitions.py +23 -20
- flywheel/models/status_type.py +0 -7
- flywheel/models/status_value.py +0 -7
- flywheel/models/storage_strategy.py +0 -7
- flywheel/models/storage_strategy_config.py +13 -14
- flywheel/models/structured_query.py +8 -11
- flywheel/models/structured_query_suggestions.py +13 -14
- flywheel/models/structured_query_value_suggestion.py +23 -20
- flywheel/models/subject.py +0 -7
- flywheel/models/subject_container_output.py +0 -7
- flywheel/models/subject_copy_input.py +18 -17
- flywheel/models/subject_input.py +93 -62
- flywheel/models/subject_modify.py +103 -68
- flywheel/models/subject_node.py +0 -7
- flywheel/models/subject_output.py +163 -104
- flywheel/models/subject_output_for_list.py +163 -104
- flywheel/models/subject_parents.py +13 -14
- flywheel/models/subject_role_permission.py +13 -14
- flywheel/models/subject_state.py +0 -7
- flywheel/models/subject_template_options.py +13 -14
- flywheel/models/subject_upsert_input.py +83 -56
- flywheel/models/subject_upsert_output.py +18 -17
- flywheel/models/sync_user_input.py +38 -29
- flywheel/models/tag.py +8 -11
- flywheel/models/task_assign.py +13 -14
- flywheel/models/task_facet.py +0 -7
- flywheel/models/task_parent_ref.py +23 -20
- flywheel/models/task_parent_ref_input.py +18 -17
- flywheel/models/task_priority.py +0 -7
- flywheel/models/task_submission.py +13 -14
- flywheel/models/therapeutic_area.py +0 -7
- flywheel/models/toolbar_config.py +161 -0
- flywheel/models/transitions.py +28 -23
- flywheel/models/tree_container_request_spec.py +28 -23
- flywheel/models/tree_graph.py +3 -8
- flywheel/models/tree_graph_connection.py +23 -20
- flywheel/models/tree_graph_connections.py +3 -8
- flywheel/models/tree_graph_node.py +8 -11
- flywheel/models/tree_request.py +0 -7
- flywheel/models/tree_response_item.py +3 -8
- flywheel/models/type_str.py +0 -7
- flywheel/models/uid_check_input_acquisitions.py +23 -20
- flywheel/models/uid_check_input_sessions.py +23 -20
- flywheel/models/uid_check_output.py +13 -14
- flywheel/models/upload_complete_s3_multipart_input.py +0 -7
- flywheel/models/upload_complete_s3_multipart_output.py +0 -7
- flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
- flywheel/models/upload_signed_upload_url_input.py +0 -7
- flywheel/models/upload_signed_upload_url_output.py +0 -7
- flywheel/models/upload_ticket_output.py +18 -17
- flywheel/models/upload_token_output.py +8 -11
- flywheel/models/upsert_result.py +0 -7
- flywheel/models/user.py +113 -74
- flywheel/models/user_api_key.py +18 -17
- flywheel/models/user_input.py +63 -44
- flywheel/models/user_jobs.py +18 -17
- flywheel/models/user_jobs_output.py +0 -7
- flywheel/models/user_output.py +0 -7
- flywheel/models/user_output_id.py +8 -11
- flywheel/models/user_preferences.py +3 -8
- flywheel/models/user_wechat.py +3 -8
- flywheel/models/validation_error.py +18 -17
- flywheel/models/validation_rule.py +13 -14
- flywheel/models/version.py +43 -32
- flywheel/models/version_output.py +0 -7
- flywheel/models/view_id_output.py +8 -11
- flywheel/models/view_output.py +58 -41
- flywheel/models/viewer_app.py +48 -35
- flywheel/models/viewer_app_input.py +48 -35
- flywheel/models/viewer_app_type.py +0 -7
- flywheel/models/virus_scan.py +8 -11
- flywheel/models/virus_scan_state.py +0 -7
- flywheel/models/work_in_progress_features.py +3 -8
- flywheel/models/zipfile_info.py +13 -14
- flywheel/models/zipfile_member_info.py +23 -20
- flywheel/partial_reader.py +0 -7
- flywheel/rest.py +0 -7
- flywheel/view_builder.py +2 -1
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
- flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +1 -1
- flywheel/models/google_auth_out.py +0 -299
- flywheel_sdk-21.3.0rc0.dist-info/RECORD +0 -772
- {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
flywheel/api/collections_api.py
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
Flywheel
|
|
5
|
-
|
|
6
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
|
|
7
|
-
|
|
8
|
-
OpenAPI spec version: 0.0.1
|
|
9
|
-
|
|
10
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
4
|
"""
|
|
12
5
|
|
|
13
6
|
|
|
@@ -37,9 +30,11 @@ class CollectionsApi(object):
|
|
|
37
30
|
Create a collection
|
|
38
31
|
This method makes a synchronous HTTP request by default.
|
|
39
32
|
|
|
40
|
-
:param
|
|
41
|
-
:
|
|
42
|
-
:
|
|
33
|
+
:param body:
|
|
34
|
+
:type body: CollectionInput
|
|
35
|
+
:param async_: Perform the request asynchronously
|
|
36
|
+
:type async_: bool, optional
|
|
37
|
+
:rtype: InsertedId
|
|
43
38
|
"""
|
|
44
39
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
45
40
|
kwargs['_return_http_data_only'] = True
|
|
@@ -63,9 +58,11 @@ class CollectionsApi(object):
|
|
|
63
58
|
Create a collection
|
|
64
59
|
This method makes a synchronous HTTP request by default.
|
|
65
60
|
|
|
66
|
-
:param
|
|
67
|
-
:
|
|
68
|
-
:
|
|
61
|
+
:param body:
|
|
62
|
+
:type body: CollectionInput
|
|
63
|
+
:param async_: Perform the request asynchronously
|
|
64
|
+
:type async_: bool, optional
|
|
65
|
+
:rtype: InsertedId
|
|
69
66
|
"""
|
|
70
67
|
|
|
71
68
|
all_params = ['body',] # noqa: E501
|
|
@@ -145,10 +142,13 @@ class CollectionsApi(object):
|
|
|
145
142
|
Add a note to a(n) collection.
|
|
146
143
|
This method makes a synchronous HTTP request by default.
|
|
147
144
|
|
|
148
|
-
:param
|
|
149
|
-
:
|
|
150
|
-
:param
|
|
151
|
-
:
|
|
145
|
+
:param container_id:
|
|
146
|
+
:type container_id: str
|
|
147
|
+
:param body:
|
|
148
|
+
:type body: NoteInput
|
|
149
|
+
:param async_: Perform the request asynchronously
|
|
150
|
+
:type async_: bool, optional
|
|
151
|
+
:rtype: Note
|
|
152
152
|
"""
|
|
153
153
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
154
154
|
kwargs['_return_http_data_only'] = True
|
|
@@ -172,10 +172,13 @@ class CollectionsApi(object):
|
|
|
172
172
|
Add a note to a(n) collection.
|
|
173
173
|
This method makes a synchronous HTTP request by default.
|
|
174
174
|
|
|
175
|
-
:param
|
|
176
|
-
:
|
|
177
|
-
:param
|
|
178
|
-
:
|
|
175
|
+
:param container_id:
|
|
176
|
+
:type container_id: str
|
|
177
|
+
:param body:
|
|
178
|
+
:type body: NoteInput
|
|
179
|
+
:param async_: Perform the request asynchronously
|
|
180
|
+
:type async_: bool, optional
|
|
181
|
+
:rtype: Note
|
|
179
182
|
"""
|
|
180
183
|
|
|
181
184
|
all_params = ['container_id','body',] # noqa: E501
|
|
@@ -261,10 +264,13 @@ class CollectionsApi(object):
|
|
|
261
264
|
Add a permission
|
|
262
265
|
This method makes a synchronous HTTP request by default.
|
|
263
266
|
|
|
264
|
-
:param
|
|
265
|
-
:
|
|
266
|
-
:param
|
|
267
|
-
:
|
|
267
|
+
:param collection_id:
|
|
268
|
+
:type collection_id: str
|
|
269
|
+
:param body:
|
|
270
|
+
:type body: AccessPermission
|
|
271
|
+
:param async_: Perform the request asynchronously
|
|
272
|
+
:type async_: bool, optional
|
|
273
|
+
:rtype: AccessPermissionOutput
|
|
268
274
|
"""
|
|
269
275
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
270
276
|
kwargs['_return_http_data_only'] = True
|
|
@@ -288,10 +294,13 @@ class CollectionsApi(object):
|
|
|
288
294
|
Add a permission
|
|
289
295
|
This method makes a synchronous HTTP request by default.
|
|
290
296
|
|
|
291
|
-
:param
|
|
292
|
-
:
|
|
293
|
-
:param
|
|
294
|
-
:
|
|
297
|
+
:param collection_id:
|
|
298
|
+
:type collection_id: str
|
|
299
|
+
:param body:
|
|
300
|
+
:type body: AccessPermission
|
|
301
|
+
:param async_: Perform the request asynchronously
|
|
302
|
+
:type async_: bool, optional
|
|
303
|
+
:rtype: AccessPermissionOutput
|
|
295
304
|
"""
|
|
296
305
|
|
|
297
306
|
all_params = ['collection_id','body',] # noqa: E501
|
|
@@ -377,10 +386,13 @@ class CollectionsApi(object):
|
|
|
377
386
|
Propagates changes to projects, sessions and acquisitions
|
|
378
387
|
This method makes a synchronous HTTP request by default.
|
|
379
388
|
|
|
380
|
-
:param
|
|
381
|
-
:
|
|
382
|
-
:param
|
|
383
|
-
:
|
|
389
|
+
:param cid:
|
|
390
|
+
:type cid: str
|
|
391
|
+
:param body:
|
|
392
|
+
:type body: Tag
|
|
393
|
+
:param async_: Perform the request asynchronously
|
|
394
|
+
:type async_: bool, optional
|
|
395
|
+
:rtype: ModifiedResult
|
|
384
396
|
"""
|
|
385
397
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
386
398
|
kwargs['_return_http_data_only'] = True
|
|
@@ -404,10 +416,13 @@ class CollectionsApi(object):
|
|
|
404
416
|
Propagates changes to projects, sessions and acquisitions
|
|
405
417
|
This method makes a synchronous HTTP request by default.
|
|
406
418
|
|
|
407
|
-
:param
|
|
408
|
-
:
|
|
409
|
-
:param
|
|
410
|
-
:
|
|
419
|
+
:param cid:
|
|
420
|
+
:type cid: str
|
|
421
|
+
:param body:
|
|
422
|
+
:type body: Tag
|
|
423
|
+
:param async_: Perform the request asynchronously
|
|
424
|
+
:type async_: bool, optional
|
|
425
|
+
:rtype: ModifiedResult
|
|
411
426
|
"""
|
|
412
427
|
|
|
413
428
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -493,10 +508,13 @@ class CollectionsApi(object):
|
|
|
493
508
|
Add multiple tags to a(n) collection
|
|
494
509
|
This method makes a synchronous HTTP request by default.
|
|
495
510
|
|
|
496
|
-
:param
|
|
497
|
-
:
|
|
498
|
-
:param
|
|
499
|
-
:
|
|
511
|
+
:param cid:
|
|
512
|
+
:type cid: str
|
|
513
|
+
:param body:
|
|
514
|
+
:type body: list[str]
|
|
515
|
+
:param async_: Perform the request asynchronously
|
|
516
|
+
:type async_: bool, optional
|
|
517
|
+
:rtype: None
|
|
500
518
|
"""
|
|
501
519
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
502
520
|
kwargs['_return_http_data_only'] = True
|
|
@@ -520,10 +538,13 @@ class CollectionsApi(object):
|
|
|
520
538
|
Add multiple tags to a(n) collection
|
|
521
539
|
This method makes a synchronous HTTP request by default.
|
|
522
540
|
|
|
523
|
-
:param
|
|
524
|
-
:
|
|
525
|
-
:param
|
|
526
|
-
:
|
|
541
|
+
:param cid:
|
|
542
|
+
:type cid: str
|
|
543
|
+
:param body:
|
|
544
|
+
:type body: list[str]
|
|
545
|
+
:param async_: Perform the request asynchronously
|
|
546
|
+
:type async_: bool, optional
|
|
547
|
+
:rtype: None
|
|
527
548
|
"""
|
|
528
549
|
|
|
529
550
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -602,9 +623,11 @@ class CollectionsApi(object):
|
|
|
602
623
|
Delete Collections.
|
|
603
624
|
This method makes a synchronous HTTP request by default.
|
|
604
625
|
|
|
605
|
-
:param
|
|
606
|
-
:
|
|
607
|
-
:
|
|
626
|
+
:param collection_id:
|
|
627
|
+
:type collection_id: str
|
|
628
|
+
:param async_: Perform the request asynchronously
|
|
629
|
+
:type async_: bool, optional
|
|
630
|
+
:rtype: DeletedResult
|
|
608
631
|
"""
|
|
609
632
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
610
633
|
kwargs['_return_http_data_only'] = True
|
|
@@ -628,9 +651,11 @@ class CollectionsApi(object):
|
|
|
628
651
|
Delete Collections.
|
|
629
652
|
This method makes a synchronous HTTP request by default.
|
|
630
653
|
|
|
631
|
-
:param
|
|
632
|
-
:
|
|
633
|
-
:
|
|
654
|
+
:param collection_id:
|
|
655
|
+
:type collection_id: str
|
|
656
|
+
:param async_: Perform the request asynchronously
|
|
657
|
+
:type async_: bool, optional
|
|
658
|
+
:rtype: DeletedResult
|
|
634
659
|
"""
|
|
635
660
|
|
|
636
661
|
all_params = ['collection_id',] # noqa: E501
|
|
@@ -699,12 +724,17 @@ class CollectionsApi(object):
|
|
|
699
724
|
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.
|
|
700
725
|
This method makes a synchronous HTTP request by default.
|
|
701
726
|
|
|
702
|
-
:param
|
|
703
|
-
:
|
|
704
|
-
:param
|
|
705
|
-
:
|
|
706
|
-
:param
|
|
707
|
-
:
|
|
727
|
+
:param cid:
|
|
728
|
+
:type cid: str
|
|
729
|
+
:param filename:
|
|
730
|
+
:type filename: str
|
|
731
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
732
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
733
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
734
|
+
:type force: bool, optional
|
|
735
|
+
:param async_: Perform the request asynchronously
|
|
736
|
+
:type async_: bool, optional
|
|
737
|
+
:rtype: DeletedResult
|
|
708
738
|
"""
|
|
709
739
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
710
740
|
kwargs['_return_http_data_only'] = True
|
|
@@ -728,12 +758,17 @@ class CollectionsApi(object):
|
|
|
728
758
|
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.
|
|
729
759
|
This method makes a synchronous HTTP request by default.
|
|
730
760
|
|
|
731
|
-
:param
|
|
732
|
-
:
|
|
733
|
-
:param
|
|
734
|
-
:
|
|
735
|
-
:param
|
|
736
|
-
:
|
|
761
|
+
:param cid:
|
|
762
|
+
:type cid: str
|
|
763
|
+
:param filename:
|
|
764
|
+
:type filename: str
|
|
765
|
+
:param delete_reason: A reason for deletion when audit-trail is enabled
|
|
766
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
767
|
+
:param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
|
|
768
|
+
:type force: bool, optional
|
|
769
|
+
:param async_: Perform the request asynchronously
|
|
770
|
+
:type async_: bool, optional
|
|
771
|
+
:rtype: DeletedResult
|
|
737
772
|
"""
|
|
738
773
|
|
|
739
774
|
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
@@ -812,10 +847,13 @@ class CollectionsApi(object):
|
|
|
812
847
|
Remove a note from a(n) collection
|
|
813
848
|
This method makes a synchronous HTTP request by default.
|
|
814
849
|
|
|
815
|
-
:param
|
|
816
|
-
:
|
|
817
|
-
:param
|
|
818
|
-
:
|
|
850
|
+
:param cid:
|
|
851
|
+
:type cid: str
|
|
852
|
+
:param note_id:
|
|
853
|
+
:type note_id: str
|
|
854
|
+
:param async_: Perform the request asynchronously
|
|
855
|
+
:type async_: bool, optional
|
|
856
|
+
:rtype: DeletedResult
|
|
819
857
|
"""
|
|
820
858
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
821
859
|
kwargs['_return_http_data_only'] = True
|
|
@@ -839,10 +877,13 @@ class CollectionsApi(object):
|
|
|
839
877
|
Remove a note from a(n) collection
|
|
840
878
|
This method makes a synchronous HTTP request by default.
|
|
841
879
|
|
|
842
|
-
:param
|
|
843
|
-
:
|
|
844
|
-
:param
|
|
845
|
-
:
|
|
880
|
+
:param cid:
|
|
881
|
+
:type cid: str
|
|
882
|
+
:param note_id:
|
|
883
|
+
:type note_id: str
|
|
884
|
+
:param async_: Perform the request asynchronously
|
|
885
|
+
:type async_: bool, optional
|
|
886
|
+
:rtype: DeletedResult
|
|
846
887
|
"""
|
|
847
888
|
|
|
848
889
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -917,10 +958,13 @@ class CollectionsApi(object):
|
|
|
917
958
|
Delete a tag
|
|
918
959
|
This method makes a synchronous HTTP request by default.
|
|
919
960
|
|
|
920
|
-
:param
|
|
921
|
-
:
|
|
922
|
-
:param
|
|
923
|
-
:
|
|
961
|
+
:param cid:
|
|
962
|
+
:type cid: str
|
|
963
|
+
:param value: The tag to interact with
|
|
964
|
+
:type value: str
|
|
965
|
+
:param async_: Perform the request asynchronously
|
|
966
|
+
:type async_: bool, optional
|
|
967
|
+
:rtype: DeletedResult
|
|
924
968
|
"""
|
|
925
969
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
926
970
|
kwargs['_return_http_data_only'] = True
|
|
@@ -944,10 +988,13 @@ class CollectionsApi(object):
|
|
|
944
988
|
Delete a tag
|
|
945
989
|
This method makes a synchronous HTTP request by default.
|
|
946
990
|
|
|
947
|
-
:param
|
|
948
|
-
:
|
|
949
|
-
:param
|
|
950
|
-
:
|
|
991
|
+
:param cid:
|
|
992
|
+
:type cid: str
|
|
993
|
+
:param value: The tag to interact with
|
|
994
|
+
:type value: str
|
|
995
|
+
:param async_: Perform the request asynchronously
|
|
996
|
+
:type async_: bool, optional
|
|
997
|
+
:rtype: DeletedResult
|
|
951
998
|
"""
|
|
952
999
|
|
|
953
1000
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -1022,10 +1069,13 @@ class CollectionsApi(object):
|
|
|
1022
1069
|
Delete multiple tags from a(n) collection
|
|
1023
1070
|
This method makes a synchronous HTTP request by default.
|
|
1024
1071
|
|
|
1025
|
-
:param
|
|
1026
|
-
:
|
|
1027
|
-
:param
|
|
1028
|
-
:
|
|
1072
|
+
:param cid:
|
|
1073
|
+
:type cid: str
|
|
1074
|
+
:param body:
|
|
1075
|
+
:type body: list[str]
|
|
1076
|
+
:param async_: Perform the request asynchronously
|
|
1077
|
+
:type async_: bool, optional
|
|
1078
|
+
:rtype: None
|
|
1029
1079
|
"""
|
|
1030
1080
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1031
1081
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1049,10 +1099,13 @@ class CollectionsApi(object):
|
|
|
1049
1099
|
Delete multiple tags from a(n) collection
|
|
1050
1100
|
This method makes a synchronous HTTP request by default.
|
|
1051
1101
|
|
|
1052
|
-
:param
|
|
1053
|
-
:
|
|
1054
|
-
:param
|
|
1055
|
-
:
|
|
1102
|
+
:param cid:
|
|
1103
|
+
:type cid: str
|
|
1104
|
+
:param body:
|
|
1105
|
+
:type body: list[str]
|
|
1106
|
+
:param async_: Perform the request asynchronously
|
|
1107
|
+
:type async_: bool, optional
|
|
1108
|
+
:rtype: None
|
|
1056
1109
|
"""
|
|
1057
1110
|
|
|
1058
1111
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -1131,10 +1184,13 @@ class CollectionsApi(object):
|
|
|
1131
1184
|
Delete a permission
|
|
1132
1185
|
This method makes a synchronous HTTP request by default.
|
|
1133
1186
|
|
|
1134
|
-
:param
|
|
1135
|
-
:
|
|
1136
|
-
:param
|
|
1137
|
-
:
|
|
1187
|
+
:param collection_id:
|
|
1188
|
+
:type collection_id: str
|
|
1189
|
+
:param user_id:
|
|
1190
|
+
:type user_id: str
|
|
1191
|
+
:param async_: Perform the request asynchronously
|
|
1192
|
+
:type async_: bool, optional
|
|
1193
|
+
:rtype: ModifiedResult
|
|
1138
1194
|
"""
|
|
1139
1195
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1140
1196
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1158,10 +1214,13 @@ class CollectionsApi(object):
|
|
|
1158
1214
|
Delete a permission
|
|
1159
1215
|
This method makes a synchronous HTTP request by default.
|
|
1160
1216
|
|
|
1161
|
-
:param
|
|
1162
|
-
:
|
|
1163
|
-
:param
|
|
1164
|
-
:
|
|
1217
|
+
:param collection_id:
|
|
1218
|
+
:type collection_id: str
|
|
1219
|
+
:param user_id:
|
|
1220
|
+
:type user_id: str
|
|
1221
|
+
:param async_: Perform the request asynchronously
|
|
1222
|
+
:type async_: bool, optional
|
|
1223
|
+
:rtype: ModifiedResult
|
|
1165
1224
|
"""
|
|
1166
1225
|
|
|
1167
1226
|
all_params = ['collection_id','user_id',] # noqa: E501
|
|
@@ -1236,10 +1295,13 @@ class CollectionsApi(object):
|
|
|
1236
1295
|
Delete multiple collections by ID list
|
|
1237
1296
|
This method makes a synchronous HTTP request by default.
|
|
1238
1297
|
|
|
1239
|
-
:param
|
|
1240
|
-
:
|
|
1241
|
-
:param
|
|
1242
|
-
:
|
|
1298
|
+
:param body: List of IDs to delete
|
|
1299
|
+
:type body: list[str]
|
|
1300
|
+
:param delete_reason:
|
|
1301
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1302
|
+
:param async_: Perform the request asynchronously
|
|
1303
|
+
:type async_: bool, optional
|
|
1304
|
+
:rtype: DeletedResult
|
|
1243
1305
|
"""
|
|
1244
1306
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1245
1307
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1263,10 +1325,13 @@ class CollectionsApi(object):
|
|
|
1263
1325
|
Delete multiple collections by ID list
|
|
1264
1326
|
This method makes a synchronous HTTP request by default.
|
|
1265
1327
|
|
|
1266
|
-
:param
|
|
1267
|
-
:
|
|
1268
|
-
:param
|
|
1269
|
-
:
|
|
1328
|
+
:param body: List of IDs to delete
|
|
1329
|
+
:type body: list[str]
|
|
1330
|
+
:param delete_reason:
|
|
1331
|
+
:type delete_reason: ContainerDeleteReason, optional
|
|
1332
|
+
:param async_: Perform the request asynchronously
|
|
1333
|
+
:type async_: bool, optional
|
|
1334
|
+
:rtype: DeletedResult
|
|
1270
1335
|
"""
|
|
1271
1336
|
|
|
1272
1337
|
all_params = ['body','delete_reason',] # noqa: E501
|
|
@@ -1341,18 +1406,29 @@ class CollectionsApi(object):
|
|
|
1341
1406
|
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.
|
|
1342
1407
|
This method makes a synchronous HTTP request by default.
|
|
1343
1408
|
|
|
1344
|
-
:param
|
|
1345
|
-
:
|
|
1346
|
-
:param
|
|
1347
|
-
:
|
|
1348
|
-
:param
|
|
1349
|
-
:
|
|
1350
|
-
:param
|
|
1351
|
-
:
|
|
1352
|
-
:param
|
|
1353
|
-
:
|
|
1354
|
-
:param
|
|
1355
|
-
:
|
|
1409
|
+
:param collection_id: 24-character hex ID
|
|
1410
|
+
:type collection_id: str
|
|
1411
|
+
:param file_name: output file name
|
|
1412
|
+
:type file_name: str
|
|
1413
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1414
|
+
:type info: bool, optional
|
|
1415
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1416
|
+
:type member: str, optional
|
|
1417
|
+
: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
|
|
1418
|
+
:type view: bool, optional
|
|
1419
|
+
:param version: version of the file to download
|
|
1420
|
+
:type version: int, optional
|
|
1421
|
+
:param hash: file hash for comparison
|
|
1422
|
+
:type hash: str, optional
|
|
1423
|
+
:param range: byte ranges to return
|
|
1424
|
+
:type range: str, optional
|
|
1425
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1426
|
+
:type x_accept_feature: list[str], optional
|
|
1427
|
+
:param dest_file: Destination file path
|
|
1428
|
+
:type dest_file: str
|
|
1429
|
+
:param async_: Perform the request asynchronously
|
|
1430
|
+
:type async_: bool, optional
|
|
1431
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1356
1432
|
"""
|
|
1357
1433
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1358
1434
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1375,17 +1451,27 @@ class CollectionsApi(object):
|
|
|
1375
1451
|
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.
|
|
1376
1452
|
This method makes a synchronous HTTP request by default.
|
|
1377
1453
|
|
|
1378
|
-
:param
|
|
1379
|
-
:
|
|
1380
|
-
:param
|
|
1381
|
-
:
|
|
1382
|
-
:param
|
|
1383
|
-
:
|
|
1384
|
-
:param
|
|
1385
|
-
:
|
|
1386
|
-
:param
|
|
1387
|
-
:
|
|
1388
|
-
:
|
|
1454
|
+
:param collection_id: 24-character hex ID
|
|
1455
|
+
:type collection_id: str
|
|
1456
|
+
:param file_name: output file name
|
|
1457
|
+
:type file_name: str
|
|
1458
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1459
|
+
:type info: bool, optional
|
|
1460
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1461
|
+
:type member: str, optional
|
|
1462
|
+
: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
|
|
1463
|
+
:type view: bool, optional
|
|
1464
|
+
:param version: version of the file to download
|
|
1465
|
+
:type version: int, optional
|
|
1466
|
+
:param hash: file hash for comparison
|
|
1467
|
+
:type hash: str, optional
|
|
1468
|
+
:param range: byte ranges to return
|
|
1469
|
+
:type range: str, optional
|
|
1470
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1471
|
+
:type x_accept_feature: list[str], optional
|
|
1472
|
+
:param async_: Perform the request asynchronously
|
|
1473
|
+
:type async_: bool, optional
|
|
1474
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1389
1475
|
"""
|
|
1390
1476
|
|
|
1391
1477
|
all_params = ['collection_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1475,18 +1561,29 @@ class CollectionsApi(object):
|
|
|
1475
1561
|
Does not work on files whose names contain a forward slash.
|
|
1476
1562
|
This method makes a synchronous HTTP request by default.
|
|
1477
1563
|
|
|
1478
|
-
:param
|
|
1479
|
-
:
|
|
1480
|
-
:param
|
|
1481
|
-
:
|
|
1482
|
-
:param
|
|
1483
|
-
:
|
|
1484
|
-
:param
|
|
1485
|
-
:
|
|
1486
|
-
:param
|
|
1487
|
-
:
|
|
1488
|
-
:param
|
|
1489
|
-
:
|
|
1564
|
+
:param collection_id: 24-character hex ID
|
|
1565
|
+
:type collection_id: str
|
|
1566
|
+
:param file_name: output file name
|
|
1567
|
+
:type file_name: str
|
|
1568
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1569
|
+
:type ticket: str, optional
|
|
1570
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1571
|
+
:type info: bool, optional
|
|
1572
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1573
|
+
:type member: str, optional
|
|
1574
|
+
: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
|
|
1575
|
+
:type view: bool, optional
|
|
1576
|
+
:param version: version of the file to download
|
|
1577
|
+
:type version: int, optional
|
|
1578
|
+
:param hash: file hash for comparison
|
|
1579
|
+
:type hash: str, optional
|
|
1580
|
+
:param range: byte ranges to return
|
|
1581
|
+
:type range: str, optional
|
|
1582
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1583
|
+
:type x_accept_feature: list[str], optional
|
|
1584
|
+
:param async_: Perform the request asynchronously
|
|
1585
|
+
:type async_: bool, optional
|
|
1586
|
+
:rtype: FileZipInfo
|
|
1490
1587
|
"""
|
|
1491
1588
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1492
1589
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1510,18 +1607,29 @@ class CollectionsApi(object):
|
|
|
1510
1607
|
Does not work on files whose names contain a forward slash.
|
|
1511
1608
|
This method makes a synchronous HTTP request by default.
|
|
1512
1609
|
|
|
1513
|
-
:param
|
|
1514
|
-
:
|
|
1515
|
-
:param
|
|
1516
|
-
:
|
|
1517
|
-
:param
|
|
1518
|
-
:
|
|
1519
|
-
:param
|
|
1520
|
-
:
|
|
1521
|
-
:param
|
|
1522
|
-
:
|
|
1523
|
-
:param
|
|
1524
|
-
:
|
|
1610
|
+
:param collection_id: 24-character hex ID
|
|
1611
|
+
:type collection_id: str
|
|
1612
|
+
:param file_name: output file name
|
|
1613
|
+
:type file_name: str
|
|
1614
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1615
|
+
:type ticket: str, optional
|
|
1616
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1617
|
+
:type info: bool, optional
|
|
1618
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1619
|
+
:type member: str, optional
|
|
1620
|
+
: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
|
|
1621
|
+
:type view: bool, optional
|
|
1622
|
+
:param version: version of the file to download
|
|
1623
|
+
:type version: int, optional
|
|
1624
|
+
:param hash: file hash for comparison
|
|
1625
|
+
:type hash: str, optional
|
|
1626
|
+
:param range: byte ranges to return
|
|
1627
|
+
:type range: str, optional
|
|
1628
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1629
|
+
:type x_accept_feature: list[str], optional
|
|
1630
|
+
:param async_: Perform the request asynchronously
|
|
1631
|
+
:type async_: bool, optional
|
|
1632
|
+
:rtype: FileZipInfo
|
|
1525
1633
|
"""
|
|
1526
1634
|
|
|
1527
1635
|
all_params = ['collection_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1614,18 +1722,29 @@ class CollectionsApi(object):
|
|
|
1614
1722
|
|
|
1615
1723
|
This method makes a synchronous HTTP request by default.
|
|
1616
1724
|
|
|
1617
|
-
:param
|
|
1618
|
-
:
|
|
1619
|
-
:param
|
|
1620
|
-
:
|
|
1621
|
-
:param
|
|
1622
|
-
:
|
|
1623
|
-
:param
|
|
1624
|
-
:
|
|
1625
|
-
:param
|
|
1626
|
-
:
|
|
1627
|
-
:param
|
|
1628
|
-
:
|
|
1725
|
+
:param collection_id: 24-character hex ID
|
|
1726
|
+
:type collection_id: str
|
|
1727
|
+
:param file_name: output file name
|
|
1728
|
+
:type file_name: str
|
|
1729
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1730
|
+
:type ticket: str, optional
|
|
1731
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1732
|
+
:type info: bool, optional
|
|
1733
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1734
|
+
:type member: str, optional
|
|
1735
|
+
:param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
|
|
1736
|
+
:type view: bool, optional
|
|
1737
|
+
:param version: version of the file to download
|
|
1738
|
+
:type version: int, optional
|
|
1739
|
+
:param hash: file hash for comparison
|
|
1740
|
+
:type hash: str, optional
|
|
1741
|
+
:param range: byte ranges to return
|
|
1742
|
+
:type range: str, optional
|
|
1743
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1744
|
+
:type x_accept_feature: list[str], optional
|
|
1745
|
+
:param async_: Perform the request asynchronously
|
|
1746
|
+
:type async_: bool, optional
|
|
1747
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1629
1748
|
"""
|
|
1630
1749
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1631
1750
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1648,18 +1767,29 @@ class CollectionsApi(object):
|
|
|
1648
1767
|
|
|
1649
1768
|
This method makes a synchronous HTTP request by default.
|
|
1650
1769
|
|
|
1651
|
-
:param
|
|
1652
|
-
:
|
|
1653
|
-
:param
|
|
1654
|
-
:
|
|
1655
|
-
:param
|
|
1656
|
-
:
|
|
1657
|
-
:param
|
|
1658
|
-
:
|
|
1659
|
-
:param
|
|
1660
|
-
:
|
|
1661
|
-
:param
|
|
1662
|
-
:
|
|
1770
|
+
:param collection_id: 24-character hex ID
|
|
1771
|
+
:type collection_id: str
|
|
1772
|
+
:param file_name: output file name
|
|
1773
|
+
:type file_name: str
|
|
1774
|
+
:param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1775
|
+
:type ticket: str, optional
|
|
1776
|
+
:param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
|
|
1777
|
+
:type info: bool, optional
|
|
1778
|
+
:param member: The filename of a zipfile member to download rather than the entire file
|
|
1779
|
+
:type member: str, optional
|
|
1780
|
+
: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
|
|
1781
|
+
:type view: bool, optional
|
|
1782
|
+
:param version: version of the file to download
|
|
1783
|
+
:type version: int, optional
|
|
1784
|
+
:param hash: file hash for comparison
|
|
1785
|
+
:type hash: str, optional
|
|
1786
|
+
:param range: byte ranges to return
|
|
1787
|
+
:type range: str, optional
|
|
1788
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
1789
|
+
:type x_accept_feature: list[str], optional
|
|
1790
|
+
:param async_: Perform the request asynchronously
|
|
1791
|
+
:type async_: bool, optional
|
|
1792
|
+
:rtype: union[DownloadTicketStub,ZipfileInfo]
|
|
1663
1793
|
"""
|
|
1664
1794
|
|
|
1665
1795
|
all_params = ['collection_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
@@ -1751,22 +1881,37 @@ class CollectionsApi(object):
|
|
|
1751
1881
|
List all collections.
|
|
1752
1882
|
This method makes a synchronous HTTP request by default.
|
|
1753
1883
|
|
|
1754
|
-
:param
|
|
1755
|
-
:
|
|
1756
|
-
:param
|
|
1757
|
-
:
|
|
1758
|
-
:param
|
|
1759
|
-
:
|
|
1760
|
-
:param
|
|
1761
|
-
:
|
|
1762
|
-
:param
|
|
1763
|
-
:
|
|
1764
|
-
:param
|
|
1765
|
-
:
|
|
1766
|
-
:param
|
|
1767
|
-
:
|
|
1768
|
-
:param
|
|
1769
|
-
:
|
|
1884
|
+
:param exhaustive:, defaults to false
|
|
1885
|
+
:type exhaustive: bool, optional
|
|
1886
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
1887
|
+
:type join_avatars: bool, optional
|
|
1888
|
+
:param join_files:, defaults to true
|
|
1889
|
+
:type join_files: bool, optional
|
|
1890
|
+
:param join:
|
|
1891
|
+
:type join: JoinType, optional
|
|
1892
|
+
:param stats:, defaults to false
|
|
1893
|
+
:type stats: bool, optional
|
|
1894
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
1895
|
+
:type include_all_info: bool, optional
|
|
1896
|
+
:param user_id:
|
|
1897
|
+
:type user_id: str, optional
|
|
1898
|
+
: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)
|
|
1899
|
+
:type filter: str, optional
|
|
1900
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1901
|
+
:type sort: str, optional
|
|
1902
|
+
:param limit: The maximum number of entries to return.
|
|
1903
|
+
:type limit: int, optional
|
|
1904
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
1905
|
+
:type skip: int, optional
|
|
1906
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
1907
|
+
:type page: int, optional
|
|
1908
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
1909
|
+
:type after_id: str, optional
|
|
1910
|
+
:param x_accept_feature:, defaults to []
|
|
1911
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
1912
|
+
:param async_: Perform the request asynchronously
|
|
1913
|
+
:type async_: bool, optional
|
|
1914
|
+
:rtype: union[Page,list[CollectionWithStats],list[CollectionOutput]]
|
|
1770
1915
|
"""
|
|
1771
1916
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1772
1917
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1790,22 +1935,37 @@ class CollectionsApi(object):
|
|
|
1790
1935
|
List all collections.
|
|
1791
1936
|
This method makes a synchronous HTTP request by default.
|
|
1792
1937
|
|
|
1793
|
-
:param
|
|
1794
|
-
:
|
|
1795
|
-
:param
|
|
1796
|
-
:
|
|
1797
|
-
:param
|
|
1798
|
-
:
|
|
1799
|
-
:param
|
|
1800
|
-
:
|
|
1801
|
-
:param
|
|
1802
|
-
:
|
|
1803
|
-
:param
|
|
1804
|
-
:
|
|
1805
|
-
:param
|
|
1806
|
-
:
|
|
1807
|
-
:param
|
|
1808
|
-
:
|
|
1938
|
+
:param exhaustive:, defaults to false
|
|
1939
|
+
:type exhaustive: bool, optional
|
|
1940
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
1941
|
+
:type join_avatars: bool, optional
|
|
1942
|
+
:param join_files:, defaults to true
|
|
1943
|
+
:type join_files: bool, optional
|
|
1944
|
+
:param join:
|
|
1945
|
+
:type join: JoinType, optional
|
|
1946
|
+
:param stats:, defaults to false
|
|
1947
|
+
:type stats: bool, optional
|
|
1948
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
1949
|
+
:type include_all_info: bool, optional
|
|
1950
|
+
:param user_id:
|
|
1951
|
+
:type user_id: str, optional
|
|
1952
|
+
: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)
|
|
1953
|
+
:type filter: str, optional
|
|
1954
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1955
|
+
:type sort: str, optional
|
|
1956
|
+
:param limit: The maximum number of entries to return.
|
|
1957
|
+
:type limit: int, optional
|
|
1958
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
1959
|
+
:type skip: int, optional
|
|
1960
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
1961
|
+
:type page: int, optional
|
|
1962
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
1963
|
+
:type after_id: str, optional
|
|
1964
|
+
:param x_accept_feature:, defaults to []
|
|
1965
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
1966
|
+
:param async_: Perform the request asynchronously
|
|
1967
|
+
:type async_: bool, optional
|
|
1968
|
+
:rtype: union[Page,list[CollectionWithStats],list[CollectionOutput]]
|
|
1809
1969
|
"""
|
|
1810
1970
|
|
|
1811
1971
|
all_params = ['exhaustive','join_avatars','join_files','join','stats','include_all_info','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -1897,14 +2057,21 @@ class CollectionsApi(object):
|
|
|
1897
2057
|
List all curators of collections
|
|
1898
2058
|
This method makes a synchronous HTTP request by default.
|
|
1899
2059
|
|
|
1900
|
-
:param
|
|
1901
|
-
:
|
|
1902
|
-
:param
|
|
1903
|
-
:
|
|
1904
|
-
:param
|
|
1905
|
-
:
|
|
1906
|
-
:param
|
|
1907
|
-
:
|
|
2060
|
+
: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)
|
|
2061
|
+
:type filter: str, optional
|
|
2062
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2063
|
+
:type sort: str, optional
|
|
2064
|
+
:param limit: The maximum number of entries to return.
|
|
2065
|
+
:type limit: int, optional
|
|
2066
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2067
|
+
:type skip: int, optional
|
|
2068
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2069
|
+
:type page: int, optional
|
|
2070
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2071
|
+
:type after_id: str, optional
|
|
2072
|
+
:param async_: Perform the request asynchronously
|
|
2073
|
+
:type async_: bool, optional
|
|
2074
|
+
:rtype: list[Curator]
|
|
1908
2075
|
"""
|
|
1909
2076
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1910
2077
|
kwargs['_return_http_data_only'] = True
|
|
@@ -1928,14 +2095,21 @@ class CollectionsApi(object):
|
|
|
1928
2095
|
List all curators of collections
|
|
1929
2096
|
This method makes a synchronous HTTP request by default.
|
|
1930
2097
|
|
|
1931
|
-
:param
|
|
1932
|
-
:
|
|
1933
|
-
:param
|
|
1934
|
-
:
|
|
1935
|
-
:param
|
|
1936
|
-
:
|
|
1937
|
-
:param
|
|
1938
|
-
:
|
|
2098
|
+
: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)
|
|
2099
|
+
:type filter: str, optional
|
|
2100
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2101
|
+
:type sort: str, optional
|
|
2102
|
+
:param limit: The maximum number of entries to return.
|
|
2103
|
+
:type limit: int, optional
|
|
2104
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2105
|
+
:type skip: int, optional
|
|
2106
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2107
|
+
:type page: int, optional
|
|
2108
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2109
|
+
:type after_id: str, optional
|
|
2110
|
+
:param async_: Perform the request asynchronously
|
|
2111
|
+
:type async_: bool, optional
|
|
2112
|
+
:rtype: list[Curator]
|
|
1939
2113
|
"""
|
|
1940
2114
|
|
|
1941
2115
|
all_params = ['filter','sort','limit','skip','page','after_id',] # noqa: E501
|
|
@@ -2010,12 +2184,17 @@ class CollectionsApi(object):
|
|
|
2010
2184
|
Retrieve a single collection
|
|
2011
2185
|
This method makes a synchronous HTTP request by default.
|
|
2012
2186
|
|
|
2013
|
-
:param
|
|
2014
|
-
:
|
|
2015
|
-
:param
|
|
2016
|
-
:
|
|
2017
|
-
:param
|
|
2018
|
-
:
|
|
2187
|
+
:param collection_id:
|
|
2188
|
+
:type collection_id: str
|
|
2189
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
2190
|
+
:type join_avatars: bool, optional
|
|
2191
|
+
:param join:
|
|
2192
|
+
:type join: JoinType, optional
|
|
2193
|
+
:param x_accept_feature:, defaults to []
|
|
2194
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
2195
|
+
:param async_: Perform the request asynchronously
|
|
2196
|
+
:type async_: bool, optional
|
|
2197
|
+
:rtype: CollectionOutput
|
|
2019
2198
|
"""
|
|
2020
2199
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2021
2200
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2039,12 +2218,17 @@ class CollectionsApi(object):
|
|
|
2039
2218
|
Retrieve a single collection
|
|
2040
2219
|
This method makes a synchronous HTTP request by default.
|
|
2041
2220
|
|
|
2042
|
-
:param
|
|
2043
|
-
:
|
|
2044
|
-
:param
|
|
2045
|
-
:
|
|
2046
|
-
:param
|
|
2047
|
-
:
|
|
2221
|
+
:param collection_id:
|
|
2222
|
+
:type collection_id: str
|
|
2223
|
+
:param join_avatars: add name and avatar to notes, defaults to false
|
|
2224
|
+
:type join_avatars: bool, optional
|
|
2225
|
+
:param join:
|
|
2226
|
+
:type join: JoinType, optional
|
|
2227
|
+
:param x_accept_feature:, defaults to []
|
|
2228
|
+
:type x_accept_feature: list[union[HeaderFeature,str]], optional
|
|
2229
|
+
:param async_: Perform the request asynchronously
|
|
2230
|
+
:type async_: bool, optional
|
|
2231
|
+
:rtype: CollectionOutput
|
|
2048
2232
|
"""
|
|
2049
2233
|
|
|
2050
2234
|
all_params = ['collection_id','join_avatars','join','x_accept_feature',] # noqa: E501
|
|
@@ -2120,17 +2304,27 @@ class CollectionsApi(object):
|
|
|
2120
2304
|
List acquisitions in a collection
|
|
2121
2305
|
This method makes a synchronous HTTP request by default.
|
|
2122
2306
|
|
|
2123
|
-
:param
|
|
2124
|
-
:
|
|
2125
|
-
:param
|
|
2126
|
-
:
|
|
2127
|
-
:param
|
|
2128
|
-
:
|
|
2129
|
-
:param
|
|
2130
|
-
:
|
|
2131
|
-
:param
|
|
2132
|
-
:
|
|
2133
|
-
:
|
|
2307
|
+
:param collection_id:
|
|
2308
|
+
:type collection_id: str
|
|
2309
|
+
:param session: The id of a session, to which the acquisitions returned will be restricted
|
|
2310
|
+
:type session: str, optional
|
|
2311
|
+
: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)
|
|
2312
|
+
:type filter: str, optional
|
|
2313
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2314
|
+
:type sort: str, optional
|
|
2315
|
+
:param limit: The maximum number of entries to return.
|
|
2316
|
+
:type limit: int, optional
|
|
2317
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2318
|
+
:type skip: int, optional
|
|
2319
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2320
|
+
:type page: int, optional
|
|
2321
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2322
|
+
:type after_id: str, optional
|
|
2323
|
+
:param x_accept_feature:, defaults to []
|
|
2324
|
+
:type x_accept_feature: list[str], optional
|
|
2325
|
+
:param async_: Perform the request asynchronously
|
|
2326
|
+
:type async_: bool, optional
|
|
2327
|
+
:rtype: union[list[AcquisitionListOutput],Page]
|
|
2134
2328
|
"""
|
|
2135
2329
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2136
2330
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2154,17 +2348,27 @@ class CollectionsApi(object):
|
|
|
2154
2348
|
List acquisitions in a collection
|
|
2155
2349
|
This method makes a synchronous HTTP request by default.
|
|
2156
2350
|
|
|
2157
|
-
:param
|
|
2158
|
-
:
|
|
2159
|
-
:param
|
|
2160
|
-
:
|
|
2161
|
-
:param
|
|
2162
|
-
:
|
|
2163
|
-
:param
|
|
2164
|
-
:
|
|
2165
|
-
:param
|
|
2166
|
-
:
|
|
2167
|
-
:
|
|
2351
|
+
:param collection_id:
|
|
2352
|
+
:type collection_id: str
|
|
2353
|
+
:param session: The id of a session, to which the acquisitions returned will be restricted
|
|
2354
|
+
:type session: str, optional
|
|
2355
|
+
: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)
|
|
2356
|
+
:type filter: str, optional
|
|
2357
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2358
|
+
:type sort: str, optional
|
|
2359
|
+
:param limit: The maximum number of entries to return.
|
|
2360
|
+
:type limit: int, optional
|
|
2361
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2362
|
+
:type skip: int, optional
|
|
2363
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2364
|
+
:type page: int, optional
|
|
2365
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2366
|
+
:type after_id: str, optional
|
|
2367
|
+
:param x_accept_feature:, defaults to []
|
|
2368
|
+
:type x_accept_feature: list[str], optional
|
|
2369
|
+
:param async_: Perform the request asynchronously
|
|
2370
|
+
:type async_: bool, optional
|
|
2371
|
+
:rtype: union[list[AcquisitionListOutput],Page]
|
|
2168
2372
|
"""
|
|
2169
2373
|
|
|
2170
2374
|
all_params = ['collection_id','session','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -2250,10 +2454,13 @@ class CollectionsApi(object):
|
|
|
2250
2454
|
Get info for a particular file.
|
|
2251
2455
|
This method makes a synchronous HTTP request by default.
|
|
2252
2456
|
|
|
2253
|
-
:param
|
|
2254
|
-
:
|
|
2255
|
-
:param
|
|
2256
|
-
:
|
|
2457
|
+
:param cid: Container Id
|
|
2458
|
+
:type cid: str
|
|
2459
|
+
:param filename:
|
|
2460
|
+
:type filename: str
|
|
2461
|
+
:param async_: Perform the request asynchronously
|
|
2462
|
+
:type async_: bool, optional
|
|
2463
|
+
:rtype: FileOutput
|
|
2257
2464
|
"""
|
|
2258
2465
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2259
2466
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2277,10 +2484,13 @@ class CollectionsApi(object):
|
|
|
2277
2484
|
Get info for a particular file.
|
|
2278
2485
|
This method makes a synchronous HTTP request by default.
|
|
2279
2486
|
|
|
2280
|
-
:param
|
|
2281
|
-
:
|
|
2282
|
-
:param
|
|
2283
|
-
:
|
|
2487
|
+
:param cid: Container Id
|
|
2488
|
+
:type cid: str
|
|
2489
|
+
:param filename:
|
|
2490
|
+
:type filename: str
|
|
2491
|
+
:param async_: Perform the request asynchronously
|
|
2492
|
+
:type async_: bool, optional
|
|
2493
|
+
:rtype: FileOutput
|
|
2284
2494
|
"""
|
|
2285
2495
|
|
|
2286
2496
|
all_params = ['cid','filename',] # noqa: E501
|
|
@@ -2355,10 +2565,13 @@ class CollectionsApi(object):
|
|
|
2355
2565
|
Get a note of a(n) collection
|
|
2356
2566
|
This method makes a synchronous HTTP request by default.
|
|
2357
2567
|
|
|
2358
|
-
:param
|
|
2359
|
-
:
|
|
2360
|
-
:param
|
|
2361
|
-
:
|
|
2568
|
+
:param cid:
|
|
2569
|
+
:type cid: str
|
|
2570
|
+
:param note_id:
|
|
2571
|
+
:type note_id: str
|
|
2572
|
+
:param async_: Perform the request asynchronously
|
|
2573
|
+
:type async_: bool, optional
|
|
2574
|
+
:rtype: Note
|
|
2362
2575
|
"""
|
|
2363
2576
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2364
2577
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2382,10 +2595,13 @@ class CollectionsApi(object):
|
|
|
2382
2595
|
Get a note of a(n) collection
|
|
2383
2596
|
This method makes a synchronous HTTP request by default.
|
|
2384
2597
|
|
|
2385
|
-
:param
|
|
2386
|
-
:
|
|
2387
|
-
:param
|
|
2388
|
-
:
|
|
2598
|
+
:param cid:
|
|
2599
|
+
:type cid: str
|
|
2600
|
+
:param note_id:
|
|
2601
|
+
:type note_id: str
|
|
2602
|
+
:param async_: Perform the request asynchronously
|
|
2603
|
+
:type async_: bool, optional
|
|
2604
|
+
:rtype: Note
|
|
2389
2605
|
"""
|
|
2390
2606
|
|
|
2391
2607
|
all_params = ['cid','note_id',] # noqa: E501
|
|
@@ -2460,17 +2676,27 @@ class CollectionsApi(object):
|
|
|
2460
2676
|
List sessions in a collection.
|
|
2461
2677
|
This method makes a synchronous HTTP request by default.
|
|
2462
2678
|
|
|
2463
|
-
:param
|
|
2464
|
-
:
|
|
2465
|
-
:param
|
|
2466
|
-
:
|
|
2467
|
-
:param
|
|
2468
|
-
:
|
|
2469
|
-
:param
|
|
2470
|
-
:
|
|
2471
|
-
:param
|
|
2472
|
-
:
|
|
2473
|
-
:
|
|
2679
|
+
:param collection_id:
|
|
2680
|
+
:type collection_id: str
|
|
2681
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
2682
|
+
:type include_all_info: bool, optional
|
|
2683
|
+
: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)
|
|
2684
|
+
:type filter: str, optional
|
|
2685
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2686
|
+
:type sort: str, optional
|
|
2687
|
+
:param limit: The maximum number of entries to return.
|
|
2688
|
+
:type limit: int, optional
|
|
2689
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2690
|
+
:type skip: int, optional
|
|
2691
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2692
|
+
:type page: int, optional
|
|
2693
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2694
|
+
:type after_id: str, optional
|
|
2695
|
+
:param x_accept_feature:, defaults to []
|
|
2696
|
+
:type x_accept_feature: list[str], optional
|
|
2697
|
+
:param async_: Perform the request asynchronously
|
|
2698
|
+
:type async_: bool, optional
|
|
2699
|
+
:rtype: union[list[SessionListOutput],Page]
|
|
2474
2700
|
"""
|
|
2475
2701
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2476
2702
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2494,17 +2720,27 @@ class CollectionsApi(object):
|
|
|
2494
2720
|
List sessions in a collection.
|
|
2495
2721
|
This method makes a synchronous HTTP request by default.
|
|
2496
2722
|
|
|
2497
|
-
:param
|
|
2498
|
-
:
|
|
2499
|
-
:param
|
|
2500
|
-
:
|
|
2501
|
-
:param
|
|
2502
|
-
:
|
|
2503
|
-
:param
|
|
2504
|
-
:
|
|
2505
|
-
:param
|
|
2506
|
-
:
|
|
2507
|
-
:
|
|
2723
|
+
:param collection_id:
|
|
2724
|
+
:type collection_id: str
|
|
2725
|
+
:param include_all_info: Include all info in returned objects, defaults to false
|
|
2726
|
+
:type include_all_info: bool, optional
|
|
2727
|
+
: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)
|
|
2728
|
+
:type filter: str, optional
|
|
2729
|
+
:param sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2730
|
+
:type sort: str, optional
|
|
2731
|
+
:param limit: The maximum number of entries to return.
|
|
2732
|
+
:type limit: int, optional
|
|
2733
|
+
:param skip: The number of entries to skip., defaults to 0
|
|
2734
|
+
:type skip: int, optional
|
|
2735
|
+
:param page: The page number (i.e. skip limit*page entries)
|
|
2736
|
+
:type page: int, optional
|
|
2737
|
+
:param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2738
|
+
:type after_id: str, optional
|
|
2739
|
+
:param x_accept_feature:, defaults to []
|
|
2740
|
+
:type x_accept_feature: list[str], optional
|
|
2741
|
+
:param async_: Perform the request asynchronously
|
|
2742
|
+
:type async_: bool, optional
|
|
2743
|
+
:rtype: union[list[SessionListOutput],Page]
|
|
2508
2744
|
"""
|
|
2509
2745
|
|
|
2510
2746
|
all_params = ['collection_id','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
@@ -2590,10 +2826,13 @@ class CollectionsApi(object):
|
|
|
2590
2826
|
Get the value of a tag, by name
|
|
2591
2827
|
This method makes a synchronous HTTP request by default.
|
|
2592
2828
|
|
|
2593
|
-
:param
|
|
2594
|
-
:
|
|
2595
|
-
:param
|
|
2596
|
-
:
|
|
2829
|
+
:param cid:
|
|
2830
|
+
:type cid: str
|
|
2831
|
+
:param value: The tag to interact with
|
|
2832
|
+
:type value: str
|
|
2833
|
+
:param async_: Perform the request asynchronously
|
|
2834
|
+
:type async_: bool, optional
|
|
2835
|
+
:rtype: str
|
|
2597
2836
|
"""
|
|
2598
2837
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2599
2838
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2617,10 +2856,13 @@ class CollectionsApi(object):
|
|
|
2617
2856
|
Get the value of a tag, by name
|
|
2618
2857
|
This method makes a synchronous HTTP request by default.
|
|
2619
2858
|
|
|
2620
|
-
:param
|
|
2621
|
-
:
|
|
2622
|
-
:param
|
|
2623
|
-
:
|
|
2859
|
+
:param cid:
|
|
2860
|
+
:type cid: str
|
|
2861
|
+
:param value: The tag to interact with
|
|
2862
|
+
:type value: str
|
|
2863
|
+
:param async_: Perform the request asynchronously
|
|
2864
|
+
:type async_: bool, optional
|
|
2865
|
+
:rtype: str
|
|
2624
2866
|
"""
|
|
2625
2867
|
|
|
2626
2868
|
all_params = ['cid','value',] # noqa: E501
|
|
@@ -2695,10 +2937,13 @@ class CollectionsApi(object):
|
|
|
2695
2937
|
List a user's permissions for this group
|
|
2696
2938
|
This method makes a synchronous HTTP request by default.
|
|
2697
2939
|
|
|
2698
|
-
:param
|
|
2699
|
-
:
|
|
2700
|
-
:param
|
|
2701
|
-
:
|
|
2940
|
+
:param collection_id:
|
|
2941
|
+
:type collection_id: str
|
|
2942
|
+
:param user_id:
|
|
2943
|
+
:type user_id: str
|
|
2944
|
+
:param async_: Perform the request asynchronously
|
|
2945
|
+
:type async_: bool, optional
|
|
2946
|
+
:rtype: AccessPermissionOutput
|
|
2702
2947
|
"""
|
|
2703
2948
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2704
2949
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2722,10 +2967,13 @@ class CollectionsApi(object):
|
|
|
2722
2967
|
List a user's permissions for this group
|
|
2723
2968
|
This method makes a synchronous HTTP request by default.
|
|
2724
2969
|
|
|
2725
|
-
:param
|
|
2726
|
-
:
|
|
2727
|
-
:param
|
|
2728
|
-
:
|
|
2970
|
+
:param collection_id:
|
|
2971
|
+
:type collection_id: str
|
|
2972
|
+
:param user_id:
|
|
2973
|
+
:type user_id: str
|
|
2974
|
+
:param async_: Perform the request asynchronously
|
|
2975
|
+
:type async_: bool, optional
|
|
2976
|
+
:rtype: AccessPermissionOutput
|
|
2729
2977
|
"""
|
|
2730
2978
|
|
|
2731
2979
|
all_params = ['collection_id','user_id',] # noqa: E501
|
|
@@ -2800,10 +3048,13 @@ class CollectionsApi(object):
|
|
|
2800
3048
|
Update a collection and its contents
|
|
2801
3049
|
This method makes a synchronous HTTP request by default.
|
|
2802
3050
|
|
|
2803
|
-
:param
|
|
2804
|
-
:
|
|
2805
|
-
:param
|
|
2806
|
-
:
|
|
3051
|
+
:param collection_id:
|
|
3052
|
+
:type collection_id: str
|
|
3053
|
+
:param body:
|
|
3054
|
+
:type body: CollectionInputWithContents
|
|
3055
|
+
:param async_: Perform the request asynchronously
|
|
3056
|
+
:type async_: bool, optional
|
|
3057
|
+
:rtype: ModifiedResult
|
|
2807
3058
|
"""
|
|
2808
3059
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2809
3060
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2827,10 +3078,13 @@ class CollectionsApi(object):
|
|
|
2827
3078
|
Update a collection and its contents
|
|
2828
3079
|
This method makes a synchronous HTTP request by default.
|
|
2829
3080
|
|
|
2830
|
-
:param
|
|
2831
|
-
:
|
|
2832
|
-
:param
|
|
2833
|
-
:
|
|
3081
|
+
:param collection_id:
|
|
3082
|
+
:type collection_id: str
|
|
3083
|
+
:param body:
|
|
3084
|
+
:type body: CollectionInputWithContents
|
|
3085
|
+
:param async_: Perform the request asynchronously
|
|
3086
|
+
:type async_: bool, optional
|
|
3087
|
+
:rtype: ModifiedResult
|
|
2834
3088
|
"""
|
|
2835
3089
|
|
|
2836
3090
|
all_params = ['collection_id','body',] # noqa: E501
|
|
@@ -2916,11 +3170,15 @@ class CollectionsApi(object):
|
|
|
2916
3170
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2917
3171
|
This method makes a synchronous HTTP request by default.
|
|
2918
3172
|
|
|
2919
|
-
:param
|
|
2920
|
-
:
|
|
2921
|
-
:param
|
|
2922
|
-
:
|
|
2923
|
-
:
|
|
3173
|
+
:param cid:
|
|
3174
|
+
:type cid: str
|
|
3175
|
+
:param filename:
|
|
3176
|
+
:type filename: str
|
|
3177
|
+
:param body:
|
|
3178
|
+
:type body: FileModifyInput
|
|
3179
|
+
:param async_: Perform the request asynchronously
|
|
3180
|
+
:type async_: bool, optional
|
|
3181
|
+
:rtype: ModifiedResult
|
|
2924
3182
|
"""
|
|
2925
3183
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2926
3184
|
kwargs['_return_http_data_only'] = True
|
|
@@ -2944,11 +3202,15 @@ class CollectionsApi(object):
|
|
|
2944
3202
|
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2945
3203
|
This method makes a synchronous HTTP request by default.
|
|
2946
3204
|
|
|
2947
|
-
:param
|
|
2948
|
-
:
|
|
2949
|
-
:param
|
|
2950
|
-
:
|
|
2951
|
-
:
|
|
3205
|
+
:param cid:
|
|
3206
|
+
:type cid: str
|
|
3207
|
+
:param filename:
|
|
3208
|
+
:type filename: str
|
|
3209
|
+
:param body:
|
|
3210
|
+
:type body: FileModifyInput
|
|
3211
|
+
:param async_: Perform the request asynchronously
|
|
3212
|
+
:type async_: bool, optional
|
|
3213
|
+
:rtype: ModifiedResult
|
|
2952
3214
|
"""
|
|
2953
3215
|
|
|
2954
3216
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3040,11 +3302,15 @@ class CollectionsApi(object):
|
|
|
3040
3302
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3041
3303
|
This method makes a synchronous HTTP request by default.
|
|
3042
3304
|
|
|
3043
|
-
:param
|
|
3044
|
-
:
|
|
3045
|
-
:param
|
|
3046
|
-
:
|
|
3047
|
-
:
|
|
3305
|
+
:param cid:
|
|
3306
|
+
:type cid: str
|
|
3307
|
+
:param filename:
|
|
3308
|
+
:type filename: str
|
|
3309
|
+
:param body:
|
|
3310
|
+
:type body: FileClassificationDelta
|
|
3311
|
+
:param async_: Perform the request asynchronously
|
|
3312
|
+
:type async_: bool, optional
|
|
3313
|
+
:rtype: ModifiedResult
|
|
3048
3314
|
"""
|
|
3049
3315
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3050
3316
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3068,11 +3334,15 @@ class CollectionsApi(object):
|
|
|
3068
3334
|
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3069
3335
|
This method makes a synchronous HTTP request by default.
|
|
3070
3336
|
|
|
3071
|
-
:param
|
|
3072
|
-
:
|
|
3073
|
-
:param
|
|
3074
|
-
:
|
|
3075
|
-
:
|
|
3337
|
+
:param cid:
|
|
3338
|
+
:type cid: str
|
|
3339
|
+
:param filename:
|
|
3340
|
+
:type filename: str
|
|
3341
|
+
:param body:
|
|
3342
|
+
:type body: FileClassificationDelta
|
|
3343
|
+
:param async_: Perform the request asynchronously
|
|
3344
|
+
:type async_: bool, optional
|
|
3345
|
+
:rtype: ModifiedResult
|
|
3076
3346
|
"""
|
|
3077
3347
|
|
|
3078
3348
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3164,11 +3434,15 @@ class CollectionsApi(object):
|
|
|
3164
3434
|
Modify and return the file 'info' field
|
|
3165
3435
|
This method makes a synchronous HTTP request by default.
|
|
3166
3436
|
|
|
3167
|
-
:param
|
|
3168
|
-
:
|
|
3169
|
-
:param
|
|
3170
|
-
:
|
|
3171
|
-
:
|
|
3437
|
+
:param cid:
|
|
3438
|
+
:type cid: str
|
|
3439
|
+
:param filename:
|
|
3440
|
+
:type filename: str
|
|
3441
|
+
:param body:
|
|
3442
|
+
:type body: Info
|
|
3443
|
+
:param async_: Perform the request asynchronously
|
|
3444
|
+
:type async_: bool, optional
|
|
3445
|
+
:rtype: ModifiedResult
|
|
3172
3446
|
"""
|
|
3173
3447
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3174
3448
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3192,11 +3466,15 @@ class CollectionsApi(object):
|
|
|
3192
3466
|
Modify and return the file 'info' field
|
|
3193
3467
|
This method makes a synchronous HTTP request by default.
|
|
3194
3468
|
|
|
3195
|
-
:param
|
|
3196
|
-
:
|
|
3197
|
-
:param
|
|
3198
|
-
:
|
|
3199
|
-
:
|
|
3469
|
+
:param cid:
|
|
3470
|
+
:type cid: str
|
|
3471
|
+
:param filename:
|
|
3472
|
+
:type filename: str
|
|
3473
|
+
:param body:
|
|
3474
|
+
:type body: Info
|
|
3475
|
+
:param async_: Perform the request asynchronously
|
|
3476
|
+
:type async_: bool, optional
|
|
3477
|
+
:rtype: ModifiedResult
|
|
3200
3478
|
"""
|
|
3201
3479
|
|
|
3202
3480
|
all_params = ['cid','filename','body',] # noqa: E501
|
|
@@ -3288,10 +3566,13 @@ class CollectionsApi(object):
|
|
|
3288
3566
|
Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
3289
3567
|
This method makes a synchronous HTTP request by default.
|
|
3290
3568
|
|
|
3291
|
-
:param
|
|
3292
|
-
:
|
|
3293
|
-
:param
|
|
3294
|
-
:
|
|
3569
|
+
:param cid:
|
|
3570
|
+
:type cid: str
|
|
3571
|
+
:param body:
|
|
3572
|
+
:type body: Info
|
|
3573
|
+
:param async_: Perform the request asynchronously
|
|
3574
|
+
:type async_: bool, optional
|
|
3575
|
+
:rtype: ModifiedResult
|
|
3295
3576
|
"""
|
|
3296
3577
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3297
3578
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3315,10 +3596,13 @@ class CollectionsApi(object):
|
|
|
3315
3596
|
Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
3316
3597
|
This method makes a synchronous HTTP request by default.
|
|
3317
3598
|
|
|
3318
|
-
:param
|
|
3319
|
-
:
|
|
3320
|
-
:param
|
|
3321
|
-
:
|
|
3599
|
+
:param cid:
|
|
3600
|
+
:type cid: str
|
|
3601
|
+
:param body:
|
|
3602
|
+
:type body: Info
|
|
3603
|
+
:param async_: Perform the request asynchronously
|
|
3604
|
+
:type async_: bool, optional
|
|
3605
|
+
:rtype: ModifiedResult
|
|
3322
3606
|
"""
|
|
3323
3607
|
|
|
3324
3608
|
all_params = ['cid','body',] # noqa: E501
|
|
@@ -3404,11 +3688,15 @@ class CollectionsApi(object):
|
|
|
3404
3688
|
Update a note of a(n) collection
|
|
3405
3689
|
This method makes a synchronous HTTP request by default.
|
|
3406
3690
|
|
|
3407
|
-
:param
|
|
3408
|
-
:
|
|
3409
|
-
:param
|
|
3410
|
-
:
|
|
3411
|
-
:
|
|
3691
|
+
:param cid:
|
|
3692
|
+
:type cid: str
|
|
3693
|
+
:param note_id:
|
|
3694
|
+
:type note_id: str
|
|
3695
|
+
:param body:
|
|
3696
|
+
:type body: NoteInput
|
|
3697
|
+
:param async_: Perform the request asynchronously
|
|
3698
|
+
:type async_: bool, optional
|
|
3699
|
+
:rtype: int
|
|
3412
3700
|
"""
|
|
3413
3701
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3414
3702
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3432,11 +3720,15 @@ class CollectionsApi(object):
|
|
|
3432
3720
|
Update a note of a(n) collection
|
|
3433
3721
|
This method makes a synchronous HTTP request by default.
|
|
3434
3722
|
|
|
3435
|
-
:param
|
|
3436
|
-
:
|
|
3437
|
-
:param
|
|
3438
|
-
:
|
|
3439
|
-
:
|
|
3723
|
+
:param cid:
|
|
3724
|
+
:type cid: str
|
|
3725
|
+
:param note_id:
|
|
3726
|
+
:type note_id: str
|
|
3727
|
+
:param body:
|
|
3728
|
+
:type body: NoteInput
|
|
3729
|
+
:param async_: Perform the request asynchronously
|
|
3730
|
+
:type async_: bool, optional
|
|
3731
|
+
:rtype: int
|
|
3440
3732
|
"""
|
|
3441
3733
|
|
|
3442
3734
|
all_params = ['cid','note_id','body',] # noqa: E501
|
|
@@ -3528,11 +3820,15 @@ class CollectionsApi(object):
|
|
|
3528
3820
|
Update a users permission for this group
|
|
3529
3821
|
This method makes a synchronous HTTP request by default.
|
|
3530
3822
|
|
|
3531
|
-
:param
|
|
3532
|
-
:
|
|
3533
|
-
:param
|
|
3534
|
-
:
|
|
3535
|
-
:
|
|
3823
|
+
:param collection_id:
|
|
3824
|
+
:type collection_id: str
|
|
3825
|
+
:param user_id:
|
|
3826
|
+
:type user_id: str
|
|
3827
|
+
:param body:
|
|
3828
|
+
:type body: AccessPermissionUpdate
|
|
3829
|
+
:param async_: Perform the request asynchronously
|
|
3830
|
+
:type async_: bool, optional
|
|
3831
|
+
:rtype: AccessPermissionOutput
|
|
3536
3832
|
"""
|
|
3537
3833
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3538
3834
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3556,11 +3852,15 @@ class CollectionsApi(object):
|
|
|
3556
3852
|
Update a users permission for this group
|
|
3557
3853
|
This method makes a synchronous HTTP request by default.
|
|
3558
3854
|
|
|
3559
|
-
:param
|
|
3560
|
-
:
|
|
3561
|
-
:param
|
|
3562
|
-
:
|
|
3563
|
-
:
|
|
3855
|
+
:param collection_id:
|
|
3856
|
+
:type collection_id: str
|
|
3857
|
+
:param user_id:
|
|
3858
|
+
:type user_id: str
|
|
3859
|
+
:param body:
|
|
3860
|
+
:type body: AccessPermissionUpdate
|
|
3861
|
+
:param async_: Perform the request asynchronously
|
|
3862
|
+
:type async_: bool, optional
|
|
3863
|
+
:rtype: AccessPermissionOutput
|
|
3564
3864
|
"""
|
|
3565
3865
|
|
|
3566
3866
|
all_params = ['collection_id','user_id','body',] # noqa: E501
|
|
@@ -3652,11 +3952,15 @@ class CollectionsApi(object):
|
|
|
3652
3952
|
Rename a tag
|
|
3653
3953
|
This method makes a synchronous HTTP request by default.
|
|
3654
3954
|
|
|
3655
|
-
:param
|
|
3656
|
-
:
|
|
3657
|
-
:param
|
|
3658
|
-
:
|
|
3659
|
-
:
|
|
3955
|
+
:param cid:
|
|
3956
|
+
:type cid: str
|
|
3957
|
+
:param value: The tag to interact with
|
|
3958
|
+
:type value: str
|
|
3959
|
+
:param body:
|
|
3960
|
+
:type body: Tag
|
|
3961
|
+
:param async_: Perform the request asynchronously
|
|
3962
|
+
:type async_: bool, optional
|
|
3963
|
+
:rtype: str
|
|
3660
3964
|
"""
|
|
3661
3965
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3662
3966
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3680,11 +3984,15 @@ class CollectionsApi(object):
|
|
|
3680
3984
|
Rename a tag
|
|
3681
3985
|
This method makes a synchronous HTTP request by default.
|
|
3682
3986
|
|
|
3683
|
-
:param
|
|
3684
|
-
:
|
|
3685
|
-
:param
|
|
3686
|
-
:
|
|
3687
|
-
:
|
|
3987
|
+
:param cid:
|
|
3988
|
+
:type cid: str
|
|
3989
|
+
:param value: The tag to interact with
|
|
3990
|
+
:type value: str
|
|
3991
|
+
:param body:
|
|
3992
|
+
:type body: Tag
|
|
3993
|
+
:param async_: Perform the request asynchronously
|
|
3994
|
+
:type async_: bool, optional
|
|
3995
|
+
:rtype: str
|
|
3688
3996
|
"""
|
|
3689
3997
|
|
|
3690
3998
|
all_params = ['cid','value','body',] # noqa: E501
|
|
@@ -3776,18 +4084,29 @@ class CollectionsApi(object):
|
|
|
3776
4084
|
Upload a file to a(n) collection.
|
|
3777
4085
|
This method makes a synchronous HTTP request by default.
|
|
3778
4086
|
|
|
3779
|
-
:param
|
|
3780
|
-
:
|
|
3781
|
-
:param
|
|
3782
|
-
:
|
|
3783
|
-
:param
|
|
3784
|
-
:
|
|
3785
|
-
:param
|
|
3786
|
-
:
|
|
3787
|
-
:param
|
|
3788
|
-
:
|
|
3789
|
-
:param
|
|
3790
|
-
:
|
|
4087
|
+
:param container_id:
|
|
4088
|
+
:type container_id: str
|
|
4089
|
+
:param file: The file to upload
|
|
4090
|
+
:type file: str
|
|
4091
|
+
:param preserve_metadata:, defaults to false
|
|
4092
|
+
:type preserve_metadata: bool, optional
|
|
4093
|
+
:param ticket:
|
|
4094
|
+
:type ticket: str, optional
|
|
4095
|
+
:param id:
|
|
4096
|
+
:type id: str, optional
|
|
4097
|
+
:param level:
|
|
4098
|
+
:type level: ContainerType, optional
|
|
4099
|
+
:param job:
|
|
4100
|
+
:type job: str, optional
|
|
4101
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4102
|
+
:type metadata: object, optional
|
|
4103
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
4104
|
+
:type x_accept_feature: list[str], optional
|
|
4105
|
+
:param content_type:
|
|
4106
|
+
:type content_type: str, optional
|
|
4107
|
+
:param async_: Perform the request asynchronously
|
|
4108
|
+
:type async_: bool, optional
|
|
4109
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
3791
4110
|
"""
|
|
3792
4111
|
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3793
4112
|
kwargs['_return_http_data_only'] = True
|
|
@@ -3811,18 +4130,29 @@ class CollectionsApi(object):
|
|
|
3811
4130
|
Upload a file to a(n) collection.
|
|
3812
4131
|
This method makes a synchronous HTTP request by default.
|
|
3813
4132
|
|
|
3814
|
-
:param
|
|
3815
|
-
:
|
|
3816
|
-
:param
|
|
3817
|
-
:
|
|
3818
|
-
:param
|
|
3819
|
-
:
|
|
3820
|
-
:param
|
|
3821
|
-
:
|
|
3822
|
-
:param
|
|
3823
|
-
:
|
|
3824
|
-
:param
|
|
3825
|
-
:
|
|
4133
|
+
:param container_id:
|
|
4134
|
+
:type container_id: str
|
|
4135
|
+
:param file: The file to upload
|
|
4136
|
+
:type file: str
|
|
4137
|
+
:param preserve_metadata:, defaults to false
|
|
4138
|
+
:type preserve_metadata: bool, optional
|
|
4139
|
+
:param ticket:
|
|
4140
|
+
:type ticket: str, optional
|
|
4141
|
+
:param id:
|
|
4142
|
+
:type id: str, optional
|
|
4143
|
+
:param level:
|
|
4144
|
+
:type level: ContainerType, optional
|
|
4145
|
+
:param job:
|
|
4146
|
+
:type job: str, optional
|
|
4147
|
+
:param metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4148
|
+
:type metadata: object, optional
|
|
4149
|
+
:param x_accept_feature: redirect header, defaults to []
|
|
4150
|
+
:type x_accept_feature: list[str], optional
|
|
4151
|
+
:param content_type:
|
|
4152
|
+
:type content_type: str, optional
|
|
4153
|
+
:param async_: Perform the request asynchronously
|
|
4154
|
+
:type async_: bool, optional
|
|
4155
|
+
:rtype: union[list[FileOutput],UploadTicketOutput]
|
|
3826
4156
|
"""
|
|
3827
4157
|
|
|
3828
4158
|
all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|