フォルダのコピー

フォルダのコピーを宛先フォルダ内に作成します。

元のフォルダは変更されません。

Box上でフォルダをコピーするには、コピー先となるparentフォルダのidをAPIに渡す必要があります。

curl -i -X POST "https://api.box.com/2.0/folders/4353455/copy" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "parent": {
         "id": "345345"
       }
     }'

Node/TypeScript v10

await client.folders.copyFolder(folderOrigin.id, {
  parent: { id: '0' } satisfies CopyFolderRequestBodyParentField,
  name: copiedFolderName,
} satisfies CopyFolderRequestBody);

Python v10

client.folders.copy_folder(
    folder_origin.id, CopyFolderParent(id="0"), name=copied_folder_name
)

.NET v10

await client.Folders.CopyFolderAsync(folderId: folderOrigin.Id, requestBody: new CopyFolderRequestBody(parent: new CopyFolderRequestBodyParentField(id: "0")) { Name = copiedFolderName });

Swift v10

try await client.folders.copyFolder(folderId: folderOrigin.id, requestBody: CopyFolderRequestBody(parent: CopyFolderRequestBodyParentField(id: "0"), name: copiedFolderName))

Java v10

client.getFolders().copyFolder(folderOrigin.getId(), new CopyFolderRequestBody.Builder(new CopyFolderRequestBodyParentField("0")).name(copiedFolderName).build())

.NET v6

await client.Folders.CopyFolderAsync(folderId: folderOrigin.Id, requestBody: new CopyFolderRequestBody(parent: new CopyFolderRequestBodyParentField(id: "0")) { Name = copiedFolderName });

Node v4

await client.folders.copyFolder(folderOrigin.id, {
  parent: { id: '0' } satisfies CopyFolderRequestBodyParentField,
  name: copiedFolderName,
} satisfies CopyFolderRequestBody);

オプションで、新しいフォルダに別の名前を付けることもできます。

名前に関する制約事項

フォルダ名にはいくつかの制限があります。印字不可能なASCII文字、スラッシュ、バックスラッシュ (/、\) を含む名前のほか、末尾にスペースを含む名前は禁止されています。

また、.および..は予約済みの名前であるため、使用できません。

コピーされるフォルダに含まれる項目が500個以下の場合は、APIコールと同時にコピーが実行されます。コールはコピー操作が完了するまで復帰しません。

コピー元のフォルダに500個を超える項目が含まれる場合は、非同期的にコピー操作が実行され、APIコールはコピー操作が完了していなくても直ちに復帰します。現時点では、コピー操作がいつ終了したのかを確認するAPIはありません。

この操作の進行中は、ファイルツリーの一部がロックされます。ロックされるのは、主に元のフォルダとその子孫フォルダ、および宛先フォルダです。

操作の進行中は、ロックされているどのフォルダに対しても、他の移動、コピー、削除、または復元操作を実行できません。最も重要な点は、同じフォルダをフォルダツリーの2つの異なる部分に同時にコピーすることはできないということです。

宛先フォルダのいずれかの親フォルダにメタデータカスケードポリシーが適用されている場合は、メタデータカスケード操作が非同期的に開始されます。

現時点では、この操作がいつ終了したのかを確認するAPIはありません。

フォルダのコピー

フォルダのコピー

名前に関する制約事項

非同期コピー

フォルダのロック

メタデータ

関連するAPI

関連するガイド