CIRCUS CS の API

• 🔱: application/json 以外の Mime-Type 型を入出力するもの。

ジョブの管理

endpoint	description
GET /api/plugin-jobs	CADジョブの検索 (casesなどと共通のsearch処理を使う)
POST /api/plugin-jobs	新しいCAD実行命令の発行（キューに入れる）
GET /api/plugin-job/:jobId	特定のCADジョブに関する詳細情報を取得

• 検索の場合に返すデータにはフィードバックや結果に関する情報を含まない（データが大きすぎるので）。

フィードバックの管理

endpoint	description
GET /api/plugin-jobs/:jobId/feedback	特定のジョブに結びついたフィードバック一覧を返す
POST /api/plugin-jobs/:jobId/feedback/personal	個人フィードバックを1つ登録する
POST /api/plugin-jobs/:jobId/feedback/consensual	統合フィードバックを1つ登録する
DELETE /api/plugin-jobs/:jobId/feedback/personal	自分のフィードバックを削除する
DELETE /api/plugin-jobs/:jobId/feedback/personal/:userEmail	任意のユーザの個人フィードバックを削除する
DELETE /api/plugin-jobs/:jobId/feedback/consensual/:userEmail	統合フィードバックを1つ削除する

ジョブキューの取得とジョブのキャンセル

endpoint	description
GET /api/plugin-job-queue	ジョブキューの状態を返す。
DELETE /api/plugin-job-queue/:jobId	ジョブをキャンセルする。

ジョブのキャンセルはまだ実行が始まっていないジョブ(status がwaitingのもの)に対してのみ可能。一旦実行が始まってしまったジョブをその途中でキャンセルする方法はまだない。（将来的に対応したい）

プラグインの管理

endpoint	description
GET /api/plugins	現在利用可能なCADプラグインの一覧を返す。

• 未定だがそのうちプラグインにかかわる設定のようなものを付け加えていく予定

プラグインジョブマネージャ(daemon)の管理

endpoint	description
GET /api/plugin-job-manager	現在のジョブマネージャの動作状況を取得する。
POST /api/plugin-job-manager/switch	ジョブマネージャの起動・停止を行う。 { status: 'running' } または { status: 'stopped' } を POST することで ON/OFF する。