Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 2.25 KB

03_api_reference.md

File metadata and controls

81 lines (60 loc) · 2.25 KB

API リファレンス

概要

LabCodeが提供するREST APIの一覧です。

  • Base URL: http://localhost:8000
  • Swagger UI: http://localhost:8000/docs

ユーザー管理 API

Method Path 説明
GET /users/list 全ユーザー一覧取得
GET /users/{id}/projects ユーザーのプロジェクト一覧
POST /users ユーザー作成
DELETE /users/{id} ユーザー削除

プロジェクト管理 API

Method Path 説明
GET /projects/list 全プロジェクト一覧取得
GET /projects/{id} プロジェクト詳細取得
POST /projects プロジェクト作成
PUT /projects/{id} プロジェクト更新
DELETE /projects/{id} プロジェクト削除

Run API

Method Path 説明
GET /runs Run一覧取得
GET /runs/{id} Run詳細取得
PATCH /runs/{id}/visibility 表示/非表示切り替え

ストレージ API

Method Path 説明
GET /v2/storage/info/{run_id} Runのストレージ情報取得
GET /v2/storage/list/{run_id} Runのファイル一覧取得
GET /v2/storage/download/{run_id} ファイルダウンロード
POST /v2/storage/download-batch/{run_id} 一括ダウンロード

実験実行 API

実験実行はシミュレータAPI経由で行います。

Method Path 説明
POST /sim_api/run 実験実行

実験実行リクエスト

  • Content-Type: multipart/form-data
  • パラメータ:
    • protocol_file: protocol.yaml ファイル（必須）
    • manipulate_file: manipulate.yaml ファイル（任意）
    • user_email: 実行ユーザーのメールアドレス
    • project_id: プロジェクトID
    • protocol_name: プロトコル名

HTTPステータスコード

コード 説明
200 成功
201 作成成功
400 リクエスト不正
403 アクセス拒否
404 リソースなし
500 サーバーエラー

詳細なAPI仕様

詳細なAPI仕様はSwagger UIで確認できます：

http://localhost:8000/docs