Skip to content

API

Jump to bottom
Akira Kamiya edited this page Mar 28, 2019 · 8 revisions

How to use the API

IBIS CREATORのAPIはRESTful APIの仕様に準拠しています．

  • GETメソッド : リソースの取得（複数・一部）
  • POSTメソッド : リソースの作成
  • PUTメソッド : リソースの更新（全部）
  • PATCHメソッド : リソースの更新（一部）
  • DELETEメソッド : リソースの削除

レスポンスはjson形式になっています．

各々についてのAPIの仕様は以下になります．（ページ内リンク）

テーマ

取得

  • Httpメソッド : GET
  • URL : /api/themes/
  • 検索クエリー :
    • id : テーマのID
    • name : テーマの名前
  • レスポンス
    • theme_id: テーマのID
    • theme_name: テーマ名
    • theme_description: テーマの説明
    • root_node_id: ルートノードのID

作成

  • Httpメソッド : POST
  • URL : /api/themes/
  • パラメーター :
    • theme_name : テーマ名
    • theme_description : テーマの説明
    • root_node_name : テーマ作成時に作成されるルートノード名, この項目は必須ではありません．
    • root_node_description : テーマ作成時に作成されるルートノードの説明, この項目は必須ではありません．
  • レスポンス
    • theme_id: テーマのID
    • theme_name: テーマ名
    • theme_description: テーマの説明
    • root_node_id: ルートノードのID

更新

  • Httpメソッド : PUT, PATCH
  • URL : /api/themes/{テーマID}/
  • パラメーター :
    • theme_name : テーマ名
    • theme_description : テーマの説明
  • レスポンス
    • theme_id: テーマのID
    • theme_name: テーマ名
    • theme_description: テーマの説明
    • root_node_id: ルートノードのID

ノード

取得

  • Httpメソッド : GET
  • URL : /api/nodes/
  • 検索クエリー :
    • id : ノードのID
    • name : ノードの名前
    • type : ノードの種類
    • theme_id : テーマID
  • レスポンス
    • node_id : ノードのID
    • node_name : ノード名
    • node_type : ノードの種類
    • node_description : ノードの説明
    • parent_node_id: 親ノードのID
    • child_nodes_id: 子ノードのID
    • theme_id: ノードが属するテーマのID

作成

  • Httpメソッド : POST
  • URL : /api/nodes/
  • パラメーター :
    • node_name: ノード名
    • node_type: ノードの種別, 許可されているノードの種類は以下になります．
      • Issue, Idea, Merit, Demerit, Example, Reason, Opinion
    • node_description: ノードの説明，この項目は必須ではありません．
    • parent_node_id: 親ノードのID．
  • レスポンス
    • node_id : ノードのID
    • node_name : ノード名
    • node_type : ノードの種類
    • node_description : ノードの説明

更新

  • Httpメソッド : PUT, PATCH
  • URL : /api/nodes/{ノードID}/
  • パラメーター :
    • node_name : ノード名
    • node_type : ノードの種別
    • node_description : ノードの説明
  • レスポンス
    • node_id : ノードのID
    • node_name : ノード名
    • node_type : ノードの種類
    • node_description : ノードの説明
    • parent_node_id: 親ノードのID
    • child_nodes_id: 子ノードのID
    • theme_id: ノードが属するテーマのID

削除

  • Httpメソッド : DELETE
  • URL : /api/nodes/{ノードID}/

関連情報

取得

  • Httpメソッド : GET
  • URL : /api/relevant_infos/
  • 検索クエリー :
    • id : 関連情報のID
    • title : 関連情報の名前
    • url : 関連情報のURL
    • node_id : ノードのID
  • レスポンス :
    • relevant_info_id : 関連情報のID
    • relevant_title : 関連情報の名前
    • relevant_url : 関連情報のURL
    • node_id : ノードのID

作成

  • Httpメソッド : POST
  • URL : /api/relevant_infos/
  • パラメーター :
    • relevant_url : 関連情報のURL
    • relevant_title : 関連情報の名前
    • node_id : ノードのID
  • レスポンス :
    • relevant_info_id : 関連情報のID
    • relevant_title : 関連情報の名前
    • relevant_info_url : 関連情報のURL
    • node_id : ノードのID

更新

  • Httpメソッド : PUT, PATCH
  • URL : /api/relevant_infos/{関連情報のID}/
  • パラメーター :
    • relevant_url : ノードのID
    • relevant_title : ノード名
  • レスポンス
    • relevant_info_id : 関連情報のID
    • relevant_title : 関連情報の名前
    • relevant_url : 関連情報のURL
    • node_id : ノードのID

削除

  • Httpメソッド : DELETE
  • URL : /api/relevant_infos/{関連情報のID}/

Clone this wiki locally