Linking to FlyMine

You can link to FlyMine in multiple ways:

  • Via URL of the form http://www.flymine.org/query/portal.do?PARAMETERS
  • With a POST request, which should be used instead of long URLs:
    <form action="http://www.flymine.org/query/portal.do" name="list" method="post">
    
    <input type="hidden" name="externalids" value="zen,eve"/>
    
    <input type="hidden" name="class" value="Gene"/>
    
    <input type="submit" value="Submit"/>
    
</form>
    To submit the form you can either use a submit button or javascript document.myform.submit() on any link.

NOTE: In all the examples below the URL can be replaced by a POST.

List of parameters:

  • externalid* (or externalids): the identifier or list of identifiers separated by ",". identifiers can be CG numbers, FBGNs or symbols.
  • class*: class of the data to load, i.e. Gene, Protein and it is important to respect the font case. For a list of data types please refer to the list of data types on the QueryBuilder page
  • origin: allow us to show a specific welcome/help message to incoming users from your site. It also helps us keep track of incoming links. Let us know what you want to use.
  • organism: this is useful when linking with symbols that are used across organisms. The organism name must be the shortName as defined in FlyMine, for instance D. melanogaster
  • orthologue: shortName of the organism to get the orthologues from
(*mandatory field)

You can find some logos to link to FlyMine here.



Examples

Links to report pages

Links can be set up directly to the report pages of many types of entry in FlyMine. A link isn't to a specific page but runs a search for the given identifier. This searches all identifiers, symbols and synonyms in FlyMine and will bring up either a report page or a list of possibilities. This is exactly the same as running a Quick Search from the FlyMine home page.

The URL to use takes the form:

www.flymine.org/query/portal.do?externalid=identifier&class=identifierClass&origin=MySite

Note that using www.flymine.org/query will always redirect to the latest FlyMine release, please don't create links to the URL of a particular release.

The origin in the URL is optional but will allow us to show a specific welcome/help message to incoming users from your site. It also helps us keep track of incoming links. Let us know what you want to use.

As an option, you can specify an organism name by using organism in the URL, this is useful when linking with symbols that are used across organisms. The organism name must be the shortName as defined in FlyMine, for instance D.%20melanogaster.

A typical URL to link to a gene report page: http://www.flymine.org/query/portal.do?externalid=FBgn0004053&class=Gene&origin=flybase

Some other examples:

If you would like to link to a particular type of entry and have suggestions for additional templates you would like to see there please let us know, this is easy to configure.

Links to List Analysis pages

It is possible to link directly to a list analysis page by providing a list of identifiers in the URL. FlyMine will then search for the corresponding entries and create a FlyMine List with them. It is mandatory to specify the class of the data to load, i.e. Gene, Protein and it is important to respect the font case. For a list of data types please refer to the list of data types on the QueryBuilder page.

The URL to use takes the form:

www.flymine.org/query/portal.do?externalids=identifier1,identifier2,identifier3&class=ClassName&origin=MySite

The origin in the URL is optional but will allow us to show a specific welcome/help message to incoming users from your site. It also helps us keep track of incoming links. Let us know what you want to use.

As an option, you can specify an organism name by using organism in the URL. The organism name must be the shortName as defined in FlyMine, for instance D. melanogaster.

A typical URL to link to a gene report page: http://www.flymine.org/query/portal.do?externalids=CG2262,CG3069,CG2859,CG5041,FBgn0036513&class=Gene&origin=flyexpress

Converting data types

When linking to a report page or a list analysis page you can convert the data type, for instance if you provide a Protein identifier and want to link to the corresponding Gene, you need to specify the class as Gene.

The URL to use takes the form:

www.flymine.org/query/portal.do?externalid=proteinId&class=Gene

Examples:

Links to data categories

Links directly to data category pages in the latest release take the form:

www.flymine.org/query/aspect.do?name=aspect+name

Where aspect+name is the name of the aspect as shown on the FlyMine home page - match case and replace any spaces with '+'.

For example:


Linking to Orthologues

Linking with a gene identifier from an organism and getting the corresponding orthologue from another organism can be done as follow:

http://www.flymine.org/query/portal.do?externalids=organism1_geneid1,organism1_geneid2,organism1_geneid3&class=Gene&orthologue=organism2_shortName

For example: