メインコンテンツまでスキップ

ドキュメント (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 の一部であるため、各エンドポイントに示されている正確なパスを使用してください。