REST APIでファイル名を変更する

PUT /api/files/:id/renameはファイルID、親、バージョン履歴を維持したまま保存名を変更します。拡張子はnameの一部です。変更するとクライアントによるファイルの分類やプレビューが変わる場合があります。

始める前に

• フルアクセスのAPIキーとrename_filesを持つワークスペースのロールを使用してください。
• 現在のファイルを読み取り、ID、親、ロック状態、現在の名前を確認してください。
• 前後の空白を除いて1〜255文字の名前を選んでください。/、\、C0制御文字を含めることや、.または..だけで構成することはできません。

手順

1. GET /api/files/file_idを送信して親IDを保持してください。拡張子が重要な場合は、新しい名前に必要な拡張子を明示します。
2. 正確なJSON本文を作成してください。例：{"name":"Q4 forecast.pdf"}。引用符と山括弧は使用できますが、クライアントでJSONを正しくエスケープする必要があります。
3. PUT /api/files/file_id/renameをBearer認証とContent-Type: application/jsonとともに送信してください。この呼び出しは無関係なバッチ処理と分けます。
4. HTTP 200と{ "ok": true, "name": "Q4 forecast.pdf" }を確認してください。400は入力が無効、403はスコープ、ロール、ロックによる拒否、404は利用不可、409は同じ親の項目との名前の競合を示します。
5. 同じファイルIDを再度読み取り、親IDが変わらずnameが変わったことを確認してください。返されたX-D1-BookmarkはD1を使う確認に引き継ぎますが、ワークスペースオブジェクトの内容の順序を保証するものではありません。
6. 拡張子を変更した場合は、名前を変更したファイルを開くかダウンロードしてください。バイトが変わっていなくても、自動処理が誤って拡張子を変更したことを検出できます。

期待される結果

成功時の受領情報には正規化された名前が返ります。新たにメタデータを読み取ると、同じファイルIDと親に新しい名前が表示されます。バージョンはそのIDに紐付いたままです。

トラブルシューティング

400が返る場合 値の前後の空白を除き、長さ、スラッシュ、バックスラッシュ、制御文字、.、..のルールを確認してください。

409が返る場合 同じ親の項目が既に指定した名前を使用しています。別の名前を選ぶか、その項目との競合を解消してから新しいリクエストを送信してください。

403が返る場合 キーのフルスコープ、rename_files、呼び出し元に対してファイルがロックされていないことを確認してください。

関連ガイド

• フォルダー操作を使用する
• REST APIクイックスタート