ドキュメント (Documents)
ドキュメントのアップロード、ダウンロード、メタデータおよびファイルバージョンの管理を行います。
Docwize のドキュメントは、メタデータレコード(説明、種類、ステータス、日付など)と、1 つ以上のリンクされたファイル(実際のファイルコンテンツ)で構成されます。新しいバージョンがアップロードされるたびに、以前のファイルはアーカイブされます。
エンドポイント
| メソッド | パス | 説明 | スコープ |
|---|---|---|---|
| POST | /apiv2/pub/documents/upload | 新しいドキュメントをアップロードします | documents_write |
| GET | /apiv2/pub/documents/{doc_id} | ドキュメントのメタデータを取得します | documents_read |
| POST | /apiv2/pub/documents/{doc_id}/versions | 新しいファイルバージョンをアップロードします | documents_write |
| GET | /apiv2/pub/documents/{doc_id}/download | ファイルをストリーム形式でダウンロードします | documents_read |
| GET | /apiv3/pub/documents/{docID}/download-url | 事前署名済みの S3 ダウンロード URL を取得します | documents_read |
| GET | /apiv3/pub/documents/{docID}/versions | 現在のファイルとアーカイブ履歴を取得します | documents_read |
| PATCH | /apiv3/pub/documents/{docID} | ドキュメントのメタデータフィールドを更新します | documents_write |
/apiv2/ と /apiv3/ のエンドポイントは、いずれも同じベースドメインを通じてアクセスされます。パスのプレフィックスは URL の一部であるため、各エンドポイントに示されている正確なパスを使用してください。