gene
For a list of gene ids, return the matching gene objects
/gene
Usage and SDK Samples
curl -X POST "https://api.apieco.ir/mygene/v3/gene?fields=&species=&dotfield=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnotationApi;
import java.io.File;
import java.util.*;
public class AnnotationApiExample {
public static void main(String[] args) {
AnnotationApi apiInstance = new AnnotationApi();
String apiecoKey = apiecoKey_example; // String |
Body body = ; // Body |
String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
try {
inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationApi#gene");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AnnotationApi;
public class AnnotationApiExample {
public static void main(String[] args) {
AnnotationApi apiInstance = new AnnotationApi();
String apiecoKey = apiecoKey_example; // String |
Body body = ; // Body |
String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
try {
inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationApi#gene");
e.printStackTrace();
}
}
}
String *apiecoKey = apiecoKey_example; //
Body *body = ; //
String *fields = fields_example; // a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
(optional)
String *species = species_example; // can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
(optional)
Boolean *dotfield = true; // control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
(optional)
String *email = email_example; // If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
(optional)
AnnotationApi *apiInstance = [[AnnotationApi alloc] init];
[apiInstance geneWith:apiecoKey
body:body
fields:fields
species:species
dotfield:dotfield
email:email
completionHandler: ^(inline_response_200 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var MyGeneinfoApi = require('my_geneinfo_api');
var api = new MyGeneinfoApi.AnnotationApi()
var apiecoKey = apiecoKey_example; // {String}
var body = ; // {Body}
var opts = {
'fields': fields_example, // {String} a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
'species': species_example, // {String} can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
'dotfield': true, // {Boolean} control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
'email': email_example // {String} If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.gene(apiecoKey, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class geneExample
{
public void main()
{
var apiInstance = new AnnotationApi();
var apiecoKey = apiecoKey_example; // String |
var body = new Body(); // Body |
var fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
(optional)
var species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
(optional)
var dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
(optional)
var email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
(optional)
try
{
inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AnnotationApi.gene: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\AnnotationApi();
$apiecoKey = apiecoKey_example; // String |
$body = ; // Body |
$fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
$species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
$dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
$email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
try {
$result = $api_instance->gene($apiecoKey, $body, $fields, $species, $dotfield, $email);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnnotationApi->gene: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnotationApi;
my $api_instance = WWW::SwaggerClient::AnnotationApi->new();
my $apiecoKey = apiecoKey_example; # String |
my $body = WWW::SwaggerClient::Object::Body->new(); # Body |
my $fields = fields_example; # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
my $species = species_example; # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
my $dotfield = true; # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
my $email = email_example; # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
eval {
my $result = $api_instance->gene(apiecoKey => $apiecoKey, body => $body, fields => $fields, species => $species, dotfield => $dotfield, email => $email);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AnnotationApi->gene: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AnnotationApi()
apiecoKey = apiecoKey_example # String |
body = # Body |
fields = fields_example # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
(optional)
species = species_example # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
(optional)
dotfield = true # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
(optional)
email = email_example # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
(optional)
try:
api_response = api_instance.gene(apiecoKey, body, fields=fields, species=species, dotfield=dotfield, email=email)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnnotationApi->gene: %s\n" % e)
Parameters
Header parameters
Name | Description |
---|---|
apieco-key* |
String
Required
|
Body parameters
Name | Description |
---|---|
body * |
Query parameters
Name | Description |
---|---|
fields |
String
a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
|
species |
String
can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
|
dotfield |
Boolean
control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
|
String
If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
|