新getentry (Web API) について (2012/2/15 よりご利用いただけます)

新getentry (Web API) について

新getentry はweb API 機能を利用しています。これまでの getentry web application に近い機能は,新ARSA で利用することが可能ですが,この webAPI を利用したほうが便利と思われます。

 

新getentry で提供されるプログラムと URL

新getentry の web API は以下の2つのプログラムからなります。

getentry アクセッション番号(データベース中のエントリの ID)を与えると,データを返します。
gethistory
(この機能は新設)
アクセッション番号(データベース中のエントリの ID)を与えると,データの変更履歴を返します。

新 getentry では,以下の URL で3つの webAPI を提供します。

DDBJ塩基配列データベース http://getentry.ddbj.nig.ac.jp/getentry/ddbj/
特許由来アミノ酸配列 http://getentry.ddbj.nig.ac.jp/getentry/patent_aa/
DDBJ塩基配列データベースの更新履歴 http://getentry.ddbj.nig.ac.jp/gethistory/ddbj/

*特許由来アミノ酸配列の更新履歴は今のところとっておりません。

パラメータの指定方法

以下の2種類があります。

通常のGET method http://getentry.ddbj.nig.ac.jp/getentry?database=データベース名&accession_number=アクセッション番号&追加のパラメーター(任意)
smart URL http://getentry.ddbj.nig.ac.jp/getentry/データベース名/アクセッション番号

http://getentry.ddbj.nig.ac.jp/getentry/データベース名/アクセッション番号/?追加のパラメーター(任意)

(例)

http://getentry.ddbj.nig.ac.jp/getentry/ddbj/FW383979

http://getentry.ddbj.nig.ac.jp/getentry/patent_aa/BD500001 (特許由来アミノ酸配列の例)

指定可能なパラメータについて

getentry


accession 番号(必須):検索対象のAccession番号を指定します。

バージョン番号 ついていない場合は,最新バージョンを検索します。
ついている場合は,指定のバージョンを検索します。
複数Accession番号 ","区切りで複数のAccession番号を指定できます。
","区切りで複数指定された場合,指定の順で出力されます。
二つのAccession番号"-"で連結することにより範囲検索ができます。
範囲指定や複数指定ではバージョン番号を指定しても無視されます。
範囲指定 範囲指定の両端のAccession番号は前方のみの不完全でも構いません。
範囲指定も","区切りで複数指定できます。
範囲指定や複数指定ではバージョン番号を指定しても無視されます。
対象のAccession番号が存在しない,または表示できない場合,該当のAccession番号に対する結果は何も表示されず,limitで上限が制限されているときの数にもカウントされません。
デフォルトでの表示件数が10件に設定されているため,それ以上の件数を指定する場合には "limit" で設定を解除してください


database(任意): 検索対象のデータベースを指定します。

指定なし ddbj
DNA系 ddbj, wgs, tpa, mga
Protein系 uniprot, dad, patent, pdb
ddbj(デフォルト)を指定すると,tpaのエントリも取得対象となります。


revision(任意): 指定されたrevision時点を検索します。

通常 yyyy-MM-dd hh:mm:ss
リリース時 yyyy-MM-dd hh:mm:ss release
バージョン番号とrevisionが同時に指定されているとき,revisionが優先さます。


format(任意): 結果の出力フォーマットを指定します。

指定なし flatfile
flatfile 平文で出力します
xml XML形式に変換して出力します
fasta [DNA系]全塩基配列 FASTA
[Protein系]アミノ酸配列 FASTA
trans [DNA系]CDS アミノ酸 FASTA
cds [DNA系]CDS 塩基配列 FASTA
[DAD限定]塩基配列 FASTA(for DAD)


filetype(任意): 出力のファイルタイプを指定します。

指定なし text
html HTMLファイル
text テキストファイル
gz gz圧縮ファイル
gz圧縮ファイルのファイル名はformatの指定値によって以下のようになります。
[DNA系]flatfile flatfile.txt.gz
[DNA系]xml insd.xml.gz
[DNA系]fasta fasta_na.txt.gz
[DNA系]trans cds_aa.txt.gz
[DNA系]cds cds_na.txt.gz
[Protein系]flatfile flatfile.txt.gz
[Protein系]fasta fasta_aa.txt.gz
[Protein系]cds cds_na.txt.gz


show_suppressed (任意): suppressまたはremovedのデータを表示します。

limit(任意): データの取得上限を設定します。

指定なし 10件
0以下の数字を指定 無制限

 

 

gethistory


accession 番号(必須):検索対象のAccession番号を指定します。

指定方法は getentry と同じです


database(任意): 検索対象のデータベースを指定します。

指定方法は getentry と同じです。指定したデータベースが履歴管理に対応していない場合は,空の結果を返します。


type(必須):表示する履歴のタイプを指定します。

revision 「通常」の履歴情報
state 「詳細表示」
指定なし "state" になります

 

 

DDBJ エントリへのリンク設定方法

DDBJ の個々のエントリに対して,以下の方法でリンクを設定することができます。

http://getentry.ddbj.nig.ac.jp/getentry?database=データベース名&accession_number=アクセッション番号&追加のパラメーター(任意)
http://getentry.ddbj.nig.ac.jp/getentry/データベース名/アクセッション番号
http://getentry.ddbj.nig.ac.jp/getentry/データベース名/アクセッション番号/?追加のパラメーター(任意)

例えば,アクセッション番号が AB000001 であるエントリに対する URL は

http://getentry.ddbj.nig.ac.jp/getentry/ddbj/AB000001

アクセッション番号が BD500001 である特許由来アミノ酸配列のエントリに対する URL は,

http://getentry.ddbj.nig.ac.jp/getentry/patent_aa/BD500001

です。これを指定すると,該当のエントリが表示されます。試しに次のアクセッション番号をクリックしてみて下さい。

 
DRA へのリンク設定方法は,上記の方法とは異なりますので,DRA のホームページをご参照ください。

ご自身のホームページを作成される場合に,この URL をご活用下さい。

ページの先頭へ戻る