SWORD API

目的・用途

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

アイテム登録には、TSV/CSV、XML、あるいはJSON-LD形式のメタデータを含むZIPファイルを用いる。

利用方法

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

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

Scope：

アイテムをアップロードし、直接登録するためには以下のスコープが必要となる。

• deposit:write
• deposit:actions
• item:create

既存のアイテムを更新するためには以下のスコープが必要となる。

• deposit:write
• deposit:actions
• item:update

アイテムを削除するためには以下のスコープが必要となる。

• deposit:write
• deposit:actions
• item:delete

アイテムをワークフローを経由して登録・更新・削除するためには、さらに以下のスコープが必要となる。

• user:activity

エンドポイント：

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

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

GET /sword/service-document

リクエスト

$ curl -X GET https://192.168.56.101/sword/service-document \
    -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo"

• -H オプション

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

レスポンス

{
  "@context": "https://swordapp.github.io/swordv3/swordv3.jsonld",
  "@id": "https://192.168.56.101/sword/service-document",
  "@type": "ServiceDocument",
  "accept": [
    "*/*"
  ],
  "acceptArchiveFormat": [
    "application/zip"
  ],
  "acceptDeposits": true,
  "acceptMetadata": [
    "https://github.com/JPCOAR/schema/blob/master/2.0/jpcoar_scm.xsd",
    "https://w3id.org/ro/crate/1.1/"
  ],
  "acceptPackaging": [
    "*"
  ],
  "authentication": [
    "OAuth"
  ],
  "byReferenceDeposit": false,
  "collectionPolicy": {},
  "dc:title": "WEKO3",
  "dcterms:abstract": "",
  "digest": [
    "SHA-256",
    "SHA",
    "MD5"
  ],
  "maxAssembledSize": 30000000000000,
  "maxByReferenceSize": 30000000000000000,
  "maxSegments": 1000,
  "maxUploadSize": 16777216000,
  "onBehalfOf": true,
  "root": "https://192.168.56.101/sword/service-document",
  "staging": "",
  "stagingMaxIdle": 3600,
  "treatment": {},
  "version": "http://purl.org/net/sword/3.0"
}

POST /sword/service-document

リクエスト

$ curl -X POST -s -k https://192.168.56.101/sword/service-document -F "file=@import.zip;type=application/zip" \
    -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo" \
    -H "Content-Disposition:attachment; filename=import.zip" -H "Packaging:http://purl.org/net/sword/3.0/package/SimpleZip"

レスポンス

{
  "@context": "https://swordapp.github.io/swordv3/swordv3.jsonld",
  "@id": "https://192.168.56.101/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": ""
    }
  ]
}

• -F オプション

  • POSTするファイルを指定する。自動的にContent-Typeは"multipart/form-data"となる
  • 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オプションでの指定は不要

GET /sword/deposit/\

curl -X GET https://192.168.56.101/sword/deposit/1 -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo"

• recid

  • アイテムIDを指定する

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "アクセストークン"の形式で指定する

PUT /sword/deposit/\

curl -X PUT https://192.168.56.101/sword/deposit/1   -F "file=@import.zip;type=application/zip" \
    -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo" \
    -H "Content-Disposition:attachment; filename=import.zip" -H "Packaging:http://purl.org/net/sword/3.0/package/SimpleZip"

• recid

  • アイテムIDを指定する

• -F オプション

  • POSTするファイルを指定する。自動的にContent-Typeは"multipart/form-data"となる
  • boundaryやContent-Lengthは自動で付加されるため自前で指定しなくてもよい
  • ファイル名の先頭には@を付加すること
  • ファイルのContent-Typeを"application/zip"とするため、ここでtypeを指定する（指定しないと application/octet-stream となってしまう）

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "アクセストークン"の形式で指定する

DELETE /sword/deposit/\

curl -X DELETE https://192.168.56.101/sword/deposit/1 -H "Authorization:Bearer Dp85qdLJefoKZ9AuUeIVCqL0Zj9lHxulU1ZSqWGZKI0xJUfxA4wKFnWgztEo"

• recid

  • アイテムIDを指定する

• -H オプション

  • Authorization は "Bearer" + " (半角スペース)" + "アクセストークン"の形式で指定する

利用可能なロール

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

• アイテムを操作可能なAPIは、システム管理者、リポジトリ管理者が利用可能。

機能内容

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

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

• アイテム登録機能で登録に使用するZIPファイルは、メタデータのファイルがTSV/CSV形式、XML形式、あるいはJSON-LD形式である必要がある。

  • TSV/CSV形式のメタデータを含むZIPファイルの詳細は ADMIN_2_4：インポート を参照
  • XML形式のメタデータを含むZIPファイルは、JPCOARスキーマに準拠したXMLファイルを含むZIPファイルである必要がある。
  • JSON-LD形式のメタデータを含むZIPファイルは、RO-Crate+BagIt またはSWORDBagItに準拠したZIPファイルである必要がある。

• メタデータ形式がXMLおよびJSON-LDの場合は、マッピング機能をもちいてWEKO3のアイテムタイプへ変換されメタデータの登録および更新に使用される。

• メタデータ形式がJSON-LDの場合、メタデータ内の特定のフラグが有効の場合、展開せずZIPファイルそのものをアイテムのファイルとして保存する。
  
  フラグについては ADMIN_2_5：RO-Crate インポート を参照。

• SWORD APIの管理者による設定は、ADMIN_1_5：JSON-LD マッピング 、 ADMIN_16_1：SWORD API を参照。

API仕様

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

リポジトリのサービスドキュメントを取得する。

エンドポイント

GET /sword/service-document

リクエストヘッダー

レスポンスコード

レスポンス

成功時 : サービスドキュメントを返す。 失敗時 : エラードキュメントを返す。

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

一括登録用のZIPファイルを用いてアイテムを新規登録する。

エンドポイント

POST /sword/service-document

リクエストヘッダー

ボディ

レスポンスコード

レスポンス

成功時 : ステータスドキュメントを返す。 失敗時 : エラードキュメントを返す。

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

エンドポイント

GET /sword/deposit/\

リクエストヘッダー

パスパラメータ

レスポンスコード

レスポンス

成功時 : ステータスドキュメントを返す。 失敗時 : エラードキュメントを返す。

アイテム更新機能：PUT /sword/deposit/\

エンドポイント

PUT /sword/deposit/\

リクエストヘッダー

パスパラメータ

ボディ

レスポンスコード

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

エンドポイント

DELETE /sword/deposit/\

リクエストヘッダー

パスパラメータ

レスポンスコード

レスポンス

成功時 : 空のレスポンスを返す。 アクティビティを使用している場合、アクティビティ詳細画面のURLをLinkヘッダーに含める。 失敗時 : エラードキュメントを返す。

ドキュメント仕様

サービスドキュメント

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

ステータスドキュメント

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

エラードキュメント

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

エラータイプ

関連モジュール

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

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

• weko_swordserver：リクエストの処理を行う

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

• weko_search_ui：インポート処理およびメタデータのマッピング処理を実行する

• weko_workflow：ワークフロー経由でインポート処理を実行する

関連テーブル

• item_type_mapping：アイテムタイプとjpcoar語彙のマッピング情報を保持する

  • id：ID
  • item_type_id：アイテムタイプID
  • mapping：マッピング定義(JSON)

• sword_clients：SWORD連携設定情報を保持する

  • id：ID
  • client_id：クライアントID
  • active：有効フラグ
  • registration_type_id：登録方式区分。1:直接登録、2:ワークフロー登録
  • mapping_id：マッピング定義ID
  • workflow_id：ワークフローID
  • duplicate_check：アイテム重複チェックフラグ
  • meta_data_api：メタデータ補完APIの優先順序

• jsonld_mappings：アイテムタイプとJSON-LD語彙のマッピング定義設定を保持する

  • id：マッピング定義ID
  • name：マッピング定義名
  • mapping：マッピング定義(JSON)
  • item_type_id：アイテムタイプID
  • version_id：バージョンID
  • is_delete：論理削除フラグ

• oauth2server_token：クライアントが使用できるトークンを保持する

  • id：オブジェクトID
  • client_id：クライアントID
  • user_id：ユーザーID
  • token_type：トークンタイプ
  • access_token：アクセストークン
  • refresh_token：リフレッシュトークン
  • expires：有効期限
  • _scopes：スコープ
  • is_personal：個人用トークンフラグ
  • is_internal：内部用トークンフラグ

処理概要

使用する設定値はサーバー設定値、エラーメッセージはエラーメッセージを参照。

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

• リクエストをチェックする
  • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする
  • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する
• サーバー設定値を参照し、サービスドキュメントを生成する
• サービスドキュメントを返却する

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

GRDM側(想定)

1. GRDMでインポート画面を表示する際、WEKOのAPIを使用しユーザーの選択可能な登録先を取得する
2. GRDMでインポートするデータを指定し、パッケージ化する
3. WEKOのエンドポイントPOST /sword/service-documentにパッケージを送信する
   
   この時、リクエストヘッダーにアクセストークンを付加する

WEKO3側

1. リクエストをチェックする

   • Authorization ヘッダーに記載されたアクセストークンを使用しユーザーを認証する。
     
     アクセストークンのScopeを確認し、deposit:write、deposit:actions、item:createが与えられていなければエラーとする。
   • On-Behalf-Of ヘッダーが存在する場合、On-Behalf-Of許容設定（設定値:13）が無効であればエラー（メッセージ:2）とする。
   • Content-Length ヘッダーおよびファイルサイズを検証する。
     
     Content-Lengthヘッダーの値あるいはファイルサイズがアップロードのサイズ上限（設定値:17）を上回っていればエラー（メッセージ:5）とする。
   • Content-Disposition ヘッダーを解析する。
     
     値がattachmentかつオプションにファイル名が指定されているかを確認し、満たさない場合はエラー（メッセージ:8）とする。 リクエストのファイルの有無や実際のファイルと上記のファイル名の合致を確認し、不一致であればエラー（メッセージ:9とする。
   • Content-Type ヘッダーをもとに送付されたファイルを検証する。
     
     ヘッダーの値がapplication/zipでなければ、エラー（メッセージ:6）とする。
   • Packaging ヘッダーを検証する。
     
     値の末尾がSWORDBagItのとき、/metadataフォルダ直下にsword.jsonファイルが存在すればSWORDBagIt形式と判定し、なければエラー（メッセージ:16）とする。
     
     値の末尾がSimpleZipのとき、/dataフォルダ直下にro-crate-metadata.jsonファイルが存在すればRO-Crate+BagIt形式と判定し、.tsv/.csvファイルがあればTSV/CSV形式、.xmlファイルがあればXML形式と判定する。
     
     値がその他の場合はエラー（メッセージ:07）とする。

   • Digest ヘッダーを検証する。
     
     メタデータ形式がJSON-LD、かつダイジェスト検証設定（設定値:21）が有効であるとき、DigestとリクエストボディのZipファイルのハッシュ値が一致しなければエラー（メッセージ:10）とする。

     ※ SWORD APIでは使用可能なエラータイプが定められているため、適切なエラータイプが存在しない場合はBad Request（エラーコード400）とし、エラードキュメントにエラー原因を記述し返却する。

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

   Zipファイルを展開し、必要なファイルが含まれているか確認する。メタデータファイル形式によって必須事項が異なる。

   TSV/CSV形式

   • メタデータを記述したTSV/CSVファイルが含まれていなければエラーとする。

     XML形式

   • メタデータを記述したXMLファイルが含まれていなければエラーとする。

     JSON-LD形式

   • 登録対象のファイルそれぞれのハッシュ値がmanifest-sha256.txt に記載されている値と一致しなければエラー（メッセージ:24）とする。

3. 登録の前処理を行う

   メタデータファイル形式がXMLおよびJSON-LDであれば、メタデータをアイテムタイプへマッピングする。
   
   また、アイテムを登録するとき、一括登録機能をもちいて直接登録をするか、個別登録機能をもちいてワークフローを経由して登録するかを、 ADMIN_16_1：SWORD API TSV/XMLおよびADMIN_16_2：SWORD API JSON-LDの設定から取得する。
   
   このとき、設定されたワークフローが削除されていた場合や、Item Registration アクションが含まれていなければエラー（メッセージ:22）とする。

   TSV/CSV形式

   • メタデータのマッピングを行わず、直接アイテムタイプとして読み込む。

   • アイテムタイプをもとに、使用できるワークフローを取得する。

     XML形式

   • メタデータをアイテムタイプにマッピングする。
   • アイテムタイプとjpcoar語彙のマッピング定義からのキーが一致するXMLのメタデータの属性値を探す。

   • 新しいJSONを作成し対応する「item_xxxx」をキー、対応するXMLのメタデータ部分を値とする。

     JSON-LD形式

   • アクセストークンから、マッピング定義、マッピング先アイテムタイプを取得する。
     
     クライアントに対する設定がない場合はエラー（メッセージ:21）とする。
   • JSONファイルからメタデータを取得し、マッピング定義に基づいてメタデータをアイテムタイプへマッピングする。
     
     マッピング処理の詳細については、メタデータマッピング機能を参照。
     
     SWORD APIとしては原則1リクエストにつき1つのアイテムが登録されるべきだが、例外としてアイテム分割フラグ（wk:isSplited）が有効であれば、メタデータを論文アイテムと論拠データアイテムに分割する。 アイテム分割機能を参照。
   • 登録用ファイル保存フラグ（wk:saveAsIs）が有効であれば、メタデータを含むZIPファイルそのものをアイテムのファイルとして 登録するようにメタデータを作成する。
   • マッピング先が無いメタデータはテキストエリアに保存する。
   • メタデータ自動補完フラグ（wk:metadataAutoFill）が有効で、補完にもちいるDOIが指定されていれば、メタデータ補完APIを呼び出し、メタデータを補完する。

   • ファイルが階層化されている場合、weko3のストレージでは階層を維持できないため、あらかじめ相対パスをURLエンコードしてファイル名を改め、/data/フォルダ直下に配置する。
     
     例：/data/20230101/sample.pdf → /data/20230101%2Fsample.pdf

     共通処理

   • On-Behalf-Ofヘッダーが存在する場合、その値を取得しアイテムの代理投稿者情報とする。
   • 読み込まれたメタデータのバリデーションチェックや必須項目のチェックを行い、問題があればエラー（メッセージ:11）とする。
   • 登録先インデックスの状態やアイテムの公開ステータスのチェックを行い、問題があればエラーとする。
   • SWORD API設定（ADMIN_16_1、ADMIN_16_2）でアイテム重複チェックが有効であれば、アイテムの重複チェックを行う。
     
     重複している場合はエラー（）とする。

4. 登録処理を行う アイテムの登録方法に応じて別々の登録処理を行う。

   直接登録の場合

   • 一括インポート機能を使用してインポート処理を行う。

     ワークフロー経由で登録する場合

   • 設定されたワークフローで新しいアクティビティを作成する。

   • 読み込まれたメタデータをもとにアクティビティにメタデータや登録先インデックスを保存する。
   • 承認不要のワークフローの場合はワークフローを最後まで実行し登録を完了させる。
   • 承認が必要なワークフローの場合はアクティビティを承認アクションまで進める。
   • アクティビティの進行に必要なのメタデータが存在しない場合はアクティビティを停止し、どのメタデータが必須かエラーメッセージをJSON-LD形式で返却する。

   • アイテムのPIDと、登録が完了した場合はレコードのURL、アクティビティ詳細画面のURLを返却する。

     ※ メタデータ形式がXML形式の場合、現時点ではインデックスを指定することができないため、直接登録は行えない。
     
     また、ワークフロー経由で登録する場合、ワークフローに登録先インデックスが指定されていなければ、アクティビティにメタデータとファイルを登録して停止する。

     アイテムの登録処理に失敗した場合は、エラー（メッセージ:14）とする。

5. レスポンスを返却する

   • アイテムの登録が完了した場合は、登録されたアイテムのURLをステータスドキュメントに含めて返却する。
   • アイテムの登録が完了していない場合は、アクティビティのURLをステータスドキュメントに含めて返却する。
   • 一連の登録処理に問題がありエラーが発生した場合は、エラードキュメントを返却する。

アイテム状態取得機能：GET /sword/deposit/<recid>

• リクエストをチェックする
  • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする
  • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する
• 指定されたrecidからアイテム情報を取得する
• 取得したアイテム情報からステータスドキュメントを生成する
• ステータスドキュメントを返却する

アイテム更新機能：PUT /sword/deposit/<recid>

• 更新の場合は、アイテムIDとアイテムのURLが必要である。詳細は使用語彙を参照。

ほとんどの処理はアイテム状態取得機能と同様であるが、以下の点が異なる。

• アイテムの分割は許可されない
• SWORD v3プロトコルでは、PUTメソッドはアイテムのメタデータとファイルすべての置き換えを意味するが、 例外としてメタデータのみ置換フラグが有効な場合は、 メタデータのみを置き換え、ファイルを維持する。
  
  本来、このような扱いはメタデータのURIに対するPOSTメソッドで行うべき処理であるが、暫定的にアイテム更新のPUTメソッドで対応する。
• 画面やAPI同士との競合を避けるため、排他制御を行う。排他制御によって更新が拒否された場合は、エラー（ーメッセージ:25）とする。
  
  一括インポート機能によって更新中である場合、すでにアイテムに対するアクティビティが存在する場合も同様にエラー（ーメッセージ:26、メッセージ:27）とする。

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

• リクエストをチェックする
  • Authorizationヘッダーに記載されたOAuth認証情報を使用しWEKOにログインする
  • On-Behalf-Ofヘッダーが存在する場合、サーバー設定を確認する
• ADMIN_16_1：SWORD API TSV/XMLおよびADMIN_16_2：SWORD API JSON-LDの設定、 ワークフローに削除用フローが設定されているかを確認し、直接削除を行うか、ワークフローを経由して削除するかを決定する。
• 画面やAPI同士との競合を避けるため、排他制御を行う。排他制御によって更新が拒否された場合は、エラー（メッセージ:25）とする。
  
  一括インポート機能によって更新中である場合、すでにアイテムに対するアクティビティが存在する場合も同様にエラー（メッセージ:26、メッセージ:27）とする。
• 直接削除の場合、アイテムの削除を行う
• ワークフロー経由で削除する場合、削除用のアクティビティを作成し、承認アクションがなければアイテムの削除を行う。ある場合はアクティビティを承認アクションまで進めて停止する。
• 空のレスポンスを返却する

アイテム分割機能

• SWORD v3プロトコルでは、1リクエストにつき1つのアイテムが登録されるべきであるが、WEKO3ではアイテム分割機能を提供している。
• これは、1つのアイテムを論文アイテムと論拠データアイテムに分割して登録する機能であり、複数アイテムを1リクエストで登録するために提供される機能ではない。
• この機能を使用するには、JSON-LD形式のメタデータ内で、wk:isSplitedプロパティにtrueを設定する必要がある。
• 記述方法については、ADMIN_2_5：RO-Crate インポートを参照。
• 分割されるアイテムは、論文アイテムと論拠データアイテムの2種に分類され、相互にアイテムリンクされる。
• 論文アイテムから論拠データアイテムへのアイテムリンクのリレーションタイプはisSupplementedBy、論拠データアイテムから論文アイテムへのアイテムリンクのリレーションタイプはisSupplementToである。
• アイテムリンクにはアイテムIDが必要なため、先に論拠データを登録しそのアイテムIDを取得し、論文アイテムを登録する際に相互にアイテムリンクを設定する。
• このとき、isSupplementToのアイテムリンク先をもつ論拠データアイテムを先に登録するように、アイテムの登録順を制御する。

処理に関するエトセトラ

• ZIPの展開に使用しているライブラリ：zipfile
• ハッシュ値の計算に使用しているライブラリ：hashlib
• Bagの整合性検証に使用しているライブラリ：bagit v1.7.0

• アイテムをインポートする際に作成する一時ディレクトリは以下のようにミリ秒までの日時を含めて生成する。

  /tmp/weko_import_YYYYMMDDhhmmssfff

エラーメッセージ

1. OAuthトークンがリクエストに含まれていない場合

   "OAuth token is missing in the request."
   

2. On-Behalf-Of ヘッダーがサポートされていない場合

   "Not support On-Behalf-Of but request has it."
   

3. リクエストにファイルが含まれていない場合

   "No file part."
   

4. ファイルが選択されていない場合

   "No selected file."
   

5. Content-Length が最大アップロードサイズを超える場合

   "Content size is too large. (request:[Content-Lengthの値], maxUploadSize:[最大アップロードサイズ])"
   

6. サポートされていない Content-Type がリクエストに含まれている場合

   "Not accept Content-Type: [サポートされていないContent-Type]"
   

7. サポートされていないパッケージング形式がリクエストに含まれている場合

   "Not accept packaging: [サポートされていないパッケージング形式]"
   

8. Content-Disposition ヘッダーからファイル名を取得できない場合

   "Cannot get filename by Content-Disposition."
   

9. リクエストボディにファイルが見つからない場合

   "Not found [ファイル名] in request body."
   

10. リクエストボディとダイジェストの検証に失敗した場合

    "Failed to verify request body and digest."
    

11. インポートアイテムのチェック中にエラーが発生した場合

    "Item check error: [エラーメッセージ]"
    

12. アイテムが既に登録されている場合

    "This item is already registered: [アイテムのタイトル]"
    

13. アイテムの重複を検知した場合

    "New item appears to be a duplicate: [重複が疑われるアイテムIDのリスト]"
    

14. アイテムのシステムへのインポート中にエラーが発生した場合

    "Failed to import item; [エラーメッセージ]"
    

15. 管理者による設定で特定のメタデータ形式によるアイテム登録が無効な場合

    "[メタデータ形式] metadata import is not enabled."
    

16. SWORDBagIt形式で metadata/sword.json が存在しない場合

    "SWORDBagIt requires metadate/sword.json."
    

17. RO-Crate+BagIt形式で ro-crate-metadata.json の位置が誤っている場合

    "ro-crate-metadata.json is required in data/ directory."
    

18. SimpleZip形式で metadata/sword.json が存在する場合

    "packaging format is SimpleZip, but sword.json is found."
    

19. On-Behalf-Of ヘッダーでユーザーが見つからない場合

    "No user found by On-Behalf-Of."
    

20. On-Behalf-Of ヘッダーでユーザー検索中にエラーが発生した場合

    "Failed to get shared ID from On-Behalf-Of."
    

21. クライアントに対する設定がされていない場合

    "No SWORD API setting found for client ID that you are using."
    

22. ワークフローが見つからない、または削除されている場合

    "Workflow is not for item registration."
    

23. マッピング定義設定のアイテムタイプIDとワークフローのアイテムタイプIDが一致しない場合

    "Item type and workflow do not match. ItemType ID must be [マッピング定義設定のアイテムタイプID], but the workflow's ItemType ID was [ワークフローのアイテムタイプID]."
    

24. Bagの検証に失敗した場合

    "Failed to validate import bagit file."
    

25. アイテムの更新や削除処理が排他制御によって拒否された場合

    "Item [アイテムID] will be edited by another process."
    

26. 更新、削除対象のアイテムが一括インポートによる更新中である場合

    "Item [アイテムID] is in import progress."
    

27. アイテムに更新や削除のためのアクティビティが存在する場合

    "Item [アイテムID] is being edited."
    

サーバー設定値

1. サーバーがサポートするSWORDプロトコルのバージョン

    WEKO_SWORDSERVER_SWORD_VERSION = "http://purl.org/net/sword/3.0"
   

2. サービスの説明

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ABSTRACT = ""
   

3. サーバーが受け入れられるコンテンツタイプのリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ACCEPT = ["*/*"]
   

4. サーバーが展開できるアーカイブ形式のリスト

   サーバーが異なるフォーマットでパッケージを送信した場合、サーバーはそれをバイナリファイルとして扱うことができる。

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ACCEPT_ARCHIVE_FORMAT = ["application/zip"]
   

5. ファイルの登録を受け付けるかどうか

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ACCEPT_DEPOSITS = True
   

6. サーバーが受け入れられるメタデータ形式のリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ACCEPT_METADATA = [
        "https://github.com/JPCOAR/schema/blob/master/2.0/jpcoar_scm.xsd",
        "https://w3id.org/ro/crate/1.1/",
    ]
   

7. サーバーで受け入れられるパッケージ形式のリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ACCEPT_PACKAGING = ["*"]
    """
    ["*"] or List of Packaging Formats URI
    - http://purl.org/net/sword/3.0/package/Binary
    - http://purl.org/net/sword/3.0/package/SimpleZip
    - http://purl.org/net/sword/3.0/package/SWORDBagIt
    """
   

8. サーバーの収集ポリシーのURLと説明

    WEKO_SWORDSERVER_SERVICEDOCUMENT_COLLECTION_POLICY = {}
    """
    example:
    {
        "@id" : "http://www.myorg.ac.uk/collectionpolicy",
        "description" : "...."
    }
    """
   

9. デポジット時に期待される処理のURLと説明を示すオブジェクト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_TREATMENT = {}
   

10. セSegmented File Upload時のステージング先URL

    WEKO_SWORDSERVER_SERVICEDOCUMENT_STAGING = ""
    

11. Segmented File Upload時のステージングしたファイルを保持する最小時間

    WEKO_SWORDSERVER_SERVICEDOCUMENT_STAGING_MAX_IDLE = 3600
    

12. 参照によるデポジットをサポートするか

    WEKO_SWORDSERVER_SERVICEDOCUMENT_BY_REFERENCE_DEPOSIT = False
    

13. 他のユーザーに代わっての代理投稿をサポートするか

    WEKO_SWORDSERVER_SERVICEDOCUMENT_ON_BEHALF_OF = True
    

14. サーバーが受け入れるダイジェスト形式のリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_DIGEST = ["SHA-256"]
    

15. サポートする認証方式のリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_AUTHENTICATION = ["OAuth"]
    

16. 親サービスに含まれるサービスのリスト

    WEKO_SWORDSERVER_SERVICEDOCUMENT_SERVICES = []
    

17. アップロードされるファイルの最大サイズ (整数) (バイト単位)

    WEKO_SWORDSERVER_SERVICEDOCUMENT_MAX_UPLOAD_SIZE = 16777216000
    

18. 参照によってアップロードされたファイルの最大サイズ (バイト単位)

    WEKO_SWORDSERVER_SERVICEDOCUMENT_MAX_BY_REFERENCE_SIZE = 30000000000000000
    

19. Segmented File Uploadの合計サイズの最大サイズ (整数) (バイト単位)

    WEKO_SWORDSERVER_SERVICEDOCUMENT_MAX_ASSEMBLED_SIZE = 30000000000000
    

20. Segmented File Uploadがサポートされている場合、サーバーがひとつのアップロードで受け入れるセグメントの最大数

    WEKO_SWORDSERVER_SERVICEDOCUMENT_MAX_SEGMENTS = 1000
    

21. クライアントにダイジェストを送信することを要求するか

    WEKO_SWORDSERVER_DIGEST_VERIFICATION = True
    

22. SWORD APIを使用することができるロール

    WEKO_SWORDSERVER_DEPOSIT_ROLE_ENABLE = [
        "System Administrator",
        "Repository Administrator"
    ]
    

更新履歴