SABIO-RK RESTful Web Services Manual

API methods

  1. check API status
  3. get a single kinetic law entry by ID
  5. get kinetic law entries by IDs
  7. get fields available for use in query strings for searching
  9. search for kinetic law entries (sbml)
  11. search for kinetic law entries and return a list of the entry IDs
  13. search for kinetic law entries (bioPAX)
  15. search for kinetic law entries and return the only the number of entries found
  17. search for SabioReactionIDs
  19. get fields available for suggestion lists
  21. get suggestion list for the supplied field and term
  23. get number of suggestions for the supplied field and term

Error codes and their meaning

HTTP Response CodeDescription
200OK. The request to the web service completed successfully.
400Bad request. The parameters passed to the API endpoint were invalid.
404Not found. The resource corresponding to the supplied parameters does not exist.
500 Service unavailable. An internal problem prevented us from fulfilling your request.

SABIO REST api methods

Methods returning models of entries

Description: Get a single kinetic law entry by SABIO entry ID
Input: N.A.
Output: SBML model
Example URL: http://sabiork.h-its.org/sabioRestWebServices/kineticLaws/123
Optional Parameters:

  1. level - SBML level, default value:3
  2. version - SBML version, default value:1
  3. normalized - Export parameters with normalized units, default:true

Description: Get kinetic law entries by SABIO entry IDs
Input: list of SABIO entry IDs
Output: SBML model
Example URL: http://sabiork.h-its.org/sabioRestWebServices/kineticLaws?kinlawids=123,234
Optional Parameters:

  1. level - SBML level, default value:3
  2. version - SBML version, default value:1
  3. normalized - Export parameters with normalized units, default:true

Description: Search for kinetic law entries by SABIO entry by a query string
Input: query string, see Search Keyword Vocabularyfor how to form a query
Output: SBML model
Example URL: http://sabiork.h-its.org/sabioRestWebServices/searchKineticLaws/sbml?q=Tissue:liver AND Organism:Homo sapiens
Optional Parameters:

  1. level - SBML level, default:3
  2. version - SBML version, default:1
  3. normalized - Export parameters with normalized units, default:true

Description: Search for kinetic law entries by SABIO entry by a query string
Input: query string, see Search Keyword Vocabularyfor how to form a query
Output: BioPAX model
Example URL: http://sabiork.h-its.org/sabioRestWebServices/biopax?q=Tissue:liver AND Organism:Homo sapiens

Description: Search for kinetic law entries by SABIO entry by a query string, return only the number of the matching entries
Input: query string, see Search Keyword Vocabularyfor how to form a query
Output: XML or plain text
Example URL: http://sabiork.h-its.org/sabioRestWebServices/count?q=Tissue:liver AND Organism:Homo sapiens
Optional Parameters:

  1. format - format for export "xml" or "txt", default:xml

Methods returning other information

Description: Check status of API
Input: N/A
Output: "UP" if REST web services are available
Example URL: http://sabiork.h-its.org/sabioRestWebServices/status

Description: get list of available fields for querying
Input: N/A
Output: XML list of available fields
Example URL: http://sabiork.h-its.org/sabioRestWebServices/searchKineticLaws
Optional Parameters:

  1. format - format for export "xml" or "txt", defautl value:xml

Description: Search for SabioReactionIDs
Input: query string, options the same as for kinetic law entry search
Output: XML or plain text list of all SabioReactionIDs which have entries matching search criteria
Example URL (New style query): http://sabiork.h-its.org/sabioRestWebServices/reactions/reactionIDs?q=q=KeggReactionID:R00278
Optional Parameters:

  1. format - format for export "xml" or "txt", default:xml

Description: get suggestions fields
Input: N.A.
Output: XML containing the list of all valid field names available for getting suggestions
Example URL (uniprotIDs, all results): http://sabiork.h-its.org/sabioRestWebServices/suggestions

Description: get suggestions
Input: field name and term to search for. No query string supplied results in results for the field being returned (eg, all uniprotIDs used in SABIO entries)
Output: XML or plain text
Example URL (uniprotIDs, all results): http://sabiork.h-its.org/sabioRestWebServices/suggestions/uniprotIDs
Example URL (pathways, search with partial string): http://sabiork.h-its.org/sabioRestWebServices/suggestions/pathways?searchPathways=glyc
Optional Parameters:

  1. format - format for export "xml" or "txt", default:xml

Description: get the number of matching suggestions
Input: field name and term to search for. No query string supplied results in results for the field being returned (eg, all uniprotIDs used in SABIO entries)
Output: XML or plain text
Example URL (uniprotIDs, all results): http://sabiork.h-its.org/sabioRestWebServices/suggestions/uniprotIDs/count
Example URL (pathways, search with partial string): http://sabiork.h-its.org/sabioRestWebServices/suggestions/pathways/count?searchPathways=glyc