Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/spec/base/admin/ADMIN_2_4.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@
| .publish_status | .PUBLISH_STATUS | アイテムの公開/非公開を指定する。public/privateのいずれかを設定する。必須項目。 |
| .feedback_mail[0] | .FEEDBACK_MAIL[0] | フィードバックメールの送信先メールアドレスを指定する。複数指定可。 |
| .request_mail[0] | .REQUEST_MAIL[0] | リクエストメールの送信先メールアドレスを指定する。複数指定可。 |
| .researchmap_linkage | .RESEAECHMAP_LINKAGE | Researchmapへの連携フラグ |
| .item_application.workflow | .ITEM_APPLICATION<br>.WORKFLOW | コンテンツファイルがない場合の利用申請のワークフローIDを指定する。 |
| .item_application.terms | .ITEM_APPLICATION.TERMS |コンテンツファイルがない場合の利用規約IDを指定する。この列のデータ行にterm_freeが入力された場合、利用規約を自由入力として.item_application.terms_descriptionが表示される。 |
| .item_application<br>.terms_description | .ITEM_APPLICATION<br>.TERMS_DESCRIPTION | コンテンツファイルがない場合の利用規約(自由入力)を指定する。 |
Expand Down
3 changes: 2 additions & 1 deletion docs/spec/base/admin/ADMIN_2_5.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,8 @@ RO-Crateには、アイテムのメタデータを記述するための語彙が
[TSV形式のメタデータ項目]()とシステム向け語彙について、定義したカスタム語彙を以下に示す。
カスタム語彙はプレフィックスとして、`wk:`が付与されている。
新規登録としてインポートする際に必須である項目は、インデックスIDと公開ステータスである。
更新登録としてインポートする際に追加で必須になる項目は、アイテムIDとURIである。
更新登録としてインポートする際に追加で必要になる項目は、アイテムIDとURIである。
アイテムIDとURIがファイル内で指定されていない場合は、リクエストURLのパスパラメータで指定されたアイテムID(recid)を用いて、アイテムIDとURIの値を自動的に補完する。(SWORD API経由のみ)
一部の語彙は、RO-Crateインポート機能では使用できず、SWORD APIを利用してアイテムを登録・更新する際に使用される。

| 使用語彙 | 対応するTSV項目名 | バリュータイプ | デフォルト値 | 新規 | 更新 | 説明 |
Expand Down
14 changes: 11 additions & 3 deletions docs/spec/base/api/API_06_sword_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ curl -X PUT https://192.168.56.101/sword/deposit/1 -F "file=@import.zip;type=a

- recid
- アイテムIDを指定する
- ファイルにアイテムidとuriの値が指定されていない場合、recidの値でアイテムidとuriの情報が補完される

- -F オプション
- POSTするファイルを指定する。自動的にContent-Typeは"multipart/form-data"となる
Expand Down Expand Up @@ -735,16 +736,15 @@ DELETE /sword/deposit/\<recid\>
- 承認不要のワークフローの場合はワークフローを最後まで実行し登録を完了させる。
- 承認が必要なワークフローの場合はアクティビティを承認アクションまで進める。
- アクティビティの進行に必要なのメタデータが存在しない場合はアクティビティを停止し、どのメタデータが必須かエラーメッセージをJSON-LD形式で返却する。
- アイテムのPIDと、登録が完了した場合はレコードのURL、アクティビティ詳細画面のURLを返却する
- アイテムのPIDと、レコードのURL、アクティビティ詳細画面のURL、ファイル情報がある場合ファイルリンクを返却する

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

アイテムの登録処理に失敗した場合は、エラー([メッセージ:14](#err14))とする。

5. レスポンスを返却する
- アイテムの登録が完了した場合は、登録されたアイテムのURLをステータスドキュメントに含めて返却する。
- アイテムの登録が完了していない場合は、アクティビティのURLをステータスドキュメントに含めて返却する。
- アイテムの登録完了の有無に関わらず、登録されたアイテムのURL、アクティビティ詳細画面のURLおよび、ファイル情報がある場合はそのファイルのURLをステータスドキュメントに含めて返却する。
- 一連の登録処理に問題がありエラーが発生した場合は、エラードキュメントを返却する。

### アイテム状態取得機能:GET /sword/deposit/&lt;recid&gt;
Expand All @@ -763,6 +763,7 @@ DELETE /sword/deposit/\<recid\>
ほとんどの処理はアイテム状態取得機能と同様であるが、以下の点が異なる。

- アイテムの分割は許可されない
- 更新ファイルで`identifier`および`uri`の値が指定されていない場合、リクエストURLのパスパラメータで指定されたアイテムID(recid)を用いて、`identifier`および`uri`の値を自動的に補完する。
- SWORD v3プロトコルでは、PUTメソッドはアイテムのメタデータとファイルすべての置き換えを意味するが、
例外として[メタデータのみ置換フラグ](../admin/ADMIN_2_5.md#wkmetadatareplaceメタデータのみ置換フラグ)が有効な場合は、
メタデータのみを置き換え、ファイルを維持する。
Expand Down Expand Up @@ -794,6 +795,8 @@ DELETE /sword/deposit/\<recid\>
- 分割されるアイテムは、論文アイテムと論拠データアイテムの2種に分類され、相互にアイテムリンクされる。
- 論文アイテムから論拠データアイテムへのアイテムリンクのリレーションタイプは`isSupplementedBy`、論拠データアイテムから論文アイテムへのアイテムリンクのリレーションタイプは`isSupplementTo`である。
- アイテムリンクにはアイテムIDが必要なため、先に論拠データを登録しそのアイテムIDを取得し、論文アイテムを登録する際に相互にアイテムリンクを設定する。
- 生成されるアイテムURLおよびワークフローがある場合はそれらのURLをレスポンスで返す。
- 分割アイテム間で設定したリンク情報は、ステータスドキュメントの"log"フィールドに含めて返却される。
- このとき、`isSupplementTo`のアイテムリンク先をもつ論拠データアイテムを先に登録するように、アイテムの登録順を制御する。

### 処理に関するエトセトラ
Expand Down Expand Up @@ -1095,6 +1098,11 @@ DELETE /sword/deposit/\<recid\>
"Repository Administrator"
]
```
23. ファイルセットファイルのファイルパス<span id="conf2">

```python
WEKO_SWORDSERVER_FILE_SET_FILE = "/terms/fileSetFile"
```

## 更新履歴

Expand Down
Loading