Wiki
Clone wikienterobase-web / api_info
Top level links:
- Main top level page for all documentation
- EnteroBase Features
- Registering on EnteroBase and logging in
- Tutorials
- Using the API
- About the underlying pipelines and other internals
- How schemes in EnteroBase work
- FAQ
The info query method
Refer to interactive documentation : http://enterobase.warwick.ac.uk/api/v2.0/swagger-ui#!/Info
The info
query method shows a "site map" of API URLs.
For example, an info
query with the parameter "name" set to "senterica" (for that database).
A request is made to the URL
http://enterobase.warwick.ac.uk/api/v2.0
returning the result
[ { "description": "Salmonella", "links": { "assemblies": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/assemblies", "current": "http://enterobase.warwick.ac.uk/api/v2.0", "schemes": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/schemes", "straindata": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/straindata", "strains": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/strains", "sts": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/rMLST/sts", "traces": "http://enterobase.warwick.ac.uk/api/v2.0/senterica/traces" }, "name": "senterica", "prefix": "SAL", "tables": "{'schemes': 'SC', 'snps': 'SN', 'alleles': 'AL', 'assemblies': 'AS', 'loci': 'LO', 'taxondef': 'TA', 'strains': 'SS', 'datadefs': 'DE', 'sts': 'ST', 'traces': 'TR', 'archive': 'AR', 'refsets': 'RE'}" } ]
providing direct links to the various endpoints in the given database.
Updated