[English]

GPDB Web Service API マニュアル

1. GPDB Web Serviceとは？

GPDB Web Serviceでは、GPDBのデータを利用することができる様々なAPIを提供しています。

APIを利用することにより外部より簡単にGPDBのデータにアクセスできるので、どなたでもGPDB Web Serviceを利用したアプリケーションの開発が可能になります。

2. どのようなサービスを提供しているのか？

GPDB Web Serviceでは、REST/SOAP方式のAPIを提供しています。

各APIの詳細については後述のAPIマニュアルをご参照ください。

3. どうやって利用するのか？

GPDB Web Serviceでは、REST/SOAP方式のAPIを提供しています。

REST-APIを使用するには、HTTPコネクションを使用できる環境が必要になります。

またブラウザや、Perl、Javaのようなプログラミング言語が必要です。

APIマニュアルにはRESTのサンプルURLやSOAP-APIのサンプルプログラムも記載していますので、ご参照ください。

4. APIマニュアル

searchGpdbId
REST Operation	/search/query+gpdb_id[offset,[limit]][/type]
SOAP Operation	searchGpdbId
Description	GPDB_IDを完全一致で検索して、エントリ一覧を返す

SOAP

Operation	searchGpdbId
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string), type (xs:string), offset (xs:int), limit (xs:int)
Input Description	gpdb_id: 検索したいgpdb_id type: list or count offset: オフセット値 limit: 取得件数
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	searchGpdbId.java searchGpdbId.cgi searchGpdbId.php searchGpdbId.rb

REST

Operation	search
URI Convention	/search/query+gpdb_id[offset,[limit]][/type]
Input	query, type, offset, limit
Input Description	query: 検索したいGPDB_ID type: list or count offset: オフセット値 limit: 取得件数
Output	xml
Output Description	エントリの詳細情報一覧（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/ http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/1 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/GLP-00005e+gpdb_id/1,5/count

searchTaxId
REST Operation	/search/query+tax_id[offset,[limit]][/type]
SOAP Operation	searchTaxId
Description	TaxIDを完全一致で検索して、エントリ一覧を返す

SOAP

Operation	searchTaxId
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	tax_id (xs:string), type (xs:string), offset (xs:int), limit (xs:int)
Input Description	tax_id: 検索したいTAX_ID type: list or count offset: オフセット値 limit: 取得件数
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	searchTaxId.java searchTaxId.cgi searchTaxId.php searchTaxId.rb

REST

Operation	search
URI Convention	/search/query+tax_id[offset,[limit]][/type]
Input	query, type, offset, limit
Input Description	query: 検索したいTAX_ID type: list or count offset: オフセット値 limit: 取得件数
Output	xml
Output Description	エントリの詳細情報一覧（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/ http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/1 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/6239+tax_id/1,5/count

searchOrganism
REST Operation	/search/query+organism[offset,[limit]][/type]
SOAP Operation	searchOrganism
Description	Organism情報を検索して、エントリ一覧を返す

SOAP

Operation	searchOrganism
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	organism (xs:string), type (xs:string), offset (xs:int), limit (xs:int)
Input Description	organism: 検索したいOrganism type: list or count offset: オフセット値 limit: 取得件数
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	searchOrganism.java searchOrganism.cgi searchOrganism.php searchOrganism.rb

REST

Operation	search
URI Convention	/search/query+organism [/offset,[limit]][/type]
Input	query, type, offset, limit
Input Description	query: 検索したいOrganism type: list or count offset: オフセット値 limit: 取得件数
Output	xml
Output Description	エントリの詳細情報一覧（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/ http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/1 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/Caenorhabditis+organism/1,5/count

searchGlycoprotein
REST Operation	/search/query+glycoprotein[offset,[limit]][/type]
SOAP Operation	searchGlycoprotein
Description	ProteinName情報を検索して、エントリ一覧を返す

SOAP

Operation	searchGlycoprotein
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	glycoprotein (xs:string), type (xs:string), offset (xs:int), limit (xs:int)
Input Description	glycoprotein: 検索したいProteinName type: list or count offset: オフセット値 limit: 取得件数
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	searchGlycoprotein.java searchGlycoprotein.cgi searchGlycoprotein.php searchGlycoprotein.rb

REST

Operation	search
URI Convention	/search/query+glycoprotein[offset,[limit]][/type]
Input	query, type, offset, limit
Input Description	query: 検索したいProteinName type: list or count offset: オフセット値 limit: 取得件数
Output	xml
Output Description	エントリの詳細情報一覧（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/ http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/1 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/rig-4+glycoprotein/1,5/count

searchDbXref
REST Operation	/search/query+db_xref[offset,[limit]][/type]
SOAP Operation	searchDbXref
Description	DBのID情報を完全一致で検索して、エントリ一覧を返す

SOAP

Operation	searchDbXref
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	ID (xs:string), type (xs:string), offset (xs:int), limit (xs:int)
Input Description	PMID: 検索したいID type: list or count offset: オフセット値 limit: 取得件数
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	searchDbXref.java searchDbXref.cgi searchDbXref.php searchDbXref.rb

REST

Operation	search
URI Convention	/search/query+db_xref[offset,[limit]][/type]
Input	query, type, offset, limit
Input Description	query: 検索したいID type: list or count offset: オフセット値 limit: 取得件数
Output	xml
Output Description	エントリの詳細情報一覧（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/ http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/1 http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/search/UNP-00001c+db_xref/1,5/count

getXmlEntry
REST Operation	/entry/gpdb_id[.xml]
SOAP Operation	getXmlEntry
Description	GPDBエントリの詳細情報をXML形式で返す

SOAP

Operation	getXmlEntry
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（XML形式）
Sample Code	getXmlEntry.java getXmlEntry.cgi getXmlEntry.php getXmlEntry.rb

REST

Operation	entry
URI Convention	entry/gpdb_id[.xml]
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e.xml

gettxtEntry
REST Operation	/entry/gpdb_id.txt
SOAP Operation	gettxtEntry
Description	GPDBエントリの詳細情報をテキスト形式で返す

SOAP

Operation	getTextEntry
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（テキスト形式）
Sample Code	getTextEntry.java getTextEntry.cgi getTextEntry.php getTextEntry.rb

REST

Operation	entry
URI Convention	entry/gpdb_id.txt
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（テキスト形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e.txt

getDraftEntry
REST Operation	/entry/gpdb_id.he_draft
SOAP Operation	getDraftEntry
Description	GPDBエントリの詳細情報をドラフトテキスト形式で返す

SOAP

Operation	getDraftEntry
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（ドラフトテキスト形式）
Sample Code	getDraftEntry.java getDraftEntry.cgi getDraftEntry.php getDraftEntry.rb

REST

Operation	entry
URI Convention	entry/gpdb_id.he_draft
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（ドラフトテキスト形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e.he_draft

getFastaEntry
REST Operation	/entry/gpdb_id.fasta
SOAP Operation	getFastaEntry
Description	GPDBエントリの詳細情報をFASTA形式で返す

SOAP

Operation	getFastaEntry
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報一覧（FASTA形式）
Sample Code	getFastaEntry.java getFastaEntry.cgi getFastaEntry.php getFastaEntry.rb

REST

Operation	entry
URI Convention	entry/gpdb_id.fasta
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（FASTA形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e.fasta

getGlycoprotein
REST Operation	entry/gpdb_id/glycoprotein
SOAP Operation	getGlycoprotein
Description	任意のProteinNameとOrganism情報を返す

SOAP

Operation	getGlycoprotein
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報（XML形式）
Sample Code	getGlycoprotein.java getGlycoprotein.cgi getGlycoprotein.php getGlycoprotein.rb

REST

Operation	entry
URI Convention	entry/gpdb_id/glycoprotein
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e/glycoprotein

getDbXref
REST Operation	entry/gpdb_id/db_xref
SOAP Operation	getDbXref
Description	任意のDB関連情報を返す

SOAP

Operation	getDbXref
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報（XML形式）
Sample Code	getDbXref.java getDbXref.cgi getDbXref.php getDbXref.rb

REST

Operation	entry
URI Convention	entry/gpdb_id/db_xref
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e/db_xref

getGlycosylationSite
REST Operation	entry/gpdb_id/glycosylation_site
SOAP Operation	getGlycosylationSite
Description	任意のGlycosylation情報を返す

SOAP

Operation	getGlycosylationSite
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報（XML形式）
Sample Code	getGlycosylationSite.java getGlycosylationSite.cgi getGlycosylationSite.php getGlycosylationSite.rb

REST

Operation	entry
URI Convention	entry/gpdb_id/glycosylation_site
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e/glycosylation_site

getSequence
REST Operation	entry/gpdb_id/sequence
SOAP Operation	getSequence
Description	任意のSequence情報を返す

SOAP

Operation	getSequence
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	gpdb_id (xs:string)
Input Description	任意のgpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
WSDL Output	return (xs:string)
Output Description	エントリの詳細情報（XML形式）
Sample Code	getSequence.java getSequence.cgi getSequence.php getSequence.rb

REST

Operation	entry
URI Convention	entry/gpdb_id/sequence
Input	gpdb_id (カンマ区切りで複数エントリ取得可: GLP-00005E,GLP-000260,…)
Input Description	任意のgpdb_id
Output	xml
Output Description	エントリの詳細情報（XML形式）
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/entry/GLP-00005e/sequence

getIdList
REST Operation	getIdList[/type[.format]]
SOAP Operation	getIdList
Description	GPDB_IDとTax_IDとORGANISMの一覧を返す

SOAP

Operation	getIdList
WSDL	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/services/GPDB.wsdl
WSDL Input	type (xs:string), format (xs:string)
Input Description	type: list or count format: xml or txt
WSDL Output	return (xs:string)
Output Description	GPDB_IDとTax_IDとORGANISMの一覧
Sample Code	getIdList.java getIdList.cgi getIdList.php getIdList.rb

REST

Operation	getIdList
URI Convention	getIdList[/type[.format]]
Input	type, format
Input Description	type: list or count format: xml or txt
Output	xml
Output Description	GPDB_IDとTax_IDとORGANISMの一覧
Sample URI	http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/getIdList http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/getIdList/list http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/getIdList/list.txt http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/getIdList/count http://riodb.ibase.aist.go.jp/rcmg/ws/gpdb/getIdList/count.txt

5. 共通仕様

5.1. 処理時の結果が0件の場合

Search及びEntry処理時に結果が0件の場合、空エントリを返す。RESTは、ステータスが404になる。

5.2. 実行中エラーの処理

実行時にエラーが発生した場合、RESTは500ステータスを返し、エラー画面が表示される。

5.3. SOAP Fault

SOAPはSOAP Faultを返すが、エラーの処理については各クライアントに任せられる。

SOAP Input 正常時

SOAP Output 正常時

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <ns:getIdListResponse xmlns:ns="http://webservice.jcgpdb.jp">
   <ns:return>
    GLP-000013 …
    GLP-000014 …
    …
    GLP-00030a …
    GLP-00030b …
   </ns:return>
  </ns:getIdListResponse>
</soapenv:Body>
</soapenv:Envelope>

SOAP Input エラー時
※ Requestのパラメータが不足

<?xml version='1.0' encoding='utf-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:typens=http://webservice.jcgpdb.jp
        xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
        xmlns:xs="http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<soap:Body>
  <typens:getIdList>
   <format xsi:type="xsd:string">txt</format>
  </typens:getIdList>
</soap:Body>
</soap:Envelope>

SOAP Output エラー時
※ SOAP Faultを返す

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <soapenv:Fault>
   <faultcode>soapenv:Server</faultcode>
   <faultstring>
    Exception occurred while trying to invoke service method getIdList
   </faultstring>
   <detail />
  </soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>