Index操作API

インデックス作成API

目的・用途

新規インデックスを作成する際に使用するAPIである

利用方法

Scopeに「index:create」をもつアクセストークンを使用してAPIを呼び出す

パラメータは以下の内容のjsonとする

curlによるリクエスト例

$ curl https://ホスト/api/indextree/create -H "Authorization:Bearer アクセストークン" -H "Content-Type: application/json" \
-d '{"parent_id":"0","index_info":{"index_name":"APIテスト","index_name_english":"API test","comment":"コメント","public_state":false,"public_state":false}}'

利用可能なロール

機能内容

• 以下を指定してインデックスを新規作成する

  • 親インデックス

• 指定されなかった場合はRoot Index直下に作成される

  • 日本語のインデックス名

  • 英語のインデックス名

• 各インデックス名は、指定されなかった場合は「New Index」が設定される

  • コメント

  • 公開設定

• 指定されなかった場合は「False」が設定される

  • ハーベスト公開設定

• 指定されなかった場合は「True」が設定される

関連モジュール

• weko_index_tree

処理概要

• Scope:

  • weko- index-tree /weko_ index_tree /scopes.py

• API:

  • modules/weko-index-tree/weko_index_tree/views.py

• create_index関数でindexテーブルに新規インデックスを作成する

  • 以下の情報を用いてインデックスを新規作成する

• id：作成時のUNIX時間を1000倍したものを用いる

• parent_id：パラメータで指定されなかった場合には0を設定する

• index_name：「New Index」固定

  • 作成したインデックスを、index_infoの内容を用いてupdateする

  • 作成が成功すると、以下の内容のレスポンスが返却される

• Indexes.updateメソッドの返却値をjson形式にエンコードしたものをレスポンスボディに入れようとする

• しかし、updateメソッドの返却値はNoneなので、実際に入るのはエラーメッセージ「'NoneType' object is not iterable」である

  • パラメータとして空のjsonを渡した場合は、400エラーとなりエラーメッセージ「No data to create.」が返却される

  • index_infoが空だった場合は、400エラーとなりエラーメッセージ「index_info can not be null.」が返却される

インデックス管理API

目的・用途

管理者の権限を以て、インデックスを取得・作成・更新・削除する機能を提供するAPIである。

利用方法

APIの認証にはOAuth2を利用する。

アクセストークンの発行はAPI-1:OAuth2を参照。

API一覧

Scope

インデックス情報を取得するためには、アクセストークンに以下のスコープを要求する。

• index:read

インデックスを新規作成するためには、アクセストークンに以下のスコープを要求する。

• index:create

インデックスを更新するためには、アクセストークンに以下のスコープを要求する。

• index:update

インデックスを削除するためには、アクセストークンに以下のスコープを要求する。

• index:delete

利用可能なロール

※ 〇：利用可能、△：一部機能のみ利用可能、×：利用不可

• インデックスを操作可能なAPIは、システム管理者、リポジトリ管理者、コミュニティ管理者のロールを持つユーザーのみが利用可能である。
• コミュニティ管理者は、所属するコミュニティのインデックスのみを操作可能である。

CURLでのリクエスト実行例

GET /api/v1/tree/

リクエスト

$ curl -k "https://192.168.56.200/api/v1/tree/1623632832836" -H "Authorization:Bearer MjiT81jdxgVdLRi9ENJgAkCM2AuFuDe9Ekh4ZqZuTDtCm4Mu0B7L4AYozTgY" | jq .

• -H オプション

  • リクエストにカスタムヘッダーを追加する
  • Authorization は "Bearer" + " (半角スペース)" + "アクセストークン"の形式で指定する

レスポンス

{
  "index": {
    "pid": 0,
    "cid": 1623632832836,
    "position": 0,
    "name": "サンプルインデックス",
    "link_name": "New Index",
    "index_link_enabled": false,
    "public_state": true,
    "public_date": null,
    "browsing_role": "3,-99,-98",
    "contribute_role": "4,3,-98",
    "browsing_group": "",
    "contribute_group": "",
    "more_check": false,
    "display_no": 5,
    "coverpage_state": false,
    "recursive_coverpage_check": false,
    "is_deleted": false,
    "id": "1623632832836",
    "value": "サンプルインデックス",
    "emitLoadNextLevel": false,
    "settings": {
      "isCollapsedOnInit": true,
      "checked": false
    },
    "children": [],
    "index_name": "サンプルインデックス",
    "index_name_english": "Sample Index",
    "index_link_name_english": "",
    "value_english": "Sample Index"
  }
}

API仕様

インデックスツリー取得機能

全インデックスあるいは指定したインデックスの情報を取得する。

エンドポイント

GET /api//tree：全インデックス

GET /api//tree/：指定したインデックス

リクエストヘッダー

パスパラメータ

レスポンスコード

レスポンスボディ

正常終了

異常終了

インデックス作成機能

インデックスを新規作成する。

エンドポイント

POST /api//tree/index

リクエストヘッダー

パスパラメータ

リクエストボディ

レスポンスコード

レスポンスボディ

正常終了

リクエストボディのindexオブジェクトと同様の形式で、作成されたインデックスの情報を含む。

異常終了

インデックス更新機能

指定したインデックスの情報を更新する。

エンドポイント

PUT /api//tree/index/

リクエストヘッダー

パスパラメータ

リクエストボディ

レスポンスコード

レスポンスボディ

正常終了 リクエストボディのindexオブジェクトと同様の形式で、更新されたインデックスの情報を含む。

異常終了 | 項目名 | 説明 | | ----------- | ------------------------ | | code | HTTPステータスコード | | description | エラーメッセージ |

インデックス削除機能

指定したインデックスを削除する。

エンドポイント

DELETE /api//tree/index/

リクエストヘッダー

パスパラメータ

レスポンスコード

レスポンスボディ

正常終了 レスポンスボディは空。

異常終了 | 項目名 | 説明 | | ----------- | ------------------------ | | code | HTTPステータスコード | | description | エラーメッセージ |

更新履歴