REST APIの仕様

• 現在利用できる BENTEN REST API用のサーバの URL は以下を参照ください。

  用途		agent-url
  SPring-8		https://benten-agent01.spring8.or.jp:5000

• 基本的に REST APIの返答は JSON形式で受け取ります。(一部のダウンロード用APIを除く)

  • エラーが発生時は、JSON返答にエラー情報を付加します。エラーの仕様については以下を参照ください。
    • BENTEN REST APIのエラー応答について

• BENTEN REST API仕様

  • 以下の表を参照ください。RAMLで作成したREST APIドキュメントを参照しています。

Endpoint	HTTP method	認証	返答	用途
[agent-url]/benten/v1/auth/login	POST	無	JSON	ログイン
[agent-url]/benten/v1/auth/logout	POST	有	JSON	ログアウト
[agent-url]/benten/v1/auth/refresh_token	POST	有	JSON	リフレッシュトークン
[agent-url]/benten/v1/auth/userinfo	POST	有	JSON	ユーザー属性取得
[agent-url]/benten/v1/data/directories	POST	有	JSON	ディレクトリ検索
[agent-url]/benten/v1/data/files	POST	有	JSON	ファイル検索
[agent-url]/benten/v1/data/register_names	POST	有	JSON	登録名の検索
[agent-url]/benten/v1/data/metadata	POST	有	JSON	メタデータ取得
[agent-url]/benten/v1/metadata/mappings	POST	有	JSON	メタデータマッピング情報取得
[agent-url]/benten/v1/metadata/keys	POST	有	JSON	メタデータキーリストの情報取得
[agent-url]/benten/v1/proposal	POST	有	JSON	課題番号情報取得
[agent-url]/benten/v1/proposal/metadata	POST	有	JSON	課題番号に属するメタデータ取得
[agent-url]/benten/v1/download	POST	有	JSON	ZIPダウンロード命令実行 (非同期処理)
[agent-url]/benten/v1/queue/{uuid}	POST	無	JSON	ZIPダウンロード命令のqueue確認
[agent-url]/benten/v1/download/file/{uuid}	GET	有	HTTP	ZIPダウンロードファイルダウンロード実行
[agent-url]/benten/v1/download/file	POST	有	HTTP	単一ファイルダウンロード実行
[agent-url]/benten/v1/register/metadata	POST	有	JSON	メタデータ登録、およびアップロードされたファイルの登録
[agent-url]/benten/v1/register/files	POST	有	JSON	ファイルアップロード
[agent-url]/benten/v1/register/reset	POST	有	JSON	アップロードされたファイルのリセット
[agent-url]/benten/v1/delete	POST	有	JSON	データ消去