ヘルプ - APIによる高度な利用

APIを用いた高度な利用

食品メタボロームレポジトリは、外部プログラムからデータベースを利用するためのAPI(Application Programming Interface)を豊富に提供しており、 特定の書式のURLにアクセスすることで、情報をブラウザに表示したり、データをJSON形式(テキスト)で取得したり、 データファイルをダウンロードしたりなどができます。 特にJSON形式でのデータ取得は、外部プログラムに検索機能を組み込んだり、大量の検索を自動的に行ったりするのに役立ちます。

結果をブラウザ上に表示する機能

マス値と溶出時間で食品中のピークを検索した結果を表示する

書式 /search/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE
/search/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE/RT/RT_TOLERANCE
変数 TARGET: mz, 検出m/z値; mzdi, アダクトから推定された元の中性分子の質量値のいずれか
MASS: 質量値
MASS_TOLERANCE: 許容質量誤差範囲。設定できる最大の誤差範囲は10 Daまでです。
MASS_TOLERANCE_UNIT: 許容質量誤差範囲の単位。ppm, daのいずれか
TYPE: 検索する検出モード。pos, neg, both (両方検索) のいずれか
以下省略した場合は、溶出時間を制限しない検索
RT: 溶出時間
RT_TOLERANCE: 許容溶出時間範囲(単位は分)
/search/mz/611.1611/5/ppm/pos
/search/mzdi/307/0.5/da/both/13/1
解説 設定条件にヒットしたピーク一覧および食品群ごとのサーマリーを表示します。

ピークの詳細情報を表示する

書式 /peak/FOOD_NO/TYPE/PEAK_NO
変数 FOOD_NO: 食品番号
TYPE: 検出モード。pos, neg のいずれか
PEAK_NO: ピーク番号
/peak/01026/pos/8603
解説 指定した食品番号、検出モード、ピーク番号のピーク詳細情報を表示します。

結果をJSON形式で取得する機能

JSONオブジェクトの構造は、例で得られるサンプルでご確認ください。

統計データの取得

書式 /api/stat
/api/stat
解説 登録されているサンプル数、ピーク数などをJSON形式で返します。接頭辞のnumは個数(int)、ratioは割合(float)を示します。

食品情報を取得

書式 /api/foods
/api/foods
解説 食品一覧をJSON形式で返します。

食品情報を取得(公開データがあるもののみ)

書式 /api/foods/published
/api/foods/published
解説 公開データの存在する食品一覧をJSON形式で返します。

食品で検出されたピークリストを取得

書式 /api/peaklist/FOOD_NO/TYPE
変数 FOOD_NO: 食品番号
TYPE: 検索する検出モード。pos, neg のいずれか
/api/peaklist/01026/pos
解説 指定した食品番号および検出モードで検出されたピークの一覧をJSON形式で返します。

ピーク情報を取得

書式 /api/peak/FOOD_NO/TYPE/PEAK_NO
変数 FOOD_NO: 食品番号
TYPE: 検索する検出モード。pos, neg のいずれか
PEAK_NO: ピーク番号
/api/peak/04032/pos/6461
/api/peak/06182/pos/4041
解説 指定した食品番号、検出モード、およびピーク番号のピーク情報をJSON形式で返します。

ピークのMSスペクトル情報を取得

書式 /api/msn/FOOD_NO/TYPE/PEAK_NO
変数 FOOD_NO: 食品番号
TYPE: 検索する検出モード。pos, neg のいずれか
PEAK_NO: ピーク番号
/api/msn/04032/pos/6461
解説 指定した食品番号、検出モード、およびピーク番号のMSnスペクトル情報をJSON形式で返します。

マス値と溶出時間で検索される食品中のピークを取得

書式 /api/search/peaks/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE
/api/search/peaks/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE/RT/RT_TOLERANCE
変数 TARGET: mz, 検出m/z値; mzdi, アダクトから推定された元の中性分子の質量値のいずれか
MASS: 質量値
MASS_TOLERANCE: 許容質量誤差範囲。設定できる最大の誤差範囲は10 Daまでです。
MASS_TOLERANCE_UNIT: 許容質量誤差範囲の単位。ppm, daのいずれか
TYPE: 検索する検出モード。pos, neg, both (両方検索) のいずれか
以下省略した場合は、溶出時間を制限しない検索
RT: 溶出時間
RT_TOLERANCE: 許容溶出時間範囲(単位は分)
/api/search/peaks/mz/611.1611/5/ppm/pos
/api/search/peaks/mzdi/307/0.5/da/both/13/1
解説 設定条件にヒットしたピーク情報をJSON形式で返します。

マス値と溶出時間で検索される食品中のピークの食品群ごとの集計結果を取得

書式 /api/search/summary/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE
/api/search/summary/TARGET/MASS/MASS_TOLERANCE/MASS_TOLERANCE_UNIT/TYPE/RT/RT_TOLERANCE
変数 TARGET: mz, 検出m/z値; mzdi, アダクトから推定された元の中性分子の質量値のいずれか
MASS: 質量値
MASS_TOLERANCE: 許容質量誤差範囲。設定できる最大の誤差範囲は10 Daまでです。
MASS_TOLERANCE_UNIT: 許容質量誤差範囲の単位。ppm, daのいずれか
TYPE: 検索する検出モード。pos, neg, both (両方検索) のいずれか
以下省略した場合は、溶出時間を制限しない検索
RT: 溶出時間
RT_TOLERANCE: 許容溶出時間範囲(単位は分)
/api/search/summary/mz/611.1611/5/ppm/pos
/api/search/summary/mzdi/307/0.5/da/both/13/1
解説 各食品群について、公開されている食品数のうち、いくつの食品で、設定条件でピークがヒットしたかをJSON形式で返します。

ZIPデータのファイルサイズを取得

書式 /api/dlsize/FILE_TYPE/FOOD_NO/MODE
変数 FILE_TYPE: raw, mzXML, peakのいずれか
FOOD_NO: 食品番号
MODE: pos, negのいずれか
/api/dlsize/peak/01026/pos
解説 ZIP形式で提供されているデータのファイル名とファイルサイズを取得します。ファイルサイズの単位はMBです。ダウンロードはされません。 食品番号で指定した食品について、 ポジティブ、ネガティブのモード(MODE)ごとの、 分析生データ(raw)、マスクロマトグラムをmzXML形式に抽出したデータ(mzXML)、 ピークを抽出したデータ(peak)のZIP形式ダウンロードファイルのサイズを取得します。

画像を取得する機能

食品を分析した2Dクロマトグラム画像を取得する

書式 /api/img/chrm/FOOD_NO/MODE
変数 FOOD_NO: 食品番号
MODE: pos, negのいずれか
/api/img/chrm/01026/pos
解説 食品を分析したクロマトグラムの2次元表示画像(横軸:溶出時間、縦軸:m/z)を取得します。

食品のイメージ画像を取得する

書式 /api/img/food/FOOD_NO
変数 FOOD_NO: 食品番号
/api/img/food/01026
解説 食品のイメージ写真を取得します。イメージなので、実際に分析に使用した試料とは異なる場合があります。 画像の一部は、下記サイトのものを使用させていただきました。厚く御礼申し上げます。
写真AC |  花盛りの森 |  フード・フォト |  フォトック |  写真素材足成 |  無料画像

食品のイメージ写真がインサートされた2Dクロマトグラム画像を取得する

書式 /api/img/chrmfood/FOOD_NO/MODE
変数 FOOD_NO: 食品番号
MODE: pos, negのいずれか
/api/img/chrmfood/01026/pos
解説 分析したクロマトグラムの2次元表示画像(横軸:溶出時間、縦軸:m/z)の右上に、食品のイメージ写真を付加した画像を取得します。 食品の写真はイメージなので、実際に分析に使用した試料とは異なる場合があります。 食品画像の一部は、下記サイトのものを使用させていただきました。厚く御礼申し上げます。
写真AC |  花盛りの森 |  フード・フォト |  フォトック |  写真素材足成 |  無料画像

データをダウンロードする機能

ZIPデータのダウンロード

書式 /api/dl/FILE_TYPE/FOOD_NO/MODE
変数 FILE_TYPE: raw, mzXML, peakのいずれか
FOOD_NO: 食品番号
MODE: pos, negのいずれか
/api/dl/peak/01026/pos
解説 ZIP形式で提供されているデータをダウンロードします。食品番号で指定した食品について、 ポジティブ、ネガティブのモード(MODE)ごとの、 分析生データ(raw)、マスクロマトグラムをmzXML形式に抽出したデータ(mzXML)、 ピークを抽出したデータ(peak)をダウンロードします。