odm-api 0.0.1__tar.gz
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.
- odm-api-0.0.1/PKG-INFO +16 -0
- odm-api-0.0.1/README.md +501 -0
- odm-api-0.0.1/odm_api/__init__.py +184 -0
- odm-api-0.0.1/odm_api/api/__init__.py +45 -0
- odm-api-0.0.1/odm_api/api/data_import_jobs_api.py +2065 -0
- odm-api-0.0.1/odm_api/api/expression_integration_as_curator_api.py +5686 -0
- odm-api-0.0.1/odm_api/api/expression_integration_as_user_api.py +2336 -0
- odm-api-0.0.1/odm_api/api/expression_spo_tas_curator_api.py +3515 -0
- odm-api-0.0.1/odm_api/api/expression_spo_tas_user_api.py +2671 -0
- odm-api-0.0.1/odm_api/api/flow_cytometry_integration_as_curator_api.py +2146 -0
- odm-api-0.0.1/odm_api/api/flow_cytometry_integration_as_user_api.py +1018 -0
- odm-api-0.0.1/odm_api/api/flow_cytometry_spo_tas_curator_api.py +3546 -0
- odm-api-0.0.1/odm_api/api/flow_cytometry_spo_tas_user_api.py +2702 -0
- odm-api-0.0.1/odm_api/api/groups_api.py +1511 -0
- odm-api-0.0.1/odm_api/api/job_operations_api.py +1062 -0
- odm-api-0.0.1/odm_api/api/library_integration_as_curator_api.py +2405 -0
- odm-api-0.0.1/odm_api/api/library_integration_as_user_api.py +1297 -0
- odm-api-0.0.1/odm_api/api/library_spo_tas_curator_api.py +2749 -0
- odm-api-0.0.1/odm_api/api/library_spo_tas_user_api.py +1644 -0
- odm-api-0.0.1/odm_api/api/linkage_as_curator_api.py +1801 -0
- odm-api-0.0.1/odm_api/api/linkage_as_user_api.py +1200 -0
- odm-api-0.0.1/odm_api/api/manage_data_api.py +628 -0
- odm-api-0.0.1/odm_api/api/metadata_versioning_as_curator_api.py +324 -0
- odm-api-0.0.1/odm_api/api/omics_queries_as_curator_api.py +4632 -0
- odm-api-0.0.1/odm_api/api/omics_queries_as_user_api.py +4632 -0
- odm-api-0.0.1/odm_api/api/preparation_integration_as_curator_api.py +2405 -0
- odm-api-0.0.1/odm_api/api/preparation_integration_as_user_api.py +1297 -0
- odm-api-0.0.1/odm_api/api/preparation_spo_tas_curator_api.py +2749 -0
- odm-api-0.0.1/odm_api/api/preparation_spo_tas_user_api.py +1644 -0
- odm-api-0.0.1/odm_api/api/sample_integration_as_curator_api.py +2224 -0
- odm-api-0.0.1/odm_api/api/sample_integration_as_user_api.py +1116 -0
- odm-api-0.0.1/odm_api/api/sample_spo_tas_curator_api.py +2151 -0
- odm-api-0.0.1/odm_api/api/sample_spo_tas_user_api.py +1308 -0
- odm-api-0.0.1/odm_api/api/study_integration_as_curator_api.py +1730 -0
- odm-api-0.0.1/odm_api/api/study_integration_as_user_api.py +1730 -0
- odm-api-0.0.1/odm_api/api/study_spo_tas_curator_api.py +2151 -0
- odm-api-0.0.1/odm_api/api/study_spo_tas_user_api.py +1308 -0
- odm-api-0.0.1/odm_api/api/tasks_api_api.py +577 -0
- odm-api-0.0.1/odm_api/api/users_api.py +1483 -0
- odm-api-0.0.1/odm_api/api/validation_summary_as_curator_api.py +300 -0
- odm-api-0.0.1/odm_api/api/variant_integration_as_curator_api.py +2146 -0
- odm-api-0.0.1/odm_api/api/variant_integration_as_user_api.py +1018 -0
- odm-api-0.0.1/odm_api/api/variant_spo_tas_curator_api.py +3614 -0
- odm-api-0.0.1/odm_api/api/variant_spo_tas_user_api.py +2770 -0
- odm-api-0.0.1/odm_api/api/xrefset_queries_api.py +1523 -0
- odm-api-0.0.1/odm_api/api_client.py +758 -0
- odm-api-0.0.1/odm_api/api_response.py +21 -0
- odm-api-0.0.1/odm_api/configuration.py +474 -0
- odm-api-0.0.1/odm_api/exceptions.py +199 -0
- odm-api-0.0.1/odm_api/models/__init__.py +127 -0
- odm-api-0.0.1/odm_api/models/applied_filter.py +113 -0
- odm-api-0.0.1/odm_api/models/attribute_invalid_value.py +99 -0
- odm-api-0.0.1/odm_api/models/attribute_invalid_value_errors_inner.py +99 -0
- odm-api-0.0.1/odm_api/models/attribute_validation_summary.py +97 -0
- odm-api-0.0.1/odm_api/models/attribute_validation_summary_attribute_invalid_values_inner.py +99 -0
- odm-api-0.0.1/odm_api/models/base_error_response.py +91 -0
- odm-api-0.0.1/odm_api/models/base_error_response_error.py +87 -0
- odm-api-0.0.1/odm_api/models/batch_of_ids.py +93 -0
- odm-api-0.0.1/odm_api/models/commit_info.py +95 -0
- odm-api-0.0.1/odm_api/models/create_group201_response.py +120 -0
- odm-api-0.0.1/odm_api/models/create_group_request.py +114 -0
- odm-api-0.0.1/odm_api/models/create_group_request_members_inner.py +91 -0
- odm-api-0.0.1/odm_api/models/create_user201_response.py +124 -0
- odm-api-0.0.1/odm_api/models/create_user201_response_all_of_meta.py +102 -0
- odm-api-0.0.1/odm_api/models/create_user_request.py +118 -0
- odm-api-0.0.1/odm_api/models/create_user_request_emails_inner.py +101 -0
- odm-api-0.0.1/odm_api/models/data_item.py +89 -0
- odm-api-0.0.1/odm_api/models/data_presentation.py +97 -0
- odm-api-0.0.1/odm_api/models/data_presentation_relationships.py +101 -0
- odm-api-0.0.1/odm_api/models/detached_collection.py +97 -0
- odm-api-0.0.1/odm_api/models/detached_collection_data_inner.py +101 -0
- odm-api-0.0.1/odm_api/models/detached_object.py +101 -0
- odm-api-0.0.1/odm_api/models/email.py +101 -0
- odm-api-0.0.1/odm_api/models/error_message.py +87 -0
- odm-api-0.0.1/odm_api/models/exception_type_and_message.py +89 -0
- odm-api-0.0.1/odm_api/models/expression_item.py +113 -0
- odm-api-0.0.1/odm_api/models/expression_response.py +97 -0
- odm-api-0.0.1/odm_api/models/expression_signal_source.py +101 -0
- odm-api-0.0.1/odm_api/models/filter_groups_response.py +114 -0
- odm-api-0.0.1/odm_api/models/filter_option.py +93 -0
- odm-api-0.0.1/odm_api/models/filter_option_group.py +99 -0
- odm-api-0.0.1/odm_api/models/filter_users_response.py +114 -0
- odm-api-0.0.1/odm_api/models/find_objects_response.py +101 -0
- odm-api-0.0.1/odm_api/models/find_objects_response_filter_option_groups_inner.py +99 -0
- odm-api-0.0.1/odm_api/models/find_objects_response_filter_option_groups_inner_options_inner.py +93 -0
- odm-api-0.0.1/odm_api/models/find_objects_response_objects_page.py +103 -0
- odm-api-0.0.1/odm_api/models/find_objects_response_objects_page_content_inner.py +111 -0
- odm-api-0.0.1/odm_api/models/find_objects_response_objects_page_content_inner_summary_inner.py +89 -0
- odm-api-0.0.1/odm_api/models/flow_cytometry_item.py +101 -0
- odm-api-0.0.1/odm_api/models/flow_cytometry_response.py +97 -0
- odm-api-0.0.1/odm_api/models/flow_cytometry_signal_source.py +95 -0
- odm-api-0.0.1/odm_api/models/get_expression_as_user200_response.py +113 -0
- odm-api-0.0.1/odm_api/models/get_expression_as_user200_response_feature.py +138 -0
- odm-api-0.0.1/odm_api/models/get_expression_as_user200_response_value.py +138 -0
- odm-api-0.0.1/odm_api/models/get_flow_cytometry_as_curator200_response.py +101 -0
- odm-api-0.0.1/odm_api/models/get_variant_as_curator200_response.py +107 -0
- odm-api-0.0.1/odm_api/models/group.py +114 -0
- odm-api-0.0.1/odm_api/models/group_patch.py +105 -0
- odm-api-0.0.1/odm_api/models/group_response.py +120 -0
- odm-api-0.0.1/odm_api/models/group_validation_summary.py +97 -0
- odm-api-0.0.1/odm_api/models/group_validation_summary_attributes_inner.py +97 -0
- odm-api-0.0.1/odm_api/models/i_metadata.py +101 -0
- odm-api-0.0.1/odm_api/models/import_expression_signal_run_request.py +108 -0
- odm-api-0.0.1/odm_api/models/import_metadata_request.py +101 -0
- odm-api-0.0.1/odm_api/models/import_signal_run_request.py +105 -0
- odm-api-0.0.1/odm_api/models/info.py +105 -0
- odm-api-0.0.1/odm_api/models/job_runtime_error.py +97 -0
- odm-api-0.0.1/odm_api/models/job_runtime_error_stack_inner.py +89 -0
- odm-api-0.0.1/odm_api/models/json_metadata.py +91 -0
- odm-api-0.0.1/odm_api/models/link.py +93 -0
- odm-api-0.0.1/odm_api/models/list_response.py +93 -0
- odm-api-0.0.1/odm_api/models/list_response_meta.py +91 -0
- odm-api-0.0.1/odm_api/models/list_response_meta_pagination.py +93 -0
- odm-api-0.0.1/odm_api/models/managed_object.py +94 -0
- odm-api-0.0.1/odm_api/models/member.py +91 -0
- odm-api-0.0.1/odm_api/models/meta.py +102 -0
- odm-api-0.0.1/odm_api/models/meta_response.py +91 -0
- odm-api-0.0.1/odm_api/models/metadata_presentation.py +97 -0
- odm-api-0.0.1/odm_api/models/metadata_presentation_metadata.py +101 -0
- odm-api-0.0.1/odm_api/models/metadata_with_id.py +91 -0
- odm-api-0.0.1/odm_api/models/metainfo_key_for_summary.py +89 -0
- odm-api-0.0.1/odm_api/models/objects_page.py +103 -0
- odm-api-0.0.1/odm_api/models/omics_response.py +93 -0
- odm-api-0.0.1/odm_api/models/omics_response_data_presentation.py +101 -0
- odm-api-0.0.1/odm_api/models/omics_response_data_presentation_data_inner.py +97 -0
- odm-api-0.0.1/odm_api/models/omics_response_metadata_presentation.py +101 -0
- odm-api-0.0.1/odm_api/models/omics_response_metadata_presentation_data_inner.py +97 -0
- odm-api-0.0.1/odm_api/models/omics_response_metadata_with_id.py +101 -0
- odm-api-0.0.1/odm_api/models/output.py +106 -0
- odm-api-0.0.1/odm_api/models/output_errors_inner.py +97 -0
- odm-api-0.0.1/odm_api/models/page_request.py +89 -0
- odm-api-0.0.1/odm_api/models/pagination_info.py +93 -0
- odm-api-0.0.1/odm_api/models/patch_operation.py +98 -0
- odm-api-0.0.1/odm_api/models/relationships.py +101 -0
- odm-api-0.0.1/odm_api/models/runs_response.py +93 -0
- odm-api-0.0.1/odm_api/models/sample_source.py +91 -0
- odm-api-0.0.1/odm_api/models/scim_error_response.py +114 -0
- odm-api-0.0.1/odm_api/models/search_study_request.py +101 -0
- odm-api-0.0.1/odm_api/models/search_study_request_filters_inner.py +113 -0
- odm-api-0.0.1/odm_api/models/search_study_request_page.py +89 -0
- odm-api-0.0.1/odm_api/models/source_type_pair.py +93 -0
- odm-api-0.0.1/odm_api/models/start_import_flow_cytometry_request.py +105 -0
- odm-api-0.0.1/odm_api/models/study_generic_source.py +91 -0
- odm-api-0.0.1/odm_api/models/study_search_info.py +111 -0
- odm-api-0.0.1/odm_api/models/study_validation_summary.py +95 -0
- odm-api-0.0.1/odm_api/models/study_validation_summary_samples_inner.py +97 -0
- odm-api-0.0.1/odm_api/models/task_info.py +123 -0
- odm-api-0.0.1/odm_api/models/user.py +118 -0
- odm-api-0.0.1/odm_api/models/user_patch.py +105 -0
- odm-api-0.0.1/odm_api/models/user_patch_operations_inner.py +98 -0
- odm-api-0.0.1/odm_api/models/user_response.py +124 -0
- odm-api-0.0.1/odm_api/models/validation_error.py +99 -0
- odm-api-0.0.1/odm_api/models/variant_item.py +112 -0
- odm-api-0.0.1/odm_api/models/variant_response.py +97 -0
- odm-api-0.0.1/odm_api/models/variant_signal_source.py +95 -0
- odm-api-0.0.1/odm_api/models/xref_set_create_request.py +107 -0
- odm-api-0.0.1/odm_api/models/xref_set_create_response.py +106 -0
- odm-api-0.0.1/odm_api/models/xref_set_metadata.py +95 -0
- odm-api-0.0.1/odm_api/models/xref_set_search_result.py +97 -0
- odm-api-0.0.1/odm_api/models/xref_set_search_result_entry.py +91 -0
- odm-api-0.0.1/odm_api/models/xref_set_search_result_result_inner.py +91 -0
- odm-api-0.0.1/odm_api/py.typed +0 -0
- odm-api-0.0.1/odm_api/rest.py +255 -0
- odm-api-0.0.1/odm_api.egg-info/PKG-INFO +16 -0
- odm-api-0.0.1/odm_api.egg-info/SOURCES.txt +322 -0
- odm-api-0.0.1/odm_api.egg-info/dependency_links.txt +1 -0
- odm-api-0.0.1/odm_api.egg-info/requires.txt +4 -0
- odm-api-0.0.1/odm_api.egg-info/top_level.txt +1 -0
- odm-api-0.0.1/pyproject.toml +71 -0
- odm-api-0.0.1/setup.cfg +7 -0
- odm-api-0.0.1/setup.py +49 -0
- odm-api-0.0.1/test/test_applied_filter.py +54 -0
- odm-api-0.0.1/test/test_attribute_invalid_value.py +55 -0
- odm-api-0.0.1/test/test_attribute_invalid_value_errors_inner.py +52 -0
- odm-api-0.0.1/test/test_attribute_validation_summary.py +54 -0
- odm-api-0.0.1/test/test_attribute_validation_summary_attribute_invalid_values_inner.py +55 -0
- odm-api-0.0.1/test/test_base_error_response.py +54 -0
- odm-api-0.0.1/test/test_base_error_response_error.py +52 -0
- odm-api-0.0.1/test/test_batch_of_ids.py +60 -0
- odm-api-0.0.1/test/test_commit_info.py +54 -0
- odm-api-0.0.1/test/test_create_group201_response.py +64 -0
- odm-api-0.0.1/test/test_create_group_request.py +60 -0
- odm-api-0.0.1/test/test_create_group_request_members_inner.py +55 -0
- odm-api-0.0.1/test/test_create_user201_response.py +70 -0
- odm-api-0.0.1/test/test_create_user201_response_all_of_meta.py +53 -0
- odm-api-0.0.1/test/test_create_user_request.py +66 -0
- odm-api-0.0.1/test/test_create_user_request_emails_inner.py +53 -0
- odm-api-0.0.1/test/test_data_import_jobs_api.py +80 -0
- odm-api-0.0.1/test/test_data_item.py +52 -0
- odm-api-0.0.1/test/test_data_presentation.py +57 -0
- odm-api-0.0.1/test/test_data_presentation_relationships.py +54 -0
- odm-api-0.0.1/test/test_detached_collection.py +57 -0
- odm-api-0.0.1/test/test_detached_collection_data_inner.py +58 -0
- odm-api-0.0.1/test/test_detached_object.py +58 -0
- odm-api-0.0.1/test/test_email.py +53 -0
- odm-api-0.0.1/test/test_error_message.py +52 -0
- odm-api-0.0.1/test/test_exception_type_and_message.py +52 -0
- odm-api-0.0.1/test/test_expression_integration_as_curator_api.py +164 -0
- odm-api-0.0.1/test/test_expression_integration_as_user_api.py +80 -0
- odm-api-0.0.1/test/test_expression_item.py +59 -0
- odm-api-0.0.1/test/test_expression_response.py +54 -0
- odm-api-0.0.1/test/test_expression_signal_source.py +58 -0
- odm-api-0.0.1/test/test_expression_spo_tas_curator_api.py +108 -0
- odm-api-0.0.1/test/test_expression_spo_tas_user_api.py +87 -0
- odm-api-0.0.1/test/test_filter_groups_response.py +59 -0
- odm-api-0.0.1/test/test_filter_option.py +54 -0
- odm-api-0.0.1/test/test_filter_option_group.py +55 -0
- odm-api-0.0.1/test/test_filter_users_response.py +59 -0
- odm-api-0.0.1/test/test_find_objects_response.py +54 -0
- odm-api-0.0.1/test/test_find_objects_response_filter_option_groups_inner.py +55 -0
- odm-api-0.0.1/test/test_find_objects_response_filter_option_groups_inner_options_inner.py +54 -0
- odm-api-0.0.1/test/test_find_objects_response_objects_page.py +55 -0
- odm-api-0.0.1/test/test_find_objects_response_objects_page_content_inner.py +61 -0
- odm-api-0.0.1/test/test_find_objects_response_objects_page_content_inner_summary_inner.py +54 -0
- odm-api-0.0.1/test/test_flow_cytometry_integration_as_curator_api.py +80 -0
- odm-api-0.0.1/test/test_flow_cytometry_integration_as_user_api.py +52 -0
- odm-api-0.0.1/test/test_flow_cytometry_item.py +58 -0
- odm-api-0.0.1/test/test_flow_cytometry_response.py +54 -0
- odm-api-0.0.1/test/test_flow_cytometry_signal_source.py +55 -0
- odm-api-0.0.1/test/test_flow_cytometry_spo_tas_curator_api.py +108 -0
- odm-api-0.0.1/test/test_flow_cytometry_spo_tas_user_api.py +87 -0
- odm-api-0.0.1/test/test_get_expression_as_user200_response.py +59 -0
- odm-api-0.0.1/test/test_get_expression_as_user200_response_feature.py +50 -0
- odm-api-0.0.1/test/test_get_expression_as_user200_response_value.py +50 -0
- odm-api-0.0.1/test/test_get_flow_cytometry_as_curator200_response.py +58 -0
- odm-api-0.0.1/test/test_get_variant_as_curator200_response.py +65 -0
- odm-api-0.0.1/test/test_group.py +60 -0
- odm-api-0.0.1/test/test_group_patch.py +62 -0
- odm-api-0.0.1/test/test_group_response.py +64 -0
- odm-api-0.0.1/test/test_group_validation_summary.py +54 -0
- odm-api-0.0.1/test/test_group_validation_summary_attributes_inner.py +54 -0
- odm-api-0.0.1/test/test_groups_api.py +66 -0
- odm-api-0.0.1/test/test_i_metadata.py +63 -0
- odm-api-0.0.1/test/test_import_expression_signal_run_request.py +59 -0
- odm-api-0.0.1/test/test_import_metadata_request.py +54 -0
- odm-api-0.0.1/test/test_import_signal_run_request.py +56 -0
- odm-api-0.0.1/test/test_info.py +61 -0
- odm-api-0.0.1/test/test_job_operations_api.py +59 -0
- odm-api-0.0.1/test/test_job_runtime_error.py +54 -0
- odm-api-0.0.1/test/test_job_runtime_error_stack_inner.py +52 -0
- odm-api-0.0.1/test/test_json_metadata.py +53 -0
- odm-api-0.0.1/test/test_library_integration_as_curator_api.py +87 -0
- odm-api-0.0.1/test/test_library_integration_as_user_api.py +59 -0
- odm-api-0.0.1/test/test_library_spo_tas_curator_api.py +94 -0
- odm-api-0.0.1/test/test_library_spo_tas_user_api.py +66 -0
- odm-api-0.0.1/test/test_link.py +54 -0
- odm-api-0.0.1/test/test_linkage_as_curator_api.py +73 -0
- odm-api-0.0.1/test/test_linkage_as_user_api.py +59 -0
- odm-api-0.0.1/test/test_list_response.py +54 -0
- odm-api-0.0.1/test/test_list_response_meta.py +51 -0
- odm-api-0.0.1/test/test_list_response_meta_pagination.py +54 -0
- odm-api-0.0.1/test/test_manage_data_api.py +45 -0
- odm-api-0.0.1/test/test_managed_object.py +58 -0
- odm-api-0.0.1/test/test_member.py +55 -0
- odm-api-0.0.1/test/test_meta.py +53 -0
- odm-api-0.0.1/test/test_meta_response.py +51 -0
- odm-api-0.0.1/test/test_metadata_presentation.py +69 -0
- odm-api-0.0.1/test/test_metadata_presentation_metadata.py +63 -0
- odm-api-0.0.1/test/test_metadata_versioning_as_curator_api.py +38 -0
- odm-api-0.0.1/test/test_metadata_with_id.py +52 -0
- odm-api-0.0.1/test/test_metainfo_key_for_summary.py +54 -0
- odm-api-0.0.1/test/test_objects_page.py +55 -0
- odm-api-0.0.1/test/test_omics_queries_as_curator_api.py +87 -0
- odm-api-0.0.1/test/test_omics_queries_as_user_api.py +87 -0
- odm-api-0.0.1/test/test_omics_response.py +58 -0
- odm-api-0.0.1/test/test_omics_response_data_presentation.py +65 -0
- odm-api-0.0.1/test/test_omics_response_data_presentation_data_inner.py +57 -0
- odm-api-0.0.1/test/test_omics_response_metadata_presentation.py +77 -0
- odm-api-0.0.1/test/test_omics_response_metadata_presentation_data_inner.py +69 -0
- odm-api-0.0.1/test/test_omics_response_metadata_with_id.py +58 -0
- odm-api-0.0.1/test/test_output.py +56 -0
- odm-api-0.0.1/test/test_output_errors_inner.py +54 -0
- odm-api-0.0.1/test/test_page_request.py +52 -0
- odm-api-0.0.1/test/test_pagination_info.py +54 -0
- odm-api-0.0.1/test/test_patch_operation.py +54 -0
- odm-api-0.0.1/test/test_preparation_integration_as_curator_api.py +87 -0
- odm-api-0.0.1/test/test_preparation_integration_as_user_api.py +59 -0
- odm-api-0.0.1/test/test_preparation_spo_tas_curator_api.py +94 -0
- odm-api-0.0.1/test/test_preparation_spo_tas_user_api.py +66 -0
- odm-api-0.0.1/test/test_relationships.py +54 -0
- odm-api-0.0.1/test/test_runs_response.py +58 -0
- odm-api-0.0.1/test/test_sample_integration_as_curator_api.py +80 -0
- odm-api-0.0.1/test/test_sample_integration_as_user_api.py +52 -0
- odm-api-0.0.1/test/test_sample_source.py +53 -0
- odm-api-0.0.1/test/test_sample_spo_tas_curator_api.py +80 -0
- odm-api-0.0.1/test/test_sample_spo_tas_user_api.py +59 -0
- odm-api-0.0.1/test/test_scim_error_response.py +57 -0
- odm-api-0.0.1/test/test_search_study_request.py +52 -0
- odm-api-0.0.1/test/test_search_study_request_filters_inner.py +54 -0
- odm-api-0.0.1/test/test_search_study_request_page.py +52 -0
- odm-api-0.0.1/test/test_source_type_pair.py +52 -0
- odm-api-0.0.1/test/test_start_import_flow_cytometry_request.py +56 -0
- odm-api-0.0.1/test/test_study_generic_source.py +53 -0
- odm-api-0.0.1/test/test_study_integration_as_curator_api.py +66 -0
- odm-api-0.0.1/test/test_study_integration_as_user_api.py +66 -0
- odm-api-0.0.1/test/test_study_search_info.py +61 -0
- odm-api-0.0.1/test/test_study_spo_tas_curator_api.py +80 -0
- odm-api-0.0.1/test/test_study_spo_tas_user_api.py +59 -0
- odm-api-0.0.1/test/test_study_validation_summary.py +53 -0
- odm-api-0.0.1/test/test_study_validation_summary_samples_inner.py +54 -0
- odm-api-0.0.1/test/test_task_info.py +57 -0
- odm-api-0.0.1/test/test_tasks_api_api.py +45 -0
- odm-api-0.0.1/test/test_user.py +66 -0
- odm-api-0.0.1/test/test_user_patch.py +62 -0
- odm-api-0.0.1/test/test_user_patch_operations_inner.py +54 -0
- odm-api-0.0.1/test/test_user_response.py +70 -0
- odm-api-0.0.1/test/test_users_api.py +66 -0
- odm-api-0.0.1/test/test_validation_error.py +52 -0
- odm-api-0.0.1/test/test_validation_summary_as_curator_api.py +38 -0
- odm-api-0.0.1/test/test_variant_integration_as_curator_api.py +80 -0
- odm-api-0.0.1/test/test_variant_integration_as_user_api.py +52 -0
- odm-api-0.0.1/test/test_variant_item.py +63 -0
- odm-api-0.0.1/test/test_variant_response.py +54 -0
- odm-api-0.0.1/test/test_variant_signal_source.py +55 -0
- odm-api-0.0.1/test/test_variant_spo_tas_curator_api.py +108 -0
- odm-api-0.0.1/test/test_variant_spo_tas_user_api.py +87 -0
- odm-api-0.0.1/test/test_xref_set_create_request.py +57 -0
- odm-api-0.0.1/test/test_xref_set_create_response.py +68 -0
- odm-api-0.0.1/test/test_xref_set_metadata.py +55 -0
- odm-api-0.0.1/test/test_xref_set_search_result.py +54 -0
- odm-api-0.0.1/test/test_xref_set_search_result_entry.py +53 -0
- odm-api-0.0.1/test/test_xref_set_search_result_result_inner.py +53 -0
- odm-api-0.0.1/test/test_xrefset_queries_api.py +66 -0
odm-api-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: odm-api
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Tasks API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: team@openapitools.org
|
|
8
|
+
Keywords: OpenAPI,OpenAPI-Generator,Tasks API
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
Requires-Dist: urllib3<2.1.0,>=1.25.3
|
|
11
|
+
Requires-Dist: python-dateutil
|
|
12
|
+
Requires-Dist: pydantic>=2
|
|
13
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
14
|
+
|
|
15
|
+
These API endpoints serve to work with asynchronous tasks.
|
|
16
|
+
|
odm-api-0.0.1/README.md
ADDED
|
@@ -0,0 +1,501 @@
|
|
|
1
|
+
# odm-api
|
|
2
|
+
These API endpoints serve to work with asynchronous tasks.
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
6
|
+
|
|
7
|
+
- API version: default-released
|
|
8
|
+
- Package version: 0.0.1
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
|
|
11
|
+
## Requirements.
|
|
12
|
+
|
|
13
|
+
Python 3.7+
|
|
14
|
+
|
|
15
|
+
## Installation & Usage
|
|
16
|
+
### pip install
|
|
17
|
+
|
|
18
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
pip install git+https://github.com/genestack/odm-openapi.git
|
|
22
|
+
```
|
|
23
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/genestack/odm-openapi.git`)
|
|
24
|
+
|
|
25
|
+
Then import the package:
|
|
26
|
+
```python
|
|
27
|
+
import odm_api
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Setuptools
|
|
31
|
+
|
|
32
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
python setup.py install --user
|
|
36
|
+
```
|
|
37
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
38
|
+
|
|
39
|
+
Then import the package:
|
|
40
|
+
```python
|
|
41
|
+
import odm_api
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Tests
|
|
45
|
+
|
|
46
|
+
Execute `pytest` to run the tests.
|
|
47
|
+
|
|
48
|
+
## Getting Started
|
|
49
|
+
|
|
50
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
51
|
+
|
|
52
|
+
```python
|
|
53
|
+
|
|
54
|
+
import odm_api
|
|
55
|
+
from odm_api.rest import ApiException
|
|
56
|
+
from pprint import pprint
|
|
57
|
+
|
|
58
|
+
# Defining the host is optional and defaults to http://localhost
|
|
59
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
60
|
+
configuration = odm_api.Configuration(
|
|
61
|
+
host = "http://localhost"
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
# The client must configure the authentication and authorization parameters
|
|
65
|
+
# in accordance with the API server security policy.
|
|
66
|
+
# Examples for each auth method are provided below, use the example that
|
|
67
|
+
# satisfies your auth use case.
|
|
68
|
+
|
|
69
|
+
# Configure API key authorization: Access-token
|
|
70
|
+
configuration.api_key['Access-token'] = os.environ["API_KEY"]
|
|
71
|
+
|
|
72
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
73
|
+
# configuration.api_key_prefix['Access-token'] = 'Bearer'
|
|
74
|
+
|
|
75
|
+
# Configure API key authorization: Genestack-API-Token
|
|
76
|
+
configuration.api_key['Genestack-API-Token'] = os.environ["API_KEY"]
|
|
77
|
+
|
|
78
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
79
|
+
# configuration.api_key_prefix['Genestack-API-Token'] = 'Bearer'
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
# Enter a context with an instance of the API client
|
|
83
|
+
with odm_api.ApiClient(configuration) as api_client:
|
|
84
|
+
# Create an instance of the API class
|
|
85
|
+
api_instance = odm_api.DataImportJobsApi(api_client)
|
|
86
|
+
allow_dups = False # bool | Load duplicate data: the data from the links has already been previously loaded into ODM, and for **testing purposes**, you need to load this data again. (optional) (default to False)
|
|
87
|
+
body = odm_api.ImportExpressionSignalRunRequest() # ImportExpressionSignalRunRequest | (optional)
|
|
88
|
+
|
|
89
|
+
try:
|
|
90
|
+
# Import any tabular data from TSV or GCT files
|
|
91
|
+
api_response = api_instance.start_import_expression(allow_dups=allow_dups, body=body)
|
|
92
|
+
print("The response of DataImportJobsApi->start_import_expression:\n")
|
|
93
|
+
pprint(api_response)
|
|
94
|
+
except ApiException as e:
|
|
95
|
+
print("Exception when calling DataImportJobsApi->start_import_expression: %s\n" % e)
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Documentation for API Endpoints
|
|
100
|
+
|
|
101
|
+
All URIs are relative to *http://localhost*
|
|
102
|
+
|
|
103
|
+
Class | Method | HTTP request | Description
|
|
104
|
+
------------ | ------------- | ------------- | -------------
|
|
105
|
+
*DataImportJobsApi* | [**start_import_expression**](docs/DataImportJobsApi.md#start_import_expression) | **POST** /api/v1/jobs/import/expression | Import any tabular data from TSV or GCT files
|
|
106
|
+
*DataImportJobsApi* | [**start_import_flow_cytometry**](docs/DataImportJobsApi.md#start_import_flow_cytometry) | **POST** /api/v1/jobs/import/flow-cytometry | Import flow-cytometry data and metadata from FACS and TSV files
|
|
107
|
+
*DataImportJobsApi* | [**start_import_libraries**](docs/DataImportJobsApi.md#start_import_libraries) | **POST** /api/v1/jobs/import/libraries | Import a group of library metadata objects from a TSV file
|
|
108
|
+
*DataImportJobsApi* | [**start_import_preparations**](docs/DataImportJobsApi.md#start_import_preparations) | **POST** /api/v1/jobs/import/preparations | Import a group of preparation metadata objects from a TSV file
|
|
109
|
+
*DataImportJobsApi* | [**start_import_samples**](docs/DataImportJobsApi.md#start_import_samples) | **POST** /api/v1/jobs/import/samples | Import a group of sample metadata objects from a TSV file
|
|
110
|
+
*DataImportJobsApi* | [**start_import_study**](docs/DataImportJobsApi.md#start_import_study) | **POST** /api/v1/jobs/import/study | Import study metadata from a TSV file
|
|
111
|
+
*DataImportJobsApi* | [**start_import_variant**](docs/DataImportJobsApi.md#start_import_variant) | **POST** /api/v1/jobs/import/variant | Import variation data and metadata from VCF and TSV files
|
|
112
|
+
*ExpressionSPoTAsCuratorApi* | [**add_expression_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#add_expression_as_curator) | **POST** /api/v1/as-curator/expressions/gct | Create multiple new objects from a multi-row data file with optional supplied metadata
|
|
113
|
+
*ExpressionSPoTAsCuratorApi* | [**delete_expression_group_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#delete_expression_group_as_curator) | **DELETE** /api/v1/as-curator/expressions/group/{id} | Delete the object
|
|
114
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_as_curator) | **GET** /api/v1/as-curator/expressions/{id} | Retrieve a single expression object by ID (accession)
|
|
115
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_by_version_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_by_version_as_curator) | **GET** /api/v1/as-curator/expressions/{id}/versions/{version} | Retrieve a single expression object by ID (accession)
|
|
116
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_data_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_data_as_curator) | **GET** /api/v1/as-curator/expressions | Retrieve multiple expression data and metadata objects
|
|
117
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_group_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_group_as_curator) | **GET** /api/v1/as-curator/expressions/group/{id} | Retrieve a single group object by ID (accession)
|
|
118
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_group_by_run_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_group_by_run_as_curator) | **GET** /api/v1/as-curator/expressions/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
119
|
+
*ExpressionSPoTAsCuratorApi* | [**get_expression_versions_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#get_expression_versions_as_curator) | **GET** /api/v1/as-curator/expressions/{id}/versions | Retrieve a list of object versions by ID
|
|
120
|
+
*ExpressionSPoTAsCuratorApi* | [**search_expression_groups_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#search_expression_groups_as_curator) | **GET** /api/v1/as-curator/expressions/group | Retrieve groups that match a query
|
|
121
|
+
*ExpressionSPoTAsCuratorApi* | [**search_expression_runs_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#search_expression_runs_as_curator) | **GET** /api/v1/as-curator/expressions/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
122
|
+
*ExpressionSPoTAsCuratorApi* | [**update_expression_run_as_curator**](docs/ExpressionSPoTAsCuratorApi.md#update_expression_run_as_curator) | **PATCH** /api/v1/as-curator/expressions/{id} | Update object metadata
|
|
123
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_as_user) | **GET** /api/v1/as-user/expressions/{id} | Retrieve a single expression object by ID (accession)
|
|
124
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_by_version_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_by_version_as_user) | **GET** /api/v1/as-user/expressions/{id}/versions/{version} | Retrieve a single expression object by ID (accession)
|
|
125
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_data_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_data_as_user) | **GET** /api/v1/as-user/expressions | Retrieve multiple expression data and metadata objects
|
|
126
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_group_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_group_as_user) | **GET** /api/v1/as-user/expressions/group/{id} | Retrieve a single group object by ID (accession)
|
|
127
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_group_by_run_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_group_by_run_as_user) | **GET** /api/v1/as-user/expressions/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
128
|
+
*ExpressionSPoTAsUserApi* | [**get_expression_versions_as_user**](docs/ExpressionSPoTAsUserApi.md#get_expression_versions_as_user) | **GET** /api/v1/as-user/expressions/{id}/versions | Retrieve a list of object versions by ID
|
|
129
|
+
*ExpressionSPoTAsUserApi* | [**search_expression_groups_as_user**](docs/ExpressionSPoTAsUserApi.md#search_expression_groups_as_user) | **GET** /api/v1/as-user/expressions/group | Retrieve groups that match a query
|
|
130
|
+
*ExpressionSPoTAsUserApi* | [**search_expression_runs_as_user**](docs/ExpressionSPoTAsUserApi.md#search_expression_runs_as_user) | **GET** /api/v1/as-user/expressions/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
131
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_group_library_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_group_library_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/library/group/{targetId} | Create a link between a group of expression objects and a group of library objects
|
|
132
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_group_preparation_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_group_preparation_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/preparation/group/{targetId} | Create a link between a group of expression objects and a group of preparation objects
|
|
133
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_group_sample_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_group_sample_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId} | Create a link between a group of expression objects and a group of sample objects
|
|
134
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_library_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_library_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/{sourceId}/to/library/{targetId} | Create a link between an expression object and a library
|
|
135
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_preparation_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_preparation_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/{sourceId}/to/preparation/{targetId} | Create a link between an expression object and a preparation
|
|
136
|
+
*ExpressionIntegrationAsCuratorApi* | [**create_expression_sample_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#create_expression_sample_link_as_curator) | **POST** /api/v1/as-curator/integration/link/expression/{sourceId}/to/sample/{targetId} | Create a link between an expression object and a sample
|
|
137
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_group_library_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_group_library_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/library/group/{targetId} | Delete link between a group of expression objects and a group of library objects
|
|
138
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_group_preparation_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_group_preparation_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/preparation/group/{targetId} | Delete link between a group of expression objects and a group of preparation objects
|
|
139
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_group_sample_group_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_group_sample_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId} | Delete link between a group of expression objects and a group of sample objects
|
|
140
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_library_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_library_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/{sourceId}/to/library/{targetId} | Delete link between an expression object and a library
|
|
141
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_preparation_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_preparation_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/{sourceId}/to/preparation/{targetId} | Delete link between an expression object and a preparation
|
|
142
|
+
*ExpressionIntegrationAsCuratorApi* | [**delete_expression_sample_link_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#delete_expression_sample_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/expression/{sourceId}/to/sample/{targetId} | Delete link between an expression object and a sample
|
|
143
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_by_library_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_by_library_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/by/library/{id} | Retrieve expression run-level data by querying related library ID (accession)
|
|
144
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_by_preparation**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_by_preparation) | **GET** /api/v1/as-curator/integration/link/expression/by/preparation/{id} | Retrieve expression run-level data by querying related preparation ID (accession)
|
|
145
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_by_sample_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/by/sample/{id} | Retrieve expression run-level data by querying related sample ID (accession)
|
|
146
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_groups_by_study_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_groups_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
147
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_run_to_library_pairs_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_run_to_library_pairs_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/run-to-libraries/by/group/{id} | Retrieve run-library pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
148
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_run_to_preparation_pairs_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_run_to_preparation_pairs_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/run-to-preparations/by/group/{id} | Retrieve run-preparation pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
149
|
+
*ExpressionIntegrationAsCuratorApi* | [**get_expression_run_to_sample_pairs_as_curator**](docs/ExpressionIntegrationAsCuratorApi.md#get_expression_run_to_sample_pairs_as_curator) | **GET** /api/v1/as-curator/integration/link/expression/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
150
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_by_library_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_by_library_as_user) | **GET** /api/v1/as-user/integration/link/expression/by/library/{id} | Retrieve expression run-level data by querying related library ID (accession)
|
|
151
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_by_preparation_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_by_preparation_as_user) | **GET** /api/v1/as-user/integration/link/expression/by/preparation/{id} | Retrieve expression run-level data by querying related preparation ID (accession)
|
|
152
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_by_sample_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/expression/by/sample/{id} | Retrieve expression run-level data by querying related sample ID (accession)
|
|
153
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_groups_by_study_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_groups_by_study_as_user) | **GET** /api/v1/as-user/integration/link/expression/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
154
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_run_to_library_pairs_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_run_to_library_pairs_as_user) | **GET** /api/v1/as-user/integration/link/expression/run-to-libraries/by/group/{id} | Retrieve run-library pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
155
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_run_to_preparation_pairs_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_run_to_preparation_pairs_as_user) | **GET** /api/v1/as-user/integration/link/expression/run-to-preparations/by/group/{id} | Retrieve run-preparation pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
156
|
+
*ExpressionIntegrationAsUserApi* | [**get_expression_run_to_sample_pairs_as_user**](docs/ExpressionIntegrationAsUserApi.md#get_expression_run_to_sample_pairs_as_user) | **GET** /api/v1/as-user/integration/link/expression/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
157
|
+
*FlowCytometrySPoTAsCuratorApi* | [**add_flow_cytometry_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#add_flow_cytometry_as_curator) | **POST** /api/v1/as-curator/flow-cytometries/facs | Create multiple new objects from a multi-row data file with optional supplied metadata
|
|
158
|
+
*FlowCytometrySPoTAsCuratorApi* | [**delete_flow_cytometry_group_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#delete_flow_cytometry_group_as_curator) | **DELETE** /api/v1/as-curator/flow-cytometries/group/{id} | Delete the object
|
|
159
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/{id} | Retrieve a single sample flow cytometry by ID (accession)
|
|
160
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_by_version_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_by_version_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/{id}/versions/{version} | Retrieve a single sample flow cytometry by ID (accession)
|
|
161
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_data_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_data_as_curator) | **GET** /api/v1/as-curator/flow-cytometries | Retrieve multiple flow cytometry data and metadata objects
|
|
162
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_group_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_group_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/group/{id} | Retrieve a single group object by ID (accession)
|
|
163
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_group_by_run_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_group_by_run_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
164
|
+
*FlowCytometrySPoTAsCuratorApi* | [**get_flow_cytometry_versions_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#get_flow_cytometry_versions_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/{id}/versions | Retrieve a list of object versions by ID
|
|
165
|
+
*FlowCytometrySPoTAsCuratorApi* | [**search_flow_cytometry_groups_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#search_flow_cytometry_groups_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/group | Retrieve groups that match a query
|
|
166
|
+
*FlowCytometrySPoTAsCuratorApi* | [**search_flow_cytometry_runs_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#search_flow_cytometry_runs_as_curator) | **GET** /api/v1/as-curator/flow-cytometries/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
167
|
+
*FlowCytometrySPoTAsCuratorApi* | [**update_flow_cytometry_as_curator**](docs/FlowCytometrySPoTAsCuratorApi.md#update_flow_cytometry_as_curator) | **PATCH** /api/v1/as-curator/flow-cytometries/{id} | Update object metadata
|
|
168
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_as_user) | **GET** /api/v1/as-user/flow-cytometries/{id} | Retrieve a single sample flow cytometry by ID (accession)
|
|
169
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_by_version_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_by_version_as_user) | **GET** /api/v1/as-user/flow-cytometries/{id}/versions/{version} | Retrieve a single sample flow cytometry by ID (accession)
|
|
170
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_data_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_data_as_user) | **GET** /api/v1/as-user/flow-cytometries | Retrieve multiple flow cytometry data and metadata objects
|
|
171
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_group_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_group_as_user) | **GET** /api/v1/as-user/flow-cytometries/group/{id} | Retrieve a single group object by ID (accession)
|
|
172
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_group_by_run_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_group_by_run_as_user) | **GET** /api/v1/as-user/flow-cytometries/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
173
|
+
*FlowCytometrySPoTAsUserApi* | [**get_flow_cytometry_versions_as_user**](docs/FlowCytometrySPoTAsUserApi.md#get_flow_cytometry_versions_as_user) | **GET** /api/v1/as-user/flow-cytometries/{id}/versions | Retrieve a list of object versions by ID
|
|
174
|
+
*FlowCytometrySPoTAsUserApi* | [**search_flow_cytometry_groups_as_user**](docs/FlowCytometrySPoTAsUserApi.md#search_flow_cytometry_groups_as_user) | **GET** /api/v1/as-user/flow-cytometries/group | Retrieve groups that match a query
|
|
175
|
+
*FlowCytometrySPoTAsUserApi* | [**search_flow_cytometry_runs_as_user**](docs/FlowCytometrySPoTAsUserApi.md#search_flow_cytometry_runs_as_user) | **GET** /api/v1/as-user/flow-cytometries/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
176
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**create_flow_cytometry_group_sample_group_link_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#create_flow_cytometry_group_sample_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/flow-cytometry/group/{sourceId}/to/sample/group/{targetId} | Create a link between a group of flow-cytometry objects and a group of sample objects
|
|
177
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**create_flow_cytometry_sample_link_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#create_flow_cytometry_sample_link_as_curator) | **POST** /api/v1/as-curator/integration/link/flow-cytometry/{sourceId}/to/sample/{targetId} | Create a link between a flow-cytometry object and a sample
|
|
178
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**delete_flow_cytometry_group_sample_group_link_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#delete_flow_cytometry_group_sample_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/flow-cytometry/group/{sourceId}/to/sample/group/{targetId} | Delete link between a group of flow-cytometry objects and a group of sample objects
|
|
179
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**delete_flow_cytometry_sample_link_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#delete_flow_cytometry_sample_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/flow-cytometry/{sourceId}/to/sample/{targetId} | Delete link between a flow-cytometry object and a sample
|
|
180
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**get_flow_cytometry_by_sample_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#get_flow_cytometry_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/flow-cytometry/by/sample/{id} | Retrieve flow cytometry run-level data by querying related sample ID (accession)
|
|
181
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**get_flow_cytometry_groups_by_study_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#get_flow_cytometry_groups_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/flow-cytometry/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
182
|
+
*FlowCytometryIntegrationAsCuratorApi* | [**get_flow_cytometry_run_to_sample_pairs_as_curator**](docs/FlowCytometryIntegrationAsCuratorApi.md#get_flow_cytometry_run_to_sample_pairs_as_curator) | **GET** /api/v1/as-curator/integration/link/flow-cytometry/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
183
|
+
*FlowCytometryIntegrationAsUserApi* | [**get_flow_cytometry_by_sample_as_user**](docs/FlowCytometryIntegrationAsUserApi.md#get_flow_cytometry_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/flow-cytometry/by/sample/{id} | Retrieve flow cytometry run-level data by querying related sample ID (accession)
|
|
184
|
+
*FlowCytometryIntegrationAsUserApi* | [**get_flow_cytometry_groups_by_study_as_user**](docs/FlowCytometryIntegrationAsUserApi.md#get_flow_cytometry_groups_by_study_as_user) | **GET** /api/v1/as-user/integration/link/flow-cytometry/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
185
|
+
*FlowCytometryIntegrationAsUserApi* | [**get_flow_cytometry_run_to_sample_pairs_as_user**](docs/FlowCytometryIntegrationAsUserApi.md#get_flow_cytometry_run_to_sample_pairs_as_user) | **GET** /api/v1/as-user/integration/link/flow-cytometry/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
186
|
+
*GroupsApi* | [**create_group**](docs/GroupsApi.md#create_group) | **POST** /api/v1/scim/Groups | Add a new user group
|
|
187
|
+
*GroupsApi* | [**delete_group**](docs/GroupsApi.md#delete_group) | **DELETE** /api/v1/scim/Groups/{id} | Delete a group
|
|
188
|
+
*GroupsApi* | [**find_groups**](docs/GroupsApi.md#find_groups) | **GET** /api/v1/scim/Groups | Retrieve a list of available groups
|
|
189
|
+
*GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /api/v1/scim/Groups/{id} | Retrieve a group by id
|
|
190
|
+
*GroupsApi* | [**patch_group**](docs/GroupsApi.md#patch_group) | **PATCH** /api/v1/scim/Groups/{id} | Update a group
|
|
191
|
+
*JobOperationsApi* | [**info**](docs/JobOperationsApi.md#info) | **GET** /api/v1/jobs/{jobExecId}/info | get information about one particular job execution
|
|
192
|
+
*JobOperationsApi* | [**output**](docs/JobOperationsApi.md#output) | **GET** /api/v1/jobs/{jobExecId}/output | retrieve job output (result)
|
|
193
|
+
*JobOperationsApi* | [**restart**](docs/JobOperationsApi.md#restart) | **PUT** /api/v1/jobs/{jobExecId}/restart | restart stopped (failed) job
|
|
194
|
+
*JobOperationsApi* | [**stop**](docs/JobOperationsApi.md#stop) | **PUT** /api/v1/jobs/{jobExecId}/stop | stop running job
|
|
195
|
+
*LibrarySPoTAsCuratorApi* | [**add_libraries_as_curator**](docs/LibrarySPoTAsCuratorApi.md#add_libraries_as_curator) | **POST** /api/v1/as-curator/libraries | Add new library object
|
|
196
|
+
*LibrarySPoTAsCuratorApi* | [**delete_library_as_curator**](docs/LibrarySPoTAsCuratorApi.md#delete_library_as_curator) | **DELETE** /api/v1/as-curator/libraries/{id} | Delete a library object
|
|
197
|
+
*LibrarySPoTAsCuratorApi* | [**delete_library_group_as_curator**](docs/LibrarySPoTAsCuratorApi.md#delete_library_group_as_curator) | **DELETE** /api/v1/as-curator/libraries/group/{id} | Delete a library group with all related library objects
|
|
198
|
+
*LibrarySPoTAsCuratorApi* | [**get_libraries_by_group_as_curator**](docs/LibrarySPoTAsCuratorApi.md#get_libraries_by_group_as_curator) | **GET** /api/v1/as-curator/libraries/by/group/{id} | Retrieve libraries related to the given group
|
|
199
|
+
*LibrarySPoTAsCuratorApi* | [**get_library_as_curator**](docs/LibrarySPoTAsCuratorApi.md#get_library_as_curator) | **GET** /api/v1/as-curator/libraries/{id} | Retrieve a single library object by ID (accession)
|
|
200
|
+
*LibrarySPoTAsCuratorApi* | [**get_library_by_version_as_curator**](docs/LibrarySPoTAsCuratorApi.md#get_library_by_version_as_curator) | **GET** /api/v1/as-curator/libraries/{id}/versions/{version} | Retrieve a single library object by ID (accession)
|
|
201
|
+
*LibrarySPoTAsCuratorApi* | [**get_library_versions_as_curator**](docs/LibrarySPoTAsCuratorApi.md#get_library_versions_as_curator) | **GET** /api/v1/as-curator/libraries/{id}/versions | Retrieve a list of object versions by ID
|
|
202
|
+
*LibrarySPoTAsCuratorApi* | [**search_libraries_as_curator**](docs/LibrarySPoTAsCuratorApi.md#search_libraries_as_curator) | **GET** /api/v1/as-curator/libraries | List or search for library metadata objects
|
|
203
|
+
*LibrarySPoTAsCuratorApi* | [**update_library_as_curator**](docs/LibrarySPoTAsCuratorApi.md#update_library_as_curator) | **PATCH** /api/v1/as-curator/libraries/{id} | Update a library object
|
|
204
|
+
*LibrarySPoTAsUserApi* | [**get_libraries_by_group_as_user**](docs/LibrarySPoTAsUserApi.md#get_libraries_by_group_as_user) | **GET** /api/v1/as-user/libraries/by/group/{id} | Retrieve libraries related to the given group
|
|
205
|
+
*LibrarySPoTAsUserApi* | [**get_library_as_user**](docs/LibrarySPoTAsUserApi.md#get_library_as_user) | **GET** /api/v1/as-user/libraries/{id} | Retrieve a single library object by ID (accession)
|
|
206
|
+
*LibrarySPoTAsUserApi* | [**get_library_by_version_as_user**](docs/LibrarySPoTAsUserApi.md#get_library_by_version_as_user) | **GET** /api/v1/as-user/libraries/{id}/versions/{version} | Retrieve a single library object by ID (accession)
|
|
207
|
+
*LibrarySPoTAsUserApi* | [**get_library_versions_as_user**](docs/LibrarySPoTAsUserApi.md#get_library_versions_as_user) | **GET** /api/v1/as-user/libraries/{id}/versions | Retrieve a list of object versions by ID
|
|
208
|
+
*LibrarySPoTAsUserApi* | [**search_libraries_as_user**](docs/LibrarySPoTAsUserApi.md#search_libraries_as_user) | **GET** /api/v1/as-user/libraries | List or search for library metadata objects
|
|
209
|
+
*LibraryIntegrationAsCuratorApi* | [**create_library_group_sample_group_link_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#create_library_group_sample_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/library/group/{sourceId}/to/sample/group/{targetId} | Create links between samples and libraries
|
|
210
|
+
*LibraryIntegrationAsCuratorApi* | [**create_library_sample_link_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#create_library_sample_link_as_curator) | **POST** /api/v1/as-curator/integration/link/library/{sourceId}/to/sample/{targetId} | Create a link between a library and a sample
|
|
211
|
+
*LibraryIntegrationAsCuratorApi* | [**delete_library_group_sample_group_link_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#delete_library_group_sample_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/library/group/{sourceId}/to/sample/group/{targetId} | Delete links between samples and libraries related to the specified group
|
|
212
|
+
*LibraryIntegrationAsCuratorApi* | [**delete_library_sample_link_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#delete_library_sample_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/library/{sourceId}/to/sample/{targetId} | Delete a link between a library and a sample
|
|
213
|
+
*LibraryIntegrationAsCuratorApi* | [**get_libraries_by_samples_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#get_libraries_by_samples_as_curator) | **GET** /api/v1/as-curator/integration/link/libraries/by/samples | Retrieve library metadata by querying related samples
|
|
214
|
+
*LibraryIntegrationAsCuratorApi* | [**get_library_by_sample_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#get_library_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/library/by/sample/{id} | Retrieve library metadata by querying related sample ID (accession)
|
|
215
|
+
*LibraryIntegrationAsCuratorApi* | [**get_library_groups_by_study_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#get_library_groups_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/library/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
216
|
+
*LibraryIntegrationAsCuratorApi* | [**get_library_links_to_samples_as_curator**](docs/LibraryIntegrationAsCuratorApi.md#get_library_links_to_samples_as_curator) | **GET** /api/v1/as-curator/integration/link/library/libraries-to-samples/by/group/{id} | Retrieve library-samples pairs by group id. Pagination is based on unique libraries, not unique pairs.
|
|
217
|
+
*LibraryIntegrationAsUserApi* | [**get_libraries_by_samples_as_user**](docs/LibraryIntegrationAsUserApi.md#get_libraries_by_samples_as_user) | **GET** /api/v1/as-user/integration/link/libraries/by/samples | Retrieve library metadata by querying related samples
|
|
218
|
+
*LibraryIntegrationAsUserApi* | [**get_library_by_sample_as_user**](docs/LibraryIntegrationAsUserApi.md#get_library_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/library/by/sample/{id} | Retrieve library metadata by querying related sample ID (accession)
|
|
219
|
+
*LibraryIntegrationAsUserApi* | [**get_library_groups_by_study_as_user**](docs/LibraryIntegrationAsUserApi.md#get_library_groups_by_study_as_user) | **GET** /api/v1/as-user/integration/link/library/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
220
|
+
*LibraryIntegrationAsUserApi* | [**get_library_links_to_samples_as_user**](docs/LibraryIntegrationAsUserApi.md#get_library_links_to_samples_as_user) | **GET** /api/v1/as-user/integration/link/library/libraries-to-samples/by/group/{id} | Retrieve library-samples pairs by group id. Pagination is based on unique libraries, not unique pairs.
|
|
221
|
+
*LinkageAsCuratorApi* | [**delete_link_as_curator**](docs/LinkageAsCuratorApi.md#delete_link_as_curator) | **DELETE** /api/v1/as-curator/links | Deletes existing links matching the specified criteria.
|
|
222
|
+
*LinkageAsCuratorApi* | [**get_data_types_as_curator**](docs/LinkageAsCuratorApi.md#get_data_types_as_curator) | **GET** /api/v1/as-curator/data-types | Lists all available data types.
|
|
223
|
+
*LinkageAsCuratorApi* | [**get_data_types_links_as_curator**](docs/LinkageAsCuratorApi.md#get_data_types_links_as_curator) | **GET** /api/v1/as-curator/data-types/links | List all possible links between data types that match the specified criteria.
|
|
224
|
+
*LinkageAsCuratorApi* | [**get_links_by_ids_as_curator**](docs/LinkageAsCuratorApi.md#get_links_by_ids_as_curator) | **POST** /api/v1/as-curator/links/get-batch | Finds existing links by passing many IDs. Pagination goes through all links matched the criteria.
|
|
225
|
+
*LinkageAsCuratorApi* | [**get_links_by_params_as_curator**](docs/LinkageAsCuratorApi.md#get_links_by_params_as_curator) | **GET** /api/v1/as-curator/links | Finds existing links matching the specified criteria.
|
|
226
|
+
*LinkageAsCuratorApi* | [**save_links_as_curator**](docs/LinkageAsCuratorApi.md#save_links_as_curator) | **POST** /api/v1/as-curator/links | Creates new links between objects.
|
|
227
|
+
*LinkageAsUserApi* | [**get_data_types_as_user**](docs/LinkageAsUserApi.md#get_data_types_as_user) | **GET** /api/v1/as-user/data-types | Lists all available data types.
|
|
228
|
+
*LinkageAsUserApi* | [**get_data_types_links_as_user**](docs/LinkageAsUserApi.md#get_data_types_links_as_user) | **GET** /api/v1/as-user/data-types/links | List all possible links between data types that match the specified criteria.
|
|
229
|
+
*LinkageAsUserApi* | [**get_links_by_ids_as_user**](docs/LinkageAsUserApi.md#get_links_by_ids_as_user) | **POST** /api/v1/as-user/links/get-batch | Finds existing links by passing many IDs. Pagination goes through all links matched the criteria.
|
|
230
|
+
*LinkageAsUserApi* | [**get_links_by_params_as_user**](docs/LinkageAsUserApi.md#get_links_by_params_as_user) | **GET** /api/v1/as-user/links | Finds existing links matching the specified criteria.
|
|
231
|
+
*ManageDataApi* | [**delete_data**](docs/ManageDataApi.md#delete_data) | **DELETE** /api/v1/manage-data/data | Delete objects from ODM
|
|
232
|
+
*ManageDataApi* | [**get_detached_objects**](docs/ManageDataApi.md#get_detached_objects) | **GET** /api/v1/manage-data/detached-objects | Retrieve a list of detached objects
|
|
233
|
+
*MetadataVersioningAsCuratorApi* | [**publish_study_by_accession_as_curator**](docs/MetadataVersioningAsCuratorApi.md#publish_study_by_accession_as_curator) | **POST** /api/v1/as-curator/integration/studies/{id}/tasks/publish-versions | Asynchronous task that publishes all pending versions for a single study.
|
|
234
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_expression_data_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_expression_data_as_curator) | **GET** /api/v1/as-curator/omics/expression/data | Retrieve data objects by searching across multiple data types
|
|
235
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_expression_groups_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_expression_groups_as_curator) | **GET** /api/v1/as-curator/omics/expression/group | Retrieve group objects by searching across multiple data types
|
|
236
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_flow_cytometry_data_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_flow_cytometry_data_as_curator) | **GET** /api/v1/as-curator/omics/flow-cytometry/data | Retrieve flow cytometry data objects by searching across multiple data types
|
|
237
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_flow_cytometry_groups_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_flow_cytometry_groups_as_curator) | **GET** /api/v1/as-curator/omics/flow-cytometry/group | Retrieve group objects by searching across multiple data types
|
|
238
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_samples_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_samples_as_curator) | **GET** /api/v1/as-curator/omics/samples | Retrieve sample metadata objects by searching across multiple data types
|
|
239
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_streamed_expression_data_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_streamed_expression_data_as_curator) | **GET** /api/v1/as-curator/omics/expression/streamed-data | Stream data from a given tabular file
|
|
240
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_variant_data_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_variant_data_as_curator) | **GET** /api/v1/as-curator/omics/variant/data | Retrieve variant data objects by searching across multiple data types
|
|
241
|
+
*OmicsQueriesAsCuratorApi* | [**omics_search_variant_groups_as_curator**](docs/OmicsQueriesAsCuratorApi.md#omics_search_variant_groups_as_curator) | **GET** /api/v1/as-curator/omics/variant/group | Retrieve group objects by searching across multiple data types
|
|
242
|
+
*OmicsQueriesAsUserApi* | [**omics_search_expression_data_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_expression_data_as_user) | **GET** /api/v1/as-user/omics/expression/data | Retrieve data objects by searching across multiple data types
|
|
243
|
+
*OmicsQueriesAsUserApi* | [**omics_search_expression_groups_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_expression_groups_as_user) | **GET** /api/v1/as-user/omics/expression/group | Retrieve group objects by searching across multiple data types
|
|
244
|
+
*OmicsQueriesAsUserApi* | [**omics_search_flow_cytometry_data_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_flow_cytometry_data_as_user) | **GET** /api/v1/as-user/omics/flow-cytometry/data | Retrieve flow cytometry data objects by searching across multiple data types
|
|
245
|
+
*OmicsQueriesAsUserApi* | [**omics_search_flow_cytometry_groups_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_flow_cytometry_groups_as_user) | **GET** /api/v1/as-user/omics/flow-cytometry/group | Retrieve group objects by searching across multiple data types
|
|
246
|
+
*OmicsQueriesAsUserApi* | [**omics_search_samples_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_samples_as_user) | **GET** /api/v1/as-user/omics/samples | Retrieve sample metadata objects by searching across multiple data types
|
|
247
|
+
*OmicsQueriesAsUserApi* | [**omics_search_streamed_expression_data_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_streamed_expression_data_as_user) | **GET** /api/v1/as-user/omics/expression/streamed-data | Stream data from a given tabular file
|
|
248
|
+
*OmicsQueriesAsUserApi* | [**omics_search_variant_data_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_variant_data_as_user) | **GET** /api/v1/as-user/omics/variant/data | Retrieve variant data objects by searching across multiple data types
|
|
249
|
+
*OmicsQueriesAsUserApi* | [**omics_search_variant_groups_as_user**](docs/OmicsQueriesAsUserApi.md#omics_search_variant_groups_as_user) | **GET** /api/v1/as-user/omics/variant/group | Retrieve group objects by searching across multiple data types
|
|
250
|
+
*PreparationSPoTAsCuratorApi* | [**add_preparations_as_curator**](docs/PreparationSPoTAsCuratorApi.md#add_preparations_as_curator) | **POST** /api/v1/as-curator/preparations | Add new preparation object
|
|
251
|
+
*PreparationSPoTAsCuratorApi* | [**delete_preparation_as_curator**](docs/PreparationSPoTAsCuratorApi.md#delete_preparation_as_curator) | **DELETE** /api/v1/as-curator/preparations/{id} | Delete a preparation object
|
|
252
|
+
*PreparationSPoTAsCuratorApi* | [**delete_preparation_group_as_curator**](docs/PreparationSPoTAsCuratorApi.md#delete_preparation_group_as_curator) | **DELETE** /api/v1/as-curator/preparations/group/{id} | Delete a preparation group with all related preparation objects
|
|
253
|
+
*PreparationSPoTAsCuratorApi* | [**get_preparation_as_curator**](docs/PreparationSPoTAsCuratorApi.md#get_preparation_as_curator) | **GET** /api/v1/as-curator/preparations/{id} | Retrieve a single preparation object by ID (accession)
|
|
254
|
+
*PreparationSPoTAsCuratorApi* | [**get_preparation_by_version_as_curator**](docs/PreparationSPoTAsCuratorApi.md#get_preparation_by_version_as_curator) | **GET** /api/v1/as-curator/preparations/{id}/versions/{version} | Retrieve a single preparation object by ID (accession)
|
|
255
|
+
*PreparationSPoTAsCuratorApi* | [**get_preparation_versions_as_curator**](docs/PreparationSPoTAsCuratorApi.md#get_preparation_versions_as_curator) | **GET** /api/v1/as-curator/preparations/{id}/versions | Retrieve a list of object versions by ID
|
|
256
|
+
*PreparationSPoTAsCuratorApi* | [**get_preparations_by_group_as_curator**](docs/PreparationSPoTAsCuratorApi.md#get_preparations_by_group_as_curator) | **GET** /api/v1/as-curator/preparations/by/group/{id} | Retrieve preparations related to the given group
|
|
257
|
+
*PreparationSPoTAsCuratorApi* | [**search_preparations_as_curator**](docs/PreparationSPoTAsCuratorApi.md#search_preparations_as_curator) | **GET** /api/v1/as-curator/preparations | List or search for preparation metadata objects
|
|
258
|
+
*PreparationSPoTAsCuratorApi* | [**update_preparation_as_curator**](docs/PreparationSPoTAsCuratorApi.md#update_preparation_as_curator) | **PATCH** /api/v1/as-curator/preparations/{id} | Update a preparation object
|
|
259
|
+
*PreparationSPoTAsUserApi* | [**get_preparation_as_user**](docs/PreparationSPoTAsUserApi.md#get_preparation_as_user) | **GET** /api/v1/as-user/preparations/{id} | Retrieve a single preparation object by ID (accession)
|
|
260
|
+
*PreparationSPoTAsUserApi* | [**get_preparation_by_version_as_user**](docs/PreparationSPoTAsUserApi.md#get_preparation_by_version_as_user) | **GET** /api/v1/as-user/preparations/{id}/versions/{version} | Retrieve a single preparation object by ID (accession)
|
|
261
|
+
*PreparationSPoTAsUserApi* | [**get_preparation_versions_as_user**](docs/PreparationSPoTAsUserApi.md#get_preparation_versions_as_user) | **GET** /api/v1/as-user/preparations/{id}/versions | Retrieve a list of object versions by ID
|
|
262
|
+
*PreparationSPoTAsUserApi* | [**get_preparations_by_group_as_user**](docs/PreparationSPoTAsUserApi.md#get_preparations_by_group_as_user) | **GET** /api/v1/as-user/preparations/by/group/{id} | Retrieve preparations related to the given group
|
|
263
|
+
*PreparationSPoTAsUserApi* | [**search_preparations_as_user**](docs/PreparationSPoTAsUserApi.md#search_preparations_as_user) | **GET** /api/v1/as-user/preparations | List or search for preparation metadata objects
|
|
264
|
+
*PreparationIntegrationAsCuratorApi* | [**create_preparation_group_sample_group_link_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#create_preparation_group_sample_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/preparation/group/{sourceId}/to/sample/group/{targetId} | Create links between samples and preparations
|
|
265
|
+
*PreparationIntegrationAsCuratorApi* | [**create_preparation_sample_link_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#create_preparation_sample_link_as_curator) | **POST** /api/v1/as-curator/integration/link/preparation/{sourceId}/to/sample/{targetId} | Create a link between a preparation and a sample
|
|
266
|
+
*PreparationIntegrationAsCuratorApi* | [**delete_preparation_group_sample_group_link_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#delete_preparation_group_sample_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/preparation/group/{sourceId}/to/sample/group/{targetId} | Delete links between samples and preparations related to the specified group
|
|
267
|
+
*PreparationIntegrationAsCuratorApi* | [**delete_preparation_sample_link_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#delete_preparation_sample_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/preparation/{sourceId}/to/sample/{targetId} | Delete a link between a preparation and a sample
|
|
268
|
+
*PreparationIntegrationAsCuratorApi* | [**get_preparation_by_sample_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#get_preparation_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/preparation/by/sample/{id} | Retrieve preparation metadata by querying related sample ID (accession)
|
|
269
|
+
*PreparationIntegrationAsCuratorApi* | [**get_preparation_groups_by_study_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#get_preparation_groups_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/preparation/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
270
|
+
*PreparationIntegrationAsCuratorApi* | [**get_preparation_links_to_samples_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#get_preparation_links_to_samples_as_curator) | **GET** /api/v1/as-curator/integration/link/preparation/preparations-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique preparations, not unique pairs.
|
|
271
|
+
*PreparationIntegrationAsCuratorApi* | [**get_preparations_by_samples_as_curator**](docs/PreparationIntegrationAsCuratorApi.md#get_preparations_by_samples_as_curator) | **GET** /api/v1/as-curator/integration/link/preparations/by/samples | Retrieve preparation metadata by querying related samples
|
|
272
|
+
*PreparationIntegrationAsUserApi* | [**get_preparation_by_sample_as_user**](docs/PreparationIntegrationAsUserApi.md#get_preparation_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/preparation/by/sample/{id} | Retrieve preparation metadata by querying related sample ID (accession)
|
|
273
|
+
*PreparationIntegrationAsUserApi* | [**get_preparation_groups_by_study_as_user**](docs/PreparationIntegrationAsUserApi.md#get_preparation_groups_by_study_as_user) | **GET** /api/v1/as-user/integration/link/preparation/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
274
|
+
*PreparationIntegrationAsUserApi* | [**get_preparation_links_to_samples_as_user**](docs/PreparationIntegrationAsUserApi.md#get_preparation_links_to_samples_as_user) | **GET** /api/v1/as-user/integration/link/preparation/preparations-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique preparations, not unique pairs.
|
|
275
|
+
*PreparationIntegrationAsUserApi* | [**get_preparations_by_samples_as_user**](docs/PreparationIntegrationAsUserApi.md#get_preparations_by_samples_as_user) | **GET** /api/v1/as-user/integration/link/preparations/by/samples | Retrieve preparation metadata by querying related samples
|
|
276
|
+
*SampleSPoTAsCuratorApi* | [**add_samples_as_curator**](docs/SampleSPoTAsCuratorApi.md#add_samples_as_curator) | **POST** /api/v1/as-curator/samples | Add new sample object
|
|
277
|
+
*SampleSPoTAsCuratorApi* | [**delete_sample_as_curator**](docs/SampleSPoTAsCuratorApi.md#delete_sample_as_curator) | **DELETE** /api/v1/as-curator/samples/{id} | Delete a sample object
|
|
278
|
+
*SampleSPoTAsCuratorApi* | [**get_sample_as_curator**](docs/SampleSPoTAsCuratorApi.md#get_sample_as_curator) | **GET** /api/v1/as-curator/samples/{id} | Retrieve a single sample object by ID (accession)
|
|
279
|
+
*SampleSPoTAsCuratorApi* | [**get_sample_by_version_as_curator**](docs/SampleSPoTAsCuratorApi.md#get_sample_by_version_as_curator) | **GET** /api/v1/as-curator/samples/{id}/versions/{version} | Retrieve a single sample object by ID (accession)
|
|
280
|
+
*SampleSPoTAsCuratorApi* | [**get_sample_versions_as_curator**](docs/SampleSPoTAsCuratorApi.md#get_sample_versions_as_curator) | **GET** /api/v1/as-curator/samples/{id}/versions | Retrieve a list of object versions by ID
|
|
281
|
+
*SampleSPoTAsCuratorApi* | [**search_samples_as_curator**](docs/SampleSPoTAsCuratorApi.md#search_samples_as_curator) | **GET** /api/v1/as-curator/samples | List or search for sample metadata objects
|
|
282
|
+
*SampleSPoTAsCuratorApi* | [**update_sample_as_curator**](docs/SampleSPoTAsCuratorApi.md#update_sample_as_curator) | **PATCH** /api/v1/as-curator/samples/{id} | Update a sample object
|
|
283
|
+
*SampleSPoTAsUserApi* | [**get_sample_as_user**](docs/SampleSPoTAsUserApi.md#get_sample_as_user) | **GET** /api/v1/as-user/samples/{id} | Retrieve a single sample object by ID (accession)
|
|
284
|
+
*SampleSPoTAsUserApi* | [**get_sample_by_version_as_user**](docs/SampleSPoTAsUserApi.md#get_sample_by_version_as_user) | **GET** /api/v1/as-user/samples/{id}/versions/{version} | Retrieve a single sample object by ID (accession)
|
|
285
|
+
*SampleSPoTAsUserApi* | [**get_sample_versions_as_user**](docs/SampleSPoTAsUserApi.md#get_sample_versions_as_user) | **GET** /api/v1/as-user/samples/{id}/versions | Retrieve a list of object versions by ID
|
|
286
|
+
*SampleSPoTAsUserApi* | [**search_samples_as_user**](docs/SampleSPoTAsUserApi.md#search_samples_as_user) | **GET** /api/v1/as-user/samples | List or search for sample metadata objects
|
|
287
|
+
*SampleIntegrationAsCuratorApi* | [**create_sample_group_study_link_as_curator**](docs/SampleIntegrationAsCuratorApi.md#create_sample_group_study_link_as_curator) | **POST** /api/v1/as-curator/integration/link/sample/group/{sourceId}/to/study/{targetId} | Create a link between a group of sample objects and a study
|
|
288
|
+
*SampleIntegrationAsCuratorApi* | [**create_sample_study_link_as_curator**](docs/SampleIntegrationAsCuratorApi.md#create_sample_study_link_as_curator) | **POST** /api/v1/as-curator/integration/link/sample/{sourceId}/to/study/{targetId} | Create a link between a sample and a study
|
|
289
|
+
*SampleIntegrationAsCuratorApi* | [**delete_sample_group_study_link_as_curator**](docs/SampleIntegrationAsCuratorApi.md#delete_sample_group_study_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/sample/group/{sourceId}/to/study/{targetId} | Delete link between a group of sample objects and a study
|
|
290
|
+
*SampleIntegrationAsCuratorApi* | [**delete_sample_study_link_as_curator**](docs/SampleIntegrationAsCuratorApi.md#delete_sample_study_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/sample/{sourceId}/to/study/{targetId} | Delete link between a sample and a study
|
|
291
|
+
*SampleIntegrationAsCuratorApi* | [**get_samples_by_libraries_as_curator**](docs/SampleIntegrationAsCuratorApi.md#get_samples_by_libraries_as_curator) | **GET** /api/v1/as-curator/integration/link/samples/by/libraries | Retrieve sample metadata by querying related libraries
|
|
292
|
+
*SampleIntegrationAsCuratorApi* | [**get_samples_by_preparations_as_curator**](docs/SampleIntegrationAsCuratorApi.md#get_samples_by_preparations_as_curator) | **GET** /api/v1/as-curator/integration/link/samples/by/preparations | Retrieve sample metadata by querying related preparations
|
|
293
|
+
*SampleIntegrationAsCuratorApi* | [**get_samples_by_study_as_curator**](docs/SampleIntegrationAsCuratorApi.md#get_samples_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/samples/by/study/{id} | Retrieve sample metadata by querying related study ID (accession)
|
|
294
|
+
*SampleIntegrationAsUserApi* | [**get_samples_by_libraries_as_user**](docs/SampleIntegrationAsUserApi.md#get_samples_by_libraries_as_user) | **GET** /api/v1/as-user/integration/link/samples/by/libraries | Retrieve sample metadata by querying related libraries
|
|
295
|
+
*SampleIntegrationAsUserApi* | [**get_samples_by_preparations_as_user**](docs/SampleIntegrationAsUserApi.md#get_samples_by_preparations_as_user) | **GET** /api/v1/as-user/integration/link/samples/by/preparations | Retrieve sample metadata by querying related preparations
|
|
296
|
+
*SampleIntegrationAsUserApi* | [**get_samples_by_study_as_user**](docs/SampleIntegrationAsUserApi.md#get_samples_by_study_as_user) | **GET** /api/v1/as-user/integration/link/samples/by/study/{id} | Retrieve sample metadata by querying related study ID (accession)
|
|
297
|
+
*StudySPoTAsCuratorApi* | [**add_study_as_curator**](docs/StudySPoTAsCuratorApi.md#add_study_as_curator) | **POST** /api/v1/as-curator/studies | Add new study object
|
|
298
|
+
*StudySPoTAsCuratorApi* | [**delete_study_as_curator**](docs/StudySPoTAsCuratorApi.md#delete_study_as_curator) | **DELETE** /api/v1/as-curator/studies/{id} | Delete a given study object. This will not delete related objects or links to related objects.
|
|
299
|
+
*StudySPoTAsCuratorApi* | [**get_study_as_curator**](docs/StudySPoTAsCuratorApi.md#get_study_as_curator) | **GET** /api/v1/as-curator/studies/{id} | Retrieve a single study object by ID (accession)
|
|
300
|
+
*StudySPoTAsCuratorApi* | [**get_study_by_version_as_curator**](docs/StudySPoTAsCuratorApi.md#get_study_by_version_as_curator) | **GET** /api/v1/as-curator/studies/{id}/versions/{version} | Retrieve a single study object by ID (accession)
|
|
301
|
+
*StudySPoTAsCuratorApi* | [**get_study_versions_as_curator**](docs/StudySPoTAsCuratorApi.md#get_study_versions_as_curator) | **GET** /api/v1/as-curator/studies/{id}/versions | Retrieve a list of object versions by ID
|
|
302
|
+
*StudySPoTAsCuratorApi* | [**search_studies_as_curator**](docs/StudySPoTAsCuratorApi.md#search_studies_as_curator) | **GET** /api/v1/as-curator/studies | List or search for study metadata objects
|
|
303
|
+
*StudySPoTAsCuratorApi* | [**update_study_as_curator**](docs/StudySPoTAsCuratorApi.md#update_study_as_curator) | **PATCH** /api/v1/as-curator/studies/{id} | Update a study object
|
|
304
|
+
*StudySPoTAsUserApi* | [**get_study_as_user**](docs/StudySPoTAsUserApi.md#get_study_as_user) | **GET** /api/v1/as-user/studies/{id} | Retrieve a single study object by ID (accession)
|
|
305
|
+
*StudySPoTAsUserApi* | [**get_study_by_version_as_user**](docs/StudySPoTAsUserApi.md#get_study_by_version_as_user) | **GET** /api/v1/as-user/studies/{id}/versions/{version} | Retrieve a single study object by ID (accession)
|
|
306
|
+
*StudySPoTAsUserApi* | [**get_study_versions_as_user**](docs/StudySPoTAsUserApi.md#get_study_versions_as_user) | **GET** /api/v1/as-user/studies/{id}/versions | Retrieve a list of object versions by ID
|
|
307
|
+
*StudySPoTAsUserApi* | [**search_studies_as_user**](docs/StudySPoTAsUserApi.md#search_studies_as_user) | **GET** /api/v1/as-user/studies | List or search for study metadata objects
|
|
308
|
+
*StudyIntegrationAsCuratorApi* | [**get_studies_by_libraries_as_curator**](docs/StudyIntegrationAsCuratorApi.md#get_studies_by_libraries_as_curator) | **GET** /api/v1/as-curator/integration/link/studies/by/libraries | Retrieve study metadata objects by querying related libraries
|
|
309
|
+
*StudyIntegrationAsCuratorApi* | [**get_studies_by_preparations_as_curator**](docs/StudyIntegrationAsCuratorApi.md#get_studies_by_preparations_as_curator) | **GET** /api/v1/as-curator/integration/link/studies/by/preparations | Retrieve study metadata objects by querying related preparations
|
|
310
|
+
*StudyIntegrationAsCuratorApi* | [**get_studies_by_samples_as_curator**](docs/StudyIntegrationAsCuratorApi.md#get_studies_by_samples_as_curator) | **GET** /api/v1/as-curator/integration/link/studies/by/samples | Retrieve study metadata objects by querying related samples
|
|
311
|
+
*StudyIntegrationAsCuratorApi* | [**get_study_by_sample_as_curator**](docs/StudyIntegrationAsCuratorApi.md#get_study_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/study/by/sample/{id} | Retrieve study metadata by querying sample ID (accession)
|
|
312
|
+
*StudyIntegrationAsCuratorApi* | [**search_studies_by_filter_as_curator**](docs/StudyIntegrationAsCuratorApi.md#search_studies_by_filter_as_curator) | **POST** /api/v1/as-curator/integration/fulltext/search/studies | Find and retrieve studies via full-text or facet query
|
|
313
|
+
*StudyIntegrationAsUserApi* | [**get_studies_by_libraries_as_user**](docs/StudyIntegrationAsUserApi.md#get_studies_by_libraries_as_user) | **GET** /api/v1/as-user/integration/link/studies/by/libraries | Retrieve study metadata objects by querying related libraries
|
|
314
|
+
*StudyIntegrationAsUserApi* | [**get_studies_by_preparations_as_user**](docs/StudyIntegrationAsUserApi.md#get_studies_by_preparations_as_user) | **GET** /api/v1/as-user/integration/link/studies/by/preparations | Retrieve study metadata objects by querying related preparations
|
|
315
|
+
*StudyIntegrationAsUserApi* | [**get_studies_by_samples_as_user**](docs/StudyIntegrationAsUserApi.md#get_studies_by_samples_as_user) | **GET** /api/v1/as-user/integration/link/studies/by/samples | Retrieve study metadata objects by querying related samples
|
|
316
|
+
*StudyIntegrationAsUserApi* | [**get_study_by_sample_as_user**](docs/StudyIntegrationAsUserApi.md#get_study_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/study/by/sample/{id} | Retrieve study metadata by querying sample ID (accession)
|
|
317
|
+
*StudyIntegrationAsUserApi* | [**search_studies_by_filter_as_user**](docs/StudyIntegrationAsUserApi.md#search_studies_by_filter_as_user) | **POST** /api/v1/as-user/integration/fulltext/search/studies | Find and retrieve studies via full-text or facet query
|
|
318
|
+
*TasksAPIApi* | [**get_task_info**](docs/TasksAPIApi.md#get_task_info) | **GET** /api/v1/tasks/{id} | Retrieve information about any ODM task.
|
|
319
|
+
*TasksAPIApi* | [**publish_all_studies**](docs/TasksAPIApi.md#publish_all_studies) | **POST** /api/v1/tasks/publish-versions | Asynchronous task that publishes all pending versions across all studies in the instance.
|
|
320
|
+
*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /api/v1/scim/Users | Add a new user
|
|
321
|
+
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /api/v1/scim/Users/{id} | Deactivate a user
|
|
322
|
+
*UsersApi* | [**find_users**](docs/UsersApi.md#find_users) | **GET** /api/v1/scim/Users | Retrieve a list of all active users
|
|
323
|
+
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /api/v1/scim/Users/{id} | Retrieve a user by id
|
|
324
|
+
*UsersApi* | [**patch_user**](docs/UsersApi.md#patch_user) | **PATCH** /api/v1/scim/Users/{id} | Update a user
|
|
325
|
+
*ValidationSummaryAsCuratorApi* | [**search_expression_data_as_curator**](docs/ValidationSummaryAsCuratorApi.md#search_expression_data_as_curator) | **GET** /api/v1/as-curator/integration/studies/{id}/validation-summary | Retrieve validation summary by querying study ID (accession)
|
|
326
|
+
*VariantSPoTAsCuratorApi* | [**add_variants_as_curator**](docs/VariantSPoTAsCuratorApi.md#add_variants_as_curator) | **POST** /api/v1/as-curator/variants/vcf | Create multiple new objects from a multi-row data file with optional supplied metadata
|
|
327
|
+
*VariantSPoTAsCuratorApi* | [**delete_variant_group_as_curator**](docs/VariantSPoTAsCuratorApi.md#delete_variant_group_as_curator) | **DELETE** /api/v1/as-curator/variants/group/{id} | Delete the object
|
|
328
|
+
*VariantSPoTAsCuratorApi* | [**get_all_variants_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_all_variants_as_curator) | **GET** /api/v1/as-curator/variants | Retrieve multiple variant data and metadata objects
|
|
329
|
+
*VariantSPoTAsCuratorApi* | [**get_variant_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_variant_as_curator) | **GET** /api/v1/as-curator/variants/{id} | Retrieve a single variant object by ID (accession)
|
|
330
|
+
*VariantSPoTAsCuratorApi* | [**get_variant_by_version_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_variant_by_version_as_curator) | **GET** /api/v1/as-curator/variants/{id}/versions/{version} | Retrieve a single variant object by ID (accession)
|
|
331
|
+
*VariantSPoTAsCuratorApi* | [**get_variant_group_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_variant_group_as_curator) | **GET** /api/v1/as-curator/variants/group/{id} | Retrieve a single group object by ID (accession)
|
|
332
|
+
*VariantSPoTAsCuratorApi* | [**get_variant_group_by_run_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_variant_group_by_run_as_curator) | **GET** /api/v1/as-curator/variants/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
333
|
+
*VariantSPoTAsCuratorApi* | [**get_variant_versions_as_curator**](docs/VariantSPoTAsCuratorApi.md#get_variant_versions_as_curator) | **GET** /api/v1/as-curator/variants/{id}/versions | Retrieve a list of object versions by ID
|
|
334
|
+
*VariantSPoTAsCuratorApi* | [**search_groups_as_curator**](docs/VariantSPoTAsCuratorApi.md#search_groups_as_curator) | **GET** /api/v1/as-curator/variants/group | Retrieve groups that match a query
|
|
335
|
+
*VariantSPoTAsCuratorApi* | [**search_variant_runs_as_curator**](docs/VariantSPoTAsCuratorApi.md#search_variant_runs_as_curator) | **GET** /api/v1/as-curator/variants/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
336
|
+
*VariantSPoTAsCuratorApi* | [**update_variant_as_curator**](docs/VariantSPoTAsCuratorApi.md#update_variant_as_curator) | **PATCH** /api/v1/as-curator/variants/{id} | Update object metadata
|
|
337
|
+
*VariantSPoTAsUserApi* | [**get_all_variants_as_user**](docs/VariantSPoTAsUserApi.md#get_all_variants_as_user) | **GET** /api/v1/as-user/variants | Retrieve multiple variant data and metadata objects
|
|
338
|
+
*VariantSPoTAsUserApi* | [**get_variant_as_user**](docs/VariantSPoTAsUserApi.md#get_variant_as_user) | **GET** /api/v1/as-user/variants/{id} | Retrieve a single variant object by ID (accession)
|
|
339
|
+
*VariantSPoTAsUserApi* | [**get_variant_by_version_as_user**](docs/VariantSPoTAsUserApi.md#get_variant_by_version_as_user) | **GET** /api/v1/as-user/variants/{id}/versions/{version} | Retrieve a single variant object by ID (accession)
|
|
340
|
+
*VariantSPoTAsUserApi* | [**get_variant_group_as_user**](docs/VariantSPoTAsUserApi.md#get_variant_group_as_user) | **GET** /api/v1/as-user/variants/group/{id} | Retrieve a single group object by ID (accession)
|
|
341
|
+
*VariantSPoTAsUserApi* | [**get_variant_group_by_run_as_user**](docs/VariantSPoTAsUserApi.md#get_variant_group_by_run_as_user) | **GET** /api/v1/as-user/variants/group/by/run/{id} | Retrieve a single group object by run ID (accession)
|
|
342
|
+
*VariantSPoTAsUserApi* | [**get_variant_versions_as_user**](docs/VariantSPoTAsUserApi.md#get_variant_versions_as_user) | **GET** /api/v1/as-user/variants/{id}/versions | Retrieve a list of object versions by ID
|
|
343
|
+
*VariantSPoTAsUserApi* | [**search_variant_groups_as_user**](docs/VariantSPoTAsUserApi.md#search_variant_groups_as_user) | **GET** /api/v1/as-user/variants/group | Retrieve groups that match a query
|
|
344
|
+
*VariantSPoTAsUserApi* | [**search_variant_runs_as_user**](docs/VariantSPoTAsUserApi.md#search_variant_runs_as_user) | **GET** /api/v1/as-user/variants/runs/by/group/{id} | Retrieve run objects related to the given group
|
|
345
|
+
*VariantIntegrationAsCuratorApi* | [**create_variant_group_sample_group_link_as_curator**](docs/VariantIntegrationAsCuratorApi.md#create_variant_group_sample_group_link_as_curator) | **POST** /api/v1/as-curator/integration/link/variant/group/{sourceId}/to/sample/group/{targetId} | Create a link between a group of variant objects and a group of sample objects
|
|
346
|
+
*VariantIntegrationAsCuratorApi* | [**create_variant_sample_link_as_curator**](docs/VariantIntegrationAsCuratorApi.md#create_variant_sample_link_as_curator) | **POST** /api/v1/as-curator/integration/link/variant/{sourceId}/to/sample/{targetId} | Create a link between a variant object and a sample
|
|
347
|
+
*VariantIntegrationAsCuratorApi* | [**delete_variant_group_sample_group_link_as_curator**](docs/VariantIntegrationAsCuratorApi.md#delete_variant_group_sample_group_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/variant/group/{sourceId}/to/sample/group/{targetId} | Delete link between a group of variant objects and a group of sample objects
|
|
348
|
+
*VariantIntegrationAsCuratorApi* | [**delete_variant_sample_link_as_curator**](docs/VariantIntegrationAsCuratorApi.md#delete_variant_sample_link_as_curator) | **DELETE** /api/v1/as-curator/integration/link/variant/{sourceId}/to/sample/{targetId} | Delete link between a variant object and a sample
|
|
349
|
+
*VariantIntegrationAsCuratorApi* | [**get_variant_by_sample_as_curator**](docs/VariantIntegrationAsCuratorApi.md#get_variant_by_sample_as_curator) | **GET** /api/v1/as-curator/integration/link/variant/by/sample/{id} | Retrieve variant run-level data by querying related sample ID (accession)
|
|
350
|
+
*VariantIntegrationAsCuratorApi* | [**get_variant_groups_by_study_as_curator**](docs/VariantIntegrationAsCuratorApi.md#get_variant_groups_by_study_as_curator) | **GET** /api/v1/as-curator/integration/link/variant/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
351
|
+
*VariantIntegrationAsCuratorApi* | [**get_variant_run_to_sample_pairs_as_curator**](docs/VariantIntegrationAsCuratorApi.md#get_variant_run_to_sample_pairs_as_curator) | **GET** /api/v1/as-curator/integration/link/variant/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
352
|
+
*VariantIntegrationAsUserApi* | [**get_variant_by_sample_as_user**](docs/VariantIntegrationAsUserApi.md#get_variant_by_sample_as_user) | **GET** /api/v1/as-user/integration/link/variant/by/sample/{id} | Retrieve variant run-level data by querying related sample ID (accession)
|
|
353
|
+
*VariantIntegrationAsUserApi* | [**get_variant_groups_by_study_as_user**](docs/VariantIntegrationAsUserApi.md#get_variant_groups_by_study_as_user) | **GET** /api/v1/as-user/integration/link/variant/group/by/study/{id} | Retrieve group metadata by querying study ID (accession)
|
|
354
|
+
*VariantIntegrationAsUserApi* | [**get_variant_run_to_sample_pairs_as_user**](docs/VariantIntegrationAsUserApi.md#get_variant_run_to_sample_pairs_as_user) | **GET** /api/v1/as-user/integration/link/variant/run-to-samples/by/group/{id} | Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
|
|
355
|
+
*XrefsetQueriesApi* | [**create**](docs/XrefsetQueriesApi.md#create) | **POST** /api/v1/xrefsets | Import a new xrefset file
|
|
356
|
+
*XrefsetQueriesApi* | [**delete_file**](docs/XrefsetQueriesApi.md#delete_file) | **DELETE** /api/v1/xrefsets/{id} | Delete a xrefset with all related data. Only users who uploaded the xrefset are allowed to delete it.
|
|
357
|
+
*XrefsetQueriesApi* | [**get_details_by_accession**](docs/XrefsetQueriesApi.md#get_details_by_accession) | **GET** /api/v1/xrefsets/{id}/metadata | Retrieve xrefset details
|
|
358
|
+
*XrefsetQueriesApi* | [**search_entries**](docs/XrefsetQueriesApi.md#search_entries) | **GET** /api/v1/xrefsets/entries | Retrieve a list of entries across all xrefsets for given sourceId and targetId
|
|
359
|
+
*XrefsetQueriesApi* | [**search_entries_within_file**](docs/XrefsetQueriesApi.md#search_entries_within_file) | **GET** /api/v1/xrefsets/{id}/entries | Retrieve a list of entries for the given xrefset and given sourceId and targetId
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
## Documentation For Models
|
|
363
|
+
|
|
364
|
+
- [AppliedFilter](docs/AppliedFilter.md)
|
|
365
|
+
- [AttributeInvalidValue](docs/AttributeInvalidValue.md)
|
|
366
|
+
- [AttributeInvalidValueErrorsInner](docs/AttributeInvalidValueErrorsInner.md)
|
|
367
|
+
- [AttributeValidationSummary](docs/AttributeValidationSummary.md)
|
|
368
|
+
- [AttributeValidationSummaryAttributeInvalidValuesInner](docs/AttributeValidationSummaryAttributeInvalidValuesInner.md)
|
|
369
|
+
- [BaseErrorResponse](docs/BaseErrorResponse.md)
|
|
370
|
+
- [BaseErrorResponseError](docs/BaseErrorResponseError.md)
|
|
371
|
+
- [BatchOfIds](docs/BatchOfIds.md)
|
|
372
|
+
- [CommitInfo](docs/CommitInfo.md)
|
|
373
|
+
- [CreateGroup201Response](docs/CreateGroup201Response.md)
|
|
374
|
+
- [CreateGroupRequest](docs/CreateGroupRequest.md)
|
|
375
|
+
- [CreateGroupRequestMembersInner](docs/CreateGroupRequestMembersInner.md)
|
|
376
|
+
- [CreateUser201Response](docs/CreateUser201Response.md)
|
|
377
|
+
- [CreateUser201ResponseAllOfMeta](docs/CreateUser201ResponseAllOfMeta.md)
|
|
378
|
+
- [CreateUserRequest](docs/CreateUserRequest.md)
|
|
379
|
+
- [CreateUserRequestEmailsInner](docs/CreateUserRequestEmailsInner.md)
|
|
380
|
+
- [DataItem](docs/DataItem.md)
|
|
381
|
+
- [DataPresentation](docs/DataPresentation.md)
|
|
382
|
+
- [DataPresentationRelationships](docs/DataPresentationRelationships.md)
|
|
383
|
+
- [DetachedCollection](docs/DetachedCollection.md)
|
|
384
|
+
- [DetachedCollectionDataInner](docs/DetachedCollectionDataInner.md)
|
|
385
|
+
- [DetachedObject](docs/DetachedObject.md)
|
|
386
|
+
- [Email](docs/Email.md)
|
|
387
|
+
- [ErrorMessage](docs/ErrorMessage.md)
|
|
388
|
+
- [ExceptionTypeAndMessage](docs/ExceptionTypeAndMessage.md)
|
|
389
|
+
- [ExpressionItem](docs/ExpressionItem.md)
|
|
390
|
+
- [ExpressionResponse](docs/ExpressionResponse.md)
|
|
391
|
+
- [ExpressionSignalSource](docs/ExpressionSignalSource.md)
|
|
392
|
+
- [FilterGroupsResponse](docs/FilterGroupsResponse.md)
|
|
393
|
+
- [FilterOption](docs/FilterOption.md)
|
|
394
|
+
- [FilterOptionGroup](docs/FilterOptionGroup.md)
|
|
395
|
+
- [FilterUsersResponse](docs/FilterUsersResponse.md)
|
|
396
|
+
- [FindObjectsResponse](docs/FindObjectsResponse.md)
|
|
397
|
+
- [FindObjectsResponseFilterOptionGroupsInner](docs/FindObjectsResponseFilterOptionGroupsInner.md)
|
|
398
|
+
- [FindObjectsResponseFilterOptionGroupsInnerOptionsInner](docs/FindObjectsResponseFilterOptionGroupsInnerOptionsInner.md)
|
|
399
|
+
- [FindObjectsResponseObjectsPage](docs/FindObjectsResponseObjectsPage.md)
|
|
400
|
+
- [FindObjectsResponseObjectsPageContentInner](docs/FindObjectsResponseObjectsPageContentInner.md)
|
|
401
|
+
- [FindObjectsResponseObjectsPageContentInnerSummaryInner](docs/FindObjectsResponseObjectsPageContentInnerSummaryInner.md)
|
|
402
|
+
- [FlowCytometryItem](docs/FlowCytometryItem.md)
|
|
403
|
+
- [FlowCytometryResponse](docs/FlowCytometryResponse.md)
|
|
404
|
+
- [FlowCytometrySignalSource](docs/FlowCytometrySignalSource.md)
|
|
405
|
+
- [GetExpressionAsUser200Response](docs/GetExpressionAsUser200Response.md)
|
|
406
|
+
- [GetExpressionAsUser200ResponseFeature](docs/GetExpressionAsUser200ResponseFeature.md)
|
|
407
|
+
- [GetExpressionAsUser200ResponseValue](docs/GetExpressionAsUser200ResponseValue.md)
|
|
408
|
+
- [GetFlowCytometryAsCurator200Response](docs/GetFlowCytometryAsCurator200Response.md)
|
|
409
|
+
- [GetVariantAsCurator200Response](docs/GetVariantAsCurator200Response.md)
|
|
410
|
+
- [Group](docs/Group.md)
|
|
411
|
+
- [GroupPatch](docs/GroupPatch.md)
|
|
412
|
+
- [GroupResponse](docs/GroupResponse.md)
|
|
413
|
+
- [GroupValidationSummary](docs/GroupValidationSummary.md)
|
|
414
|
+
- [GroupValidationSummaryAttributesInner](docs/GroupValidationSummaryAttributesInner.md)
|
|
415
|
+
- [IMetadata](docs/IMetadata.md)
|
|
416
|
+
- [ImportExpressionSignalRunRequest](docs/ImportExpressionSignalRunRequest.md)
|
|
417
|
+
- [ImportMetadataRequest](docs/ImportMetadataRequest.md)
|
|
418
|
+
- [ImportSignalRunRequest](docs/ImportSignalRunRequest.md)
|
|
419
|
+
- [Info](docs/Info.md)
|
|
420
|
+
- [JobRuntimeError](docs/JobRuntimeError.md)
|
|
421
|
+
- [JobRuntimeErrorStackInner](docs/JobRuntimeErrorStackInner.md)
|
|
422
|
+
- [JsonMetadata](docs/JsonMetadata.md)
|
|
423
|
+
- [Link](docs/Link.md)
|
|
424
|
+
- [ListResponse](docs/ListResponse.md)
|
|
425
|
+
- [ListResponseMeta](docs/ListResponseMeta.md)
|
|
426
|
+
- [ListResponseMetaPagination](docs/ListResponseMetaPagination.md)
|
|
427
|
+
- [ManagedObject](docs/ManagedObject.md)
|
|
428
|
+
- [Member](docs/Member.md)
|
|
429
|
+
- [Meta](docs/Meta.md)
|
|
430
|
+
- [MetaResponse](docs/MetaResponse.md)
|
|
431
|
+
- [MetadataPresentation](docs/MetadataPresentation.md)
|
|
432
|
+
- [MetadataPresentationMetadata](docs/MetadataPresentationMetadata.md)
|
|
433
|
+
- [MetadataWithId](docs/MetadataWithId.md)
|
|
434
|
+
- [MetainfoKeyForSummary](docs/MetainfoKeyForSummary.md)
|
|
435
|
+
- [ObjectsPage](docs/ObjectsPage.md)
|
|
436
|
+
- [OmicsResponse](docs/OmicsResponse.md)
|
|
437
|
+
- [OmicsResponseDataPresentation](docs/OmicsResponseDataPresentation.md)
|
|
438
|
+
- [OmicsResponseDataPresentationDataInner](docs/OmicsResponseDataPresentationDataInner.md)
|
|
439
|
+
- [OmicsResponseMetadataPresentation](docs/OmicsResponseMetadataPresentation.md)
|
|
440
|
+
- [OmicsResponseMetadataPresentationDataInner](docs/OmicsResponseMetadataPresentationDataInner.md)
|
|
441
|
+
- [OmicsResponseMetadataWithId](docs/OmicsResponseMetadataWithId.md)
|
|
442
|
+
- [Output](docs/Output.md)
|
|
443
|
+
- [OutputErrorsInner](docs/OutputErrorsInner.md)
|
|
444
|
+
- [PageRequest](docs/PageRequest.md)
|
|
445
|
+
- [PaginationInfo](docs/PaginationInfo.md)
|
|
446
|
+
- [PatchOperation](docs/PatchOperation.md)
|
|
447
|
+
- [Relationships](docs/Relationships.md)
|
|
448
|
+
- [RunsResponse](docs/RunsResponse.md)
|
|
449
|
+
- [SCIMErrorResponse](docs/SCIMErrorResponse.md)
|
|
450
|
+
- [SampleSource](docs/SampleSource.md)
|
|
451
|
+
- [SearchStudyRequest](docs/SearchStudyRequest.md)
|
|
452
|
+
- [SearchStudyRequestFiltersInner](docs/SearchStudyRequestFiltersInner.md)
|
|
453
|
+
- [SearchStudyRequestPage](docs/SearchStudyRequestPage.md)
|
|
454
|
+
- [SourceTypePair](docs/SourceTypePair.md)
|
|
455
|
+
- [StartImportFlowCytometryRequest](docs/StartImportFlowCytometryRequest.md)
|
|
456
|
+
- [StudyGenericSource](docs/StudyGenericSource.md)
|
|
457
|
+
- [StudySearchInfo](docs/StudySearchInfo.md)
|
|
458
|
+
- [StudyValidationSummary](docs/StudyValidationSummary.md)
|
|
459
|
+
- [StudyValidationSummarySamplesInner](docs/StudyValidationSummarySamplesInner.md)
|
|
460
|
+
- [TaskInfo](docs/TaskInfo.md)
|
|
461
|
+
- [User](docs/User.md)
|
|
462
|
+
- [UserPatch](docs/UserPatch.md)
|
|
463
|
+
- [UserPatchOperationsInner](docs/UserPatchOperationsInner.md)
|
|
464
|
+
- [UserResponse](docs/UserResponse.md)
|
|
465
|
+
- [ValidationError](docs/ValidationError.md)
|
|
466
|
+
- [VariantItem](docs/VariantItem.md)
|
|
467
|
+
- [VariantResponse](docs/VariantResponse.md)
|
|
468
|
+
- [VariantSignalSource](docs/VariantSignalSource.md)
|
|
469
|
+
- [XrefSetCreateRequest](docs/XrefSetCreateRequest.md)
|
|
470
|
+
- [XrefSetCreateResponse](docs/XrefSetCreateResponse.md)
|
|
471
|
+
- [XrefSetMetadata](docs/XrefSetMetadata.md)
|
|
472
|
+
- [XrefSetSearchResult](docs/XrefSetSearchResult.md)
|
|
473
|
+
- [XrefSetSearchResultEntry](docs/XrefSetSearchResultEntry.md)
|
|
474
|
+
- [XrefSetSearchResultResultInner](docs/XrefSetSearchResultResultInner.md)
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<a id="documentation-for-authorization"></a>
|
|
478
|
+
## Documentation For Authorization
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
Authentication schemes defined for the API:
|
|
482
|
+
<a id="Access-token"></a>
|
|
483
|
+
### Access-token
|
|
484
|
+
|
|
485
|
+
- **Type**: API key
|
|
486
|
+
- **API key parameter name**: Authorization
|
|
487
|
+
- **Location**: HTTP header
|
|
488
|
+
|
|
489
|
+
<a id="Genestack-API-Token"></a>
|
|
490
|
+
### Genestack-API-Token
|
|
491
|
+
|
|
492
|
+
- **Type**: API key
|
|
493
|
+
- **API key parameter name**: Genestack-API-Token
|
|
494
|
+
- **Location**: HTTP header
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
## Author
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|