Bridgedb
BridgeDb is a biological identifier mapping database and toolset used to translate identifiers across life-science data sources.
- Base URL:
https://webservice.bridgedb.org - Auth:
bearer(pass your key via theapiKeyinput)
Operations
get_organism_attributesearch_query— GET /{organism}/attributeSearch/{query} — Returns a list of xrefs and associated attributes that contain the query stringget_organism_attributeset— GET /{organism}/attributeSet — Returns the supported attributes to the given Organism.get_organism_attributes_systemcode_identifier— GET /{organism}/attributes/{systemCode}/{identifier} — Returns the attributes for a given identifier, data source, organism. Optionallyget_organism_isfreesearchsupported— GET /{organism}/isFreeSearchSupported — Returnstrueorfalsebased on whether or not /{organism}/search/{query} isget_organism_ismappingsupported_sourcesystemcode— GET /{organism}/isMappingSupported/{sourceSystemCode}/{targetSystemCode} — Returnstrueorfalsebased on whether or not /{organism}/xrefs/{systemCode}get_organism_properties— GET /{organism}/properties — Returns the list of properties available for a given organism
Inputs
apiKey— your bridgedb API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_organism_attributesearch_query
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: get_organism_attributesearch_query, get_organism_attributeset, get_organism_attributes_systemcode_identifier, get_organism_isfreesearchsupported, get_organism_ismappingsupported_sourcesystemcode, get_organism_properties |
identifier |
string | no | — | Path parameter identifier (required by some operations). |
organism |
string | no | — | Path parameter organism (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |
sourceSystemCode |
string | no | — | Path parameter sourceSystemCode (required by some operations). |
systemCode |
string | no | — | Path parameter systemCode (required by some operations). |
targetSystemCode |
string | no | — | Path parameter targetSystemCode (required by some operations). |