フォルダの削除 (Delete Folder)
DELETE/apiv2/pub/folders/{folder_id}documents_write
フォルダとそのすべてのサブフォルダを完全に削除します。このサブツリーにのみ存在するドキュメントは完全に削除されます。他のフォルダにも存在するドキュメントはリンクが解除されるのみです。
リクエスト
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
folder_id | integer | 削除するフォルダ。 |
レスポンス
200 OK| フィールド | 型 | 説明 |
|---|---|---|
folder_id | integer | 削除されたフォルダ。 |
folders_deleted | integer | 削除されたフォルダの総数（子孫を含む）。 |
documents_deleted | integer | 完全に削除されたドキュメントの数（サブツリーにのみ存在していたもの）。 |
mappings_removed | integer | 削除されたフォルダ・ドキュメント間の関連付けの数。 |
ドキュメント削除のロジック
| 場所 | 結果 |
|---|---|
| このサブツリーにのみ存在する場合 | 完全に削除されます（ファイル、アーカイブ、グループ、レコード） |
| サブツリーと他のフォルダの両方に存在する場合 | リンクが解除されるのみ — ドキュメントは保持されます |
エラー
| ステータス | 理由 |
|---|---|
| 401 | トークンが無効または期限切れです |
| 404 | フォルダが見つからないか、アクセスが拒否されました |
cURL
curl -i -X DELETE "https://portal.docwize.com/apiv2/pub/folders/42" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
{
"folder_id": 42,
"folders_deleted": 4,
"documents_deleted": 12,
"mappings_removed": 18
}