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

APIを用いた高度な利用

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

ここでは、これらAPIの使い方について説明します。ドキュメントのメンテナンスの都合上、 食品メタボロームレポジトリ以外の姉妹レポジトリであっても、 使用例では、食品メタボロームレポジトリを使用していますので、ご了承ください。

機能一覧

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

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

画像を取得する機能

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

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

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

書式 /search/precursor /TARGET /MASS /MASS_TOLERANCE /MASS_TOLERANCE_UNIT /TYPE
/search/precursor /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/precursor /mz /611.1611 /5 /ppm /pos
/search/precursor /mzdi /307 /0.5 /da /both /13 /1
導入 バージョン1.3.0から
解説 設定条件にヒットしたピーク一覧および食品群ごとのサーマリーを表示します。 ピークを示すアイコンが溶出時間ごとに区分けされて出力されます。

マス値と溶出時間でピークを検索した結果を表示する(旧バージョン)

書式 /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
解説 設定条件にヒットしたピーク一覧および食品群ごとのサーマリーを表示します。 システムバージョン1.3より前で使用されていたもので、後方互換のために残してあります。 ヒットしたピークが溶出時間ごとに区分けされず、すべてひとつのセルの中に表示される仕様です。 溶出時間ごとに区分けして出力する新しいAPI(/serarch/precursor) の使用を推奨します。

マススペクトルによるピーク検索の結果を表示する

書式 /search/spectrum /SPECTRUM_STRING
/search/spectrum /SPECTRUM_STRING /MIN_SCORE /MAX_RESULT_NUM
変数 SPECTRUM_STRING: スペクトル情報を記載した文字列。一つのイオンについて、m/z値と強度をカンマ「,」で区切って表し、 複数のイオンをコロン「:」で区切ります。m/z値は検索時に整数マスに丸められます。

以下省略した場合は、デフォルト値が適用されます。
MIN_SCORE: ヒットスコア(コサイン相関係数)の最小値。0.8以上を指定できます。省略した場合、デフォルト値0.90が適用されます。
MAX_RESULT_NUM: 検索結果の最大数。100以下を指定できます。 省略した場合デフォルト値10が適用されます。
/search/spectrum /271.13,19406:229.05,12631:152.9,9846:225.12,6110:162.78,3851
/search/spectrum /271.13,19406:229.05,12631:152.9,9846:225.12,6110:162.78,3851 /0.8 /50
/search/spectrum /311.21,534873:357.23,450391:339.2,97498
/search/spectrum /311.21,534873:357.23,450391:339.2,97498 /0.8 /5
解説 与えたマススペクトルに類似したMS2またはMS3スペクトルを持つピークを検索し、結果をブラウザ上に表示します。

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

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

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

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

統計データを取得する

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

サンプル情報を取得する

書式 /api/samples
/api/samples
導入 バージョン1.3.0から
解説 サンプル一覧をJSON形式で返します。

サンプル情報を取得する(非推奨)

書式 /api/foods
/api/foods
状態 バージョン1.3.0以降非推奨
解説 サンプル一覧をJSON形式で返します。 後方互換のために残してありますが、本システムを食品以外のサンプルに適用するためにパス名を変更した こちらのAPIをご利用ください。

サンプル情報を取得する(公開データがあるもののみ)

書式 /api/samples/published
/api/samples/published
導入 バージョン1.3.0から
解説 公開データの存在するサンプル一覧をJSON形式で返します。

サンプル情報を取得する(公開データがあるもののみ)(非推奨)

書式 /api/foods/published
/api/foods/published
状態 バージョン1.3.0以降非推奨
解説 公開データの存在するサンプル一覧をJSON形式で返します。 後方互換のために残してありますが、本システムを食品以外のサンプルに適用するためにパス名を変更した こちらのAPIをご利用ください。

検出されたピークリストを取得する

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

ピークの詳細情報を取得する

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

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

書式 /api/msn /SAMPLE_NO /TYPE /PEAK_NO
変数 SAMPLE_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形式で返します。

マススペクトルで検索されるピークを取得する

書式 /api/search/spectrum /SPECTRUM_STRING
/api/search/spectrum /SPECTRUM_STRING /MIN_SCORE
変数 SPECTRUM_STRING: スペクトル情報を記載した文字列。一つのイオンについて、m/z値と強度をカンマ「,」で区切って表し、 複数のイオンをコロン「:」で区切ります。m/z値は検索時に整数マスに丸められます。

以下省略した場合は、デフォルト値が適用されます。
MIN_SCORE: ヒットスコア(コサイン相関係数)の最小値。0.5以上を指定できます。 省略した場合、デフォルト値0.9が適用されます。
/api/search/spectrum /271.13,19406:229.05,12631:152.9,9846:225.12,6110:162.78,3851
/api/search/spectrum /271.13,19406:229.05,12631:152.9,9846:225.12,6110:162.78,3851 /0.8
/api/search/spectrum /311.21,534873:357.23,450391:339.2,97498
/api/search/spectrum /311.21,534873:357.23,450391:339.2,97498 /0.8
解説 与えたマススペクトルに類似したMS2またはMS3スペクトルを持つピークを検索し、結果をJSON形式で返します。

特定のニュートラルロスを持つマススペクトルの数を取得する

書式 /api/search/nl/count /NL_MASS /MASS_TOLERANCE /NUM_TOP_IONS /MIN_INT_RATIO /TYPE /MS_LEVEL
変数 NL_MASS: ニュートラルロスの質量値
MASS_TOLERANCE: 質量値の許容誤差範囲(単位はDa)
NUM_TOP_IONS: 検索対象とするイオンの数。強度の強い順に対象とします
MIN_INT_RATIO: 検索対象とするイオンの最低強度。最強1位のイオンに対する割合を指定し、 強度2位以下のイオンがそれ以上の強度を持っている場合に検索対象になります。
TYPE: 検索対象とする検出モード。 pos, neg, both(両方検索)のいずれか
MS_LEVEL: 検索対象とするMSレベル。MS2: 2, MS3: 3, 全部: allのいずれか
/api/search/nl /132 /0.5 /1 /0.5 /pos /all
導入 バージョン1.3.0から
解説 特定のニュートラルロスを示すスペクトルを持つピークの数を検索し、結果をJSON形式で返します。 分析装置の質量精度に応じて質量誤差許容量を調節してください。 設定条件によって、スペクトル数が膨大になる場合があります。 実際にスペクトルを得るAPIを実施する前の判断材料にすることができます。

特定のニュートラルロスを持つマススペクトルを取得する

書式 /api/search/nl/spectra /NL_MASS /MASS_TOLERANCE /NUM_TOP_IONS /MIN_INT_RATIO /TYPE /MS_LEVEL /SAMPLE_NO
変数 NL_MASS: ニュートラルロスの質量値
MASS_TOLERANCE: 質量値の許容誤差範囲(単位はDa)
NUM_TOP_IONS: 検索対象とするイオンの数。強度の強い順に対象とします
MIN_INT_RATIO: 検索対象とするイオンの最低強度。最強1位のイオンに対する割合を指定し、 強度2位以下のイオンがそれ以上の強度を持っている場合に検索対象になります。
TYPE: 検索対象とする検出モード。 pos, neg, both(両方検索)のいずれか
MS_LEVEL: 検索対象とするMSレベル。MS2: 2, MS3: 3, 全部: allのいずれか
SAMPLE_NO: 検索対象とするサンプル番号
/api/search/nl/spectra /132 /0.5 /1 /0.5 /pos /all /01026
導入 バージョン1.3.0から
解説 特定のニュートラルロスを持つスペクトルを、指定した一つのサンプルから取得し、結果をJSON形式で返します。 スペクトル数が多くても全件がJSON形式で返りますので、ご使用の際はご注意ください。

ダウンロードできるマスクロマトグラムデータ(ZIPファイル)の一覧を取得する

書式 /api/dl-info-chrom /SAMPLE_NO
変数 SAMPLE_NO: サンプル番号
/api/dl-info-chrom /01026
導入 バージョン1.4.0から
解説 ZIP形式で提供されているマスクロマトグラムデータについて、mzXMLファイル、rawファイルのサイズ(MB)や ファイル名、MetabolonoteのM-IDの情報などがリストとして取得できます。 ファイルをダウンロードするAPIでは、サンプル番号とMetabolonoteM-IDでファイルを特定しますので、 このリストから情報を取得することで、全データの自動ダウンロードなどが可能となります。

ダウンロードできるピークデータのZIPファイルの情報を取得する

書式 /api/dl-info-peaks /SAMPLE_NO
変数 SAMPLE_NO: サンプル番号
/api/dl-info-peaks /01026
導入 バージョン1.4.0から
解説 ピークリスト、MSnデータ、使われたアダクトイオン種の情報を含むZIPファイルについて、 ファイル名とそのファイルサイズ(MB)を返します。

ZIPデータのファイルサイズを取得する(非推奨)

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

画像を取得する機能

サンプルを分析した2Dクロマトグラム画像を取得する

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

サンプルのイメージ画像を取得する

書式 /api/img/sample /SAMPLE_NO
変数 SAMPLE_NO: サンプル番号
/api/img/sample /01026
導入 バージョン1.3.0から
解説 サンプルのイメージ写真を取得します。イメージなので、実際に分析に使用した試料とは異なる場合があります。

サンプルのイメージ画像を取得する(非推奨)

書式 /api/img/food /SAMPLE_NO
変数 SAMPLE_NO: サンプル番号
/api/img/food /01026
状態 バージョン1.3.0以降非推奨
解説 サンプルのイメージ写真を取得します。イメージなので、実際に分析に使用した試料とは異なる場合があります。 後方互換のために残してありますが、本システムを食品以外のサンプルに適用するためにパス名を変更した こちらのAPIをご利用ください。

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

書式 /api/img/chrm-sample /SAMPLE_NO /MODE
変数 SAMPLE_NO: サンプル番号
MODE: pos, negのいずれか
/api/img/chrm-sample /01026 /pos
導入 バージョン1.3.0から
解説 分析したクロマトグラムの2次元表示画像(横軸:溶出時間、縦軸:m/z)の右上に、 サンプルのイメージ写真を付加した画像を取得します。 サンプルの写真はイメージなので、実際に分析に使用した試料とは異なる場合があります。

サンプルのイメージ写真がインサートされた2Dクロマトグラム画像を取得する(非推奨)

書式 /api/img/chrmfood /SAMPLE_NO /MODE
変数 SAMPLE_NO: サンプル番号
MODE: pos, negのいずれか
/api/img/chrmfood /01026 /pos
状態 バージョン1.3.0以降非推奨
解説 分析したクロマトグラムの2次元表示画像(横軸:溶出時間、縦軸:m/z)の右上に、 サンプルのイメージ写真を付加した画像を取得します。 サンプルの写真はイメージなので、実際に分析に使用した試料とは異なる場合があります。 後方互換のために残してありますが、本システムを食品以外のサンプルに適用するためにパス名を変更した こちらのAPIをご利用ください。

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

クロマトグラムデータ(raw形式)のZIPファイルのダウンロード

書式 /api/dl-raw /SAMPLE_NO /MN-ID
変数 SAMPLE_NO: サンプル番号
MN-ID: Metabolonote ID
/api/dl-raw /01026 /SE112_S010261_M01
導入 バージョン1.4.0から
解説 マスクロマトグラムデータ(raw形式)のZIPファイルをダウンロードします。 サンプル番号内の各データを特定する一意なMetabolonote IDや、ファイルサイズは、 別のAPIでリストとして取得可能です。

クロマトグラムデータ(mxXML形式)のZIPファイルのダウンロード

書式 /api/dl-mzxml /SAMPLE_NO /MN-ID
変数 SAMPLE_NO: サンプル番号
MN-ID: Metabolonote ID
/api/dl-mzxml /01026 /SE112_S010261_M01
導入 バージョン1.4.0から
解説 マスクロマトグラムデータ(mzXML形式)のZIPファイルをダウンロードします。 サンプル番号内の各データを特定する一意なMetabolonote IDや、ファイルサイズは、 別のAPIでリストとして取得可能です。

ピークデータのZIPファイルのダウンロード

書式 /api/dl-peaks /SAMPLE_NO
変数 SAMPLE_NO: サンプル番号
/api/dl-peaks /01026
導入 バージョン1.4.0から
解説 ピークデータのZIPファイルをダウンロードします。

ZIPデータのダウンロード(非推奨)

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