SWORD API

目的・用途

クライアントからSWORDv3プロトコルに従いリポジトリ上のアイテム操作を実現する。

利用方法

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

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

Scope：

deposit: write

エンドポイント：

CURLでのリクエスト実行例：

各APIのリクエスト仕様の詳細は後述。

GET /sword/service-document

curl https://192.168.56.103/sword/service-document -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo" |

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "認証キー"の形式で指定する

POST /sword/service-document**

curl -s -k https://weko3.ir.rcos.nii.ac.jp/sword/service-document -F
 "file=@import.zip;type=application/zip" -H "Authorization:Bearer 50is1B9XcyHcyRckWx9z0V
2XZnpHq7" -H "Content-Disposition:attachment; filename=import.zip" -H "Packaging:http://
purl.org/net/sword/3.0/package/SimpleZip"| jq .
{
  "@context": "https://swordapp.github.io/swordv3/swordv3.jsonld",
  "@id": "https://weko3.ir.rcos.nii.ac.jp/sword/deposit/96568",
  "@type": "Status",
  "actions": {
    "appendFiles": false,
    "appendMetadata": false,
    "deleteFiles": false,
    "deleteMetadata": false,
    "deleteObject": true,
    "getFiles": false,
    "getMetadata": false,
    "replaceFiles": false,
    "replaceMetadata": false
  },
  "eTag": "5",
  "fileSet": {},
  "links": [
    {
      "@id": "https://weko3.ir.rcos.nii.ac.jp/records/96568",
      "contentType": "text/html",
      "rel": [
        "alternate"
      ]
    },
    {
      "@id": "http://hdl.handle.net/20.500.12465/0000096568",
      "contentType": "text/html",
      "rel": [
        "alternate"
      ]
    }
  ],
  "metadata": {},
  "service": "/sword/service-document",
  "state": [
    {
      "@id": "http://purl.org/net/sword/3.0/state/ingested",
      "description": ""
    }
  ]
}

                                                                            |

| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | curl https://192.168.56.103/sword/service-document -F "file=@export-all3.zip;type=application/zip" -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo" -H "Content-Disposition:attachment; filename=export-all3.zip" -H "Packaging:http://purl.org/net/sword/3.0/package/SimpleZip" |

• -F オプション

  • multipart/form-data 形式で POSTするファイルを指定する

  • boundaryやContent-Lengthは自動で付加されるため自前で指定しなくてもよい

  • ファイル名の先頭には@を付加すること

  • ファイルのContent-Typeを"application/zip"とするため、ここでtypeを指定する（指定しないと application/octet-stream となってしまう）

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "認証キー"の形式で指定する

  • Content-Disposition の filename は -Fオプションで指定したファイルのファイル名と一致させる

  • Packaging は "http://purl.org/net/sword/3.0/package/SimpleZip" を指定

  • 必須の Content-Length および Content-Type については前述の通り、-Fオプションにて自動付加されるため-Hオプションでの指定は不要

　3. GET /sword/deposit/\

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "認証キー"の形式で指定する

　4. DELETE /sword/deposit/\

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "認証キー"の形式で指定する

• 利用可能なロール

• 機能内容

• 各APIへのリクエストに応じて処理を実行しレスポンスを返す

  • OAuthアクセストークンによるユーザー認証を必須とする

• アイテム登録機能で登録に使用するZIPファイルはインポートで使用するものと同様の形式のみ使用できる。

  • ZIPファイル形式の詳細は ADMIN-2-4:インポート を参照

API仕様

• サービスドキュメント取得機能：GET /sword/service-document

• アイテム登録機能：POST /sword/service-document

• アイテム状態取得機能：GET /sword/deposit/\

• アイテム削除機能：DELETE /sword/deposit/\

ドキュメント仕様

• サービスドキュメント
  サーバー全体の機能と操作パラメータを定義したドキュメント

• ステータスドキュメント
  アイテムの内容と現在の状態に関する詳細情報を示すドキュメント

• エラードキュメント
  エラー内容を表すドキュメント

エラータイプ

• 関連モジュール

• invenio_oauth2server：OAuthトークンによるユーザー認証を行う

• invenio_deposit：OAuthトークンが参照するデポジット操作スコープを定義している

• weko_records_ui：レコード情報の取得、アイテムの削除を実行する

• weko_search_ui：インポート処理を実行する

• 処理概要

• サービスドキュメント取得機能：GET /sword/service-document

  • リクエストをチェックする

    • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする

    • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する

  • サーバー設定値を参照し、サービスドキュメントを生成する

  • サービスドキュメントを返却する

• アイテム登録機能：POST /sword/service-document

  • リクエストをチェックする

    • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする

    • 認証に使用されたOAuthトークンのScopeを確認する

    • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する

    • 送付されたファイルの有無を確認する

    • ファイルサイズを確認する

    • Content-Typeを確認する

    • Packagingを確認する

  • ファイル内容に不備が無いかのチェックを行う

  • ファイル内のアイテムが新規登録か否かを確認する

  • インポート処理を行う

  • 登録したアイテムのステータスドキュメントを生成する

    • インポート処理から返されたrecidからアイテム情報を取得する

    • 取得したアイテム情報からステータスドキュメントを生成する

  • ステータスドキュメントを返却する

• アイテム状態取得機能：GET /sword/deposit/\

  • リクエストをチェックする

    • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする

    • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する

  • 指定されたrecidからアイテム情報を取得する

  • 取得したアイテム情報からステータスドキュメントを生成する

  • ステータスドキュメントを返却する

• アイテム削除機能：DELETE /sword/deposit/\

  • リクエストをチェックする

    • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする

    • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する

  • 指定されたrecidを引数にsoft_delete処理を実行する

  • 空のレスポンスを返却する

• 更新履歴