Lookup API

/find_ids
GET Find the ids corresponding to given labels, from the dictionaries specified through the 'dictionaries' parameter

Parameters

Name Located in Description Type
dictionaries url dictionary names, delimited by comma (',') or pipe ('|') String
labels url labels, delimited by newline('\n'), tab('\t'), or pipe ('|') String
rich url set it 'true' for rich output Boolean
threshold url similarity threshold for cut-off Float

Responses

200 A hash of ids for labels 
{
  "stomach": [
    "http://purl.obolibrary.org/obo/UBERON_0000945"
  ]
}
400 Bad Request 
{
  "message": "no label is supplied."
}
POST Same as above, but a set of labels can be given in JSON

Parameters

Name Located in Description Type
dictionaries url dictionary names, delimited by comma (',') or pipe ('|') String
labels body labels String
rich url set it 'true' for rich output Boolean
threshold url similarity threshold for cut-off Float

Responses

200 A hash of ids for labels 
{
  "stomach": [
    "http://purl.obolibrary.org/obo/UBERON_0000945"
  ]
}
400 Bad Request 
{
  "message": "no label is supplied."
}
/find_terms
GET Find the terms correcponding to given ids, from the dictionaries specified through the 'dictionaries' parameter, or from all the dictionaries when the 'dictionaries' parameter is empty

Parameters

Name Located in Description Type
dictionaries url dictionary names, delimited by comma (',') or pipe ('|') String
ids url labels, delimited by newline('\n'), tab('\t'), or pipe ('|') String

Responses

200 A hash of terms for ids 
{
  "http://purl.obolibrary.org/obo/UBERON_0000945": [
    {"label": "stomach", "dictionary": "UBERON-AE"}
  ]
}
400 Bad Request 
{
  "message": "no label is supplied."
}
/dictionaries/{name}/prefix_completion
GET Get prefix completions, based on the specified dictionary

Parameters

Name Located in Description Type
term url prefix of a term String
page url the page of the results you want to access Integer
per_page url the number of items you want to get at once Integer

Responses

200 An ordered list of pairs of (label, id)
400 Wrong request
/dictionaries/{name}/substring_completion
GET Get substring completions, based on the specified dictionary

Parameters

Name Located in Description Type
term url substring of a term String
page url the page of the results you want to access Integer
per_page url the number of items you want to get at once Integer

Responses

200 An ordered list of pairs of (label, id)
400 Wrong request
/dictionaries/{name}/mixed_completion
GET Get prefix completions (top half) and substring completions (bottom half) at the same time, based on the specified dictionary

Parameters

Name Located in Description Type
term url substring of a term String
page url the page of the results you want to access Integer
per_page url the number of items you want to get at once Integer

Responses

200 An ordered list of pairs of (label, id)
400 Wrong request