BioGPS Plugin API

• BioGPS plugin API

  • List Methods
  • Expand Methods

  • GETBioGPS Plugin All/plugin/all/
    Get the metadata of all registered BioGPS plugins
    
    

    Parameter	Value	Type	Location	Description
    format	jsonxml	enumerated	query	json or xml
    sort	popularnewestid-id	enumerated	query	return sorted plugins based on various fields Default "popular" popular by popularity in descending order newest by plugin submission date in descending order id by plugin id in ascending order -id by plugin id in descending order
    limit		integer	query	the maximum number of plugins to return (by default 10)
    from		integer	query	from a given number of plugin to return, 0-based (by default 0).

  • GETBioGPS Plugins By Tag/plugin/tag/:tag/
    Get the metadata of all registered BioGPS plugins with a given tag
    
    

    Parameter	Value	Type	Location	Description
    tag		string	query	a valid tag, see http://biogps.org/plugin/tag/ for the list of tags
    format	jsonxml	enumerated	query	json or xml
    sort	popularnewestid-id	enumerated	query	return sorted plugins based on various fields Default "popular" popular by popularity in descending order newest by plugin submission date in descending order id by plugin id in ascending order -id by plugin id in descending order
    limit		integer	query	the maximum number of plugins to return (by default 10)
    from		integer	query	from a given number of plugin to return, 0-based (by default 0).

  • GETBioGPS Plugin/plugin/:plugin_id/
    Get the metadata of a registered BioGPS plugin by its ID
    
    

    Parameter	Value	Type	Location	Description
    plugin_id		integer	query	Plugin ID
    format	jsonxml	enumerated	query	json or xml

  • GETBioGPS Plugin URL/plugin/:plugin_id/renderurl/
    Get the "rendered" URL for a given plugin and a given gene
    
    

    Parameter	Value	Type	Location	Description
    plugin_id		integer	query	Plugin ID
    geneid		string	query	Entrez (e.g. "1017") or Ensembl(e.g. "ENSG00000123374") Gene ID
    redirect		boolean	query	if true, return a 302 redirect to the "rendered" URL