The OmicIDX API documentation is available in three forms:
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.99
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import omicidx_clientInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import omicidx_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import omicidx_client
from omicidx_client.rest import ApiException
from pprint import pprint
# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"
# Enter a context with an instance of the API client
with omicidx_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = omicidx_client.BiosampleApi(api_client)
entity = 'entity_example' # str |
try:
# Mapping
api_response = api_instance.biosample_fields_entity_get(entity)
pprint(api_response)
except ApiException as e:
print("Exception when calling BiosampleApi->biosample_fields_entity_get: %s\n" % e)
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BiosampleApi | biosample_fields_entity_get | GET /biosample/fields/{entity} | Mapping |
| BiosampleApi | biosample_samples_get | GET /biosample/samples | Biosamples |
| BiosampleApi | by_accession_biosample_samples_accession_get | GET /biosample/samples/{accession} | Biosample By Accession |
| GEOApi | by_accession_geo_platform_accession_get | GET /geo/platform/{accession} | Platform By Accession |
| GEOApi | by_accession_geo_samples_accession_get | GET /geo/samples/{accession} | Sample By Accession |
| GEOApi | by_accession_geo_series_accession_get | GET /geo/series/{accession} | Series By Accession |
| GEOApi | for_platform_geo_platforms_accession_samples_get | GET /geo/platforms/{accession}/samples | Samples For Platform |
| GEOApi | geo_fields_entity_get | GET /geo/fields/{entity} | Mapping |
| GEOApi | platforms_geo_platforms_get | GET /geo/platforms | Search Platforms |
| GEOApi | samples_geo_samples_get | GET /geo/samples | Search Samples |
| GEOApi | series_geo_series_get | GET /geo/series | Search Series |
| GEOPlatformsApi | by_accession_geo_platform_accession_get | GET /geo/platform/{accession} | Platform By Accession |
| SRAApi | by_accession_sra_experiments_accession_get | GET /sra/experiments/{accession} | Experiment By Accession |
| SRAApi | by_accession_sra_runs_accession_get | GET /sra/runs/{accession} | Run By Accession |
| SRAApi | by_accession_sra_samples_accession_get | GET /sra/samples/{accession} | Sample By Accession |
| SRAApi | by_accession_sra_studies_accession_get | GET /sra/studies/{accession} | Study By Accession |
| SRAApi | for_experiment_sra_experiments_accession_runs_get | GET /sra/experiments/{accession}/runs | Runs For Experiment |
| SRAApi | for_sample_sra_samples_accession_experiments_get | GET /sra/samples/{accession}/experiments | Experiments For Sample |
| SRAApi | for_sample_sra_samples_accession_runs_get | GET /sra/samples/{accession}/runs | Runs For Sample |
| SRAApi | for_study_sra_studies_accession_experiments_get | GET /sra/studies/{accession}/experiments | Experiments For Study |
| SRAApi | for_study_sra_studies_accession_runs_get | GET /sra/studies/{accession}/runs | Runs For Study |
| SRAApi | for_study_sra_studies_accession_samples_get | GET /sra/studies/{accession}/samples | Samples For Study |
| SRAApi | sra_experiments_get | GET /sra/experiments | Experiments |
| SRAApi | sra_fields_entity_get | GET /sra/fields/{entity} | Mapping |
| SRAApi | sra_runs_get | GET /sra/runs | Runs |
| SRAApi | sra_samples_get | GET /sra/samples | Samples |
| SRAApi | sra_studies_get | GET /sra/studies | Studies |
| DefaultApi | by_index_facets_entity_get | GET /facets/{entity} | Facets By Index |
All endpoints do not require authorization.