Delphi ActiveX Box: Copy Folder

Back to Index

Used to create a copy of a folder in another folder. The original version of the folder will not be altered. The a response status code of 202 is expected for success.

Documentation: https://developer.box.com/reference#copy-a-folder

CURL Command

curl https://api.box.com/2.0/folders/FOLDER_ID/copy \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \
-d '{"parent": {"id" : DESTINATION_FOLDER_ID}}' \
-X POST

Delphi ActiveX Example

var
rest: TChilkatRest;
success: Integer;
bTls: Integer;
port: Integer;
bAutoReconnect: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
sbResponseBody: TChilkatStringBuilder;
jsonResponse: TChilkatJsonObject;
type: WideString;
id: WideString;
sequence_id: WideString;
etag: WideString;
name: WideString;
created_at: WideString;
modified_at: WideString;
description: WideString;
size: Integer;
path_collectionTotal_count: Integer;
created_byType: WideString;
created_byId: WideString;
created_byName: WideString;
created_byLogin: WideString;
modified_byType: WideString;
modified_byId: WideString;
modified_byName: WideString;
modified_byLogin: WideString;
owned_byType: WideString;
owned_byId: WideString;
owned_byName: WideString;
owned_byLogin: WideString;
shared_linkUrl: WideString;
shared_linkDownload_url: Integer;
shared_linkVanity_url: Integer;
shared_linkIs_password_enabled: Integer;
shared_linkUnshared_at: Integer;
shared_linkDownload_count: Integer;
shared_linkPreview_count: Integer;
shared_linkAccess: WideString;
shared_linkPermissionsCan_download: Integer;
shared_linkPermissionsCan_preview: Integer;
folder_upload_emailAccess: WideString;
folder_upload_emailEmail: WideString;
parentType: WideString;
parentId: WideString;
parentSequence_id: Integer;
parentEtag: Integer;
parentName: WideString;
item_status: WideString;
item_collectionTotal_count: Integer;
item_collectionOffset: Integer;
item_collectionLimit: Integer;
i: Integer;
count_i: Integer;
sequence_id_bool: Integer;
etag_bool: Integer;
sha1: WideString;

begin
rest := TChilkatRest.Create(Self);

//  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
bTls := 1;
port := 443;
bAutoReconnect := 1;
success := rest.Connect('api.box.com',port,bTls,bAutoReconnect);
if (success <> 1) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(rest.ConnectFailReason));
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

json := TChilkatJsonObject.Create(Self);
json.UpdateNumber('parent.id','DESTINATION_FOLDER_ID');

rest.AddHeader('Authorization','Bearer BOX_ACCESS_TOKEN');

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestSb('POST','/2.0/folders/FOLDER_ID/copy',sbRequestBody.ControlInterface,sbResponseBody.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

jsonResponse := TChilkatJsonObject.Create(Self);
jsonResponse.LoadSb(sbResponseBody.ControlInterface);

type := jsonResponse.StringOf('type');
id := jsonResponse.StringOf('id');
sequence_id := jsonResponse.StringOf('sequence_id');
etag := jsonResponse.StringOf('etag');
name := jsonResponse.StringOf('name');
created_at := jsonResponse.StringOf('created_at');
modified_at := jsonResponse.StringOf('modified_at');
description := jsonResponse.StringOf('description');
size := jsonResponse.IntOf('size');
path_collectionTotal_count := jsonResponse.IntOf('path_collection.total_count');
created_byType := jsonResponse.StringOf('created_by.type');
created_byId := jsonResponse.StringOf('created_by.id');
created_byName := jsonResponse.StringOf('created_by.name');
created_byLogin := jsonResponse.StringOf('created_by.login');
modified_byType := jsonResponse.StringOf('modified_by.type');
modified_byId := jsonResponse.StringOf('modified_by.id');
modified_byName := jsonResponse.StringOf('modified_by.name');
modified_byLogin := jsonResponse.StringOf('modified_by.login');
owned_byType := jsonResponse.StringOf('owned_by.type');
owned_byId := jsonResponse.StringOf('owned_by.id');
owned_byName := jsonResponse.StringOf('owned_by.name');
owned_byLogin := jsonResponse.StringOf('owned_by.login');
shared_linkUrl := jsonResponse.StringOf('shared_link.url');
shared_linkDownload_url := jsonResponse.IsNullOf('shared_link.download_url');
shared_linkVanity_url := jsonResponse.IsNullOf('shared_link.vanity_url');
shared_linkIs_password_enabled := jsonResponse.BoolOf('shared_link.is_password_enabled');
shared_linkUnshared_at := jsonResponse.IsNullOf('shared_link.unshared_at');
shared_linkDownload_count := jsonResponse.IntOf('shared_link.download_count');
shared_linkPreview_count := jsonResponse.IntOf('shared_link.preview_count');
shared_linkAccess := jsonResponse.StringOf('shared_link.access');
shared_linkPermissionsCan_download := jsonResponse.BoolOf('shared_link.permissions.can_download');
shared_linkPermissionsCan_preview := jsonResponse.BoolOf('shared_link.permissions.can_preview');
folder_upload_emailAccess := jsonResponse.StringOf('folder_upload_email.access');
folder_upload_emailEmail := jsonResponse.StringOf('folder_upload_email.email');
parentType := jsonResponse.StringOf('parent.type');
parentId := jsonResponse.StringOf('parent.id');
parentSequence_id := jsonResponse.IsNullOf('parent.sequence_id');
parentEtag := jsonResponse.IsNullOf('parent.etag');
parentName := jsonResponse.StringOf('parent.name');
item_status := jsonResponse.StringOf('item_status');
item_collectionTotal_count := jsonResponse.IntOf('item_collection.total_count');
item_collectionOffset := jsonResponse.IntOf('item_collection.offset');
item_collectionLimit := jsonResponse.IntOf('item_collection.limit');
i := 0;
count_i := jsonResponse.SizeOfArray('path_collection.entries');
while i < count_i do
  begin
    jsonResponse.I := i;
    type := jsonResponse.StringOf('path_collection.entries[i].type');
    id := jsonResponse.StringOf('path_collection.entries[i].id');
    sequence_id_bool := jsonResponse.IsNullOf('path_collection.entries[i].sequence_id');
    etag_bool := jsonResponse.IsNullOf('path_collection.entries[i].etag');
    name := jsonResponse.StringOf('path_collection.entries[i].name');
    i := i + 1;
  end;

i := 0;
count_i := jsonResponse.SizeOfArray('item_collection.entries');
while i < count_i do
  begin
    jsonResponse.I := i;
    type := jsonResponse.StringOf('item_collection.entries[i].type');
    id := jsonResponse.StringOf('item_collection.entries[i].id');
    sequence_id := jsonResponse.StringOf('item_collection.entries[i].sequence_id');
    etag := jsonResponse.StringOf('item_collection.entries[i].etag');
    sha1 := jsonResponse.StringOf('item_collection.entries[i].sha1');
    name := jsonResponse.StringOf('item_collection.entries[i].name');
    i := i + 1;
  end;

Sample JSON Response Body

{
  "type": "folder",
  "id": "11446498",
  "sequence_id": "1",
  "etag": "1",
  "name": "Pictures",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T11:15:04-08:00",
  "description": "Some pictures I took",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "0",
        "sequence_id": null,
        "etag": null,
        "name": "All Files"
      }
    ]
  },
  "created_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "modified_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "owned_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "shared_link": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "download_url": null,
    "vanity_url": null,
    "is_password_enabled": false,
    "unshared_at": null,
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_download": true,
      "can_preview": true
    }
  },
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Picture.k13sdz1@u.box.com"
  },
  "parent": {
    "type": "folder",
    "id": "0",
    "sequence_id": null,
    "etag": null,
    "name": "All Files"
  },
  "item_status": "active",
  "item_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "file",
        "id": "5000948880",
        "sequence_id": "3",
        "etag": "3",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
        "name": "tigers.jpeg"
      }
    ],
    "offset": 0,
    "limit": 100
  }
}