The purpose of this document is to define a set of straightforward REST (REpresentational State Transfer) services to commonly required information based on the data in g2pDB, a collection of post-translational modification acceptor site mappings to the human genome. These services will provide simple, non-SQL methods to extract this information and make it available over the Internet to anyone wishing to use it as part of a network-aware application.
Contents |
The following statements refer to all methods and description given below:
Interface services give the programmer access to information about the current state of the REST interface.
input: none return: [ARRAY - "string"] a text description of the current REST interface
Example: find help information through the interface
http://rest.thegpm.org/2/interface/help
input: none return: [ARRAY - "string"] the version number of the REST interface
Example: find the current REST interface version number
http://rest.thegpm.org/2/interface/version
Dna services give access to PTM-linked information about particular genomic locations.
input: CHR = human chromosome 1-22, MT, X, or Y), POS = base position on chromosome return: ARRAY of objects containing text description of all modification linked to the specified base
Example: list PTM information linked to base 8925354 on Chromosome 1
input: CHR = human chromosome 1-22, MT, X, or Y), POS = base position on chromosome, MOD = modification return: ARRAY of objects containing text description of the specified modification linked to the specified base
Example: list acetylation modification information linked to base 8925354 on Chromosome 1
http://rest.thegpm.org/2/g2pd/grch37/ensembl_70b/dna/1/8925354/mod=Acetyl
input: CHR = human chromosome 1-22, MT, X, or Y), POS = base position on chromosome, BASE = variant base return: ARRAY of objects containing text description of modifications changed by the variant BASE
Example: list modification changes caused by the variant base A at position 8925354 on Chromosome 1 (no change)
http://rest.thegpm.org/2/g2pdb/grch37/ensembl_70/dna/1/8030998/snp=A
Example: list modification changes caused by the variant base C at position 8925354 on Chromosome 1 (removes modification)
http://rest.thegpm.org/2/g2pdb/grch37/ensembl_70/dna/1/8030998/snp=C
Peptide services access to all of the genomic mapping information associated with PTMs for a particular protein.
input: ACC = ENSEMBL protein accession number return: ARRAY of PTM mapping information objects
Example: retrieve the PTM mappings for ENSP00000234590
http://rest.thegpm.org/2/g2pdb/grch37/ensembl_70/protein/ENSP00000234590.
input: ACC = ENSEMBL protein accession number, MOD = modification return: ARRAY of PTM mapping information objects for MOD only
Example: retrieve the ubiquitinylation mappings for ENSP00000234590
http://rest.thegpm.org/2/grch37/ensembl_70/g2pdb/protein/ENSP00000234590/mod=GlyGly.
These services are being implemented in PERL, the language that is used to provide most of the web page creation logic for the GPMDB system. The code is available at ftp://ftp.thegpm.org/repos/g2p_rest. The files currently available are as follows:
Any one interested in making suggestions or commenting on the ideas in this document should send them by email to Ron Beavis, rbeavis@thegpm.org.
| Reference name | Revision date | Document status | Stable URL |
|---|---|---|---|
| GPM-2014.11.27 | 2014.11.27 | draft specification | http://wiki.thegpm.org/wiki/G2PDB_REST |