Unicode C++ 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

Unicode C++ Example

#include <CkRestW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    CkRestW rest;
    bool success;

    //  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
    bool bTls = true;
    int port = 443;
    bool bAutoReconnect = true;
    success = rest.Connect(L"api.box.com",port,bTls,bAutoReconnect);
    if (success != true) {
        wprintf(L"ConnectFailReason: %d\n",rest.get_ConnectFailReason());
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    CkJsonObjectW json;
    json.UpdateNumber(L"parent.id",L"DESTINATION_FOLDER_ID");

    rest.AddHeader(L"Authorization",L"Bearer BOX_ACCESS_TOKEN");

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);
    CkStringBuilderW sbResponseBody;
    success = rest.FullRequestSb(L"POST",L"/2.0/folders/FOLDER_ID/copy",sbRequestBody,sbResponseBody);
    if (success != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    CkJsonObjectW jsonResponse;
    jsonResponse.LoadSb(sbResponseBody);

    const wchar_t *type = 0;
    const wchar_t *id = 0;
    const wchar_t *sequence_id = 0;
    const wchar_t *etag = 0;
    const wchar_t *name = 0;
    const wchar_t *created_at = 0;
    const wchar_t *modified_at = 0;
    const wchar_t *description = 0;
    int size;
    int path_collectionTotal_count;
    const wchar_t *created_byType = 0;
    const wchar_t *created_byId = 0;
    const wchar_t *created_byName = 0;
    const wchar_t *created_byLogin = 0;
    const wchar_t *modified_byType = 0;
    const wchar_t *modified_byId = 0;
    const wchar_t *modified_byName = 0;
    const wchar_t *modified_byLogin = 0;
    const wchar_t *owned_byType = 0;
    const wchar_t *owned_byId = 0;
    const wchar_t *owned_byName = 0;
    const wchar_t *owned_byLogin = 0;
    const wchar_t *shared_linkUrl = 0;
    bool shared_linkDownload_url;
    bool shared_linkVanity_url;
    bool shared_linkIs_password_enabled;
    bool shared_linkUnshared_at;
    int shared_linkDownload_count;
    int shared_linkPreview_count;
    const wchar_t *shared_linkAccess = 0;
    bool shared_linkPermissionsCan_download;
    bool shared_linkPermissionsCan_preview;
    const wchar_t *folder_upload_emailAccess = 0;
    const wchar_t *folder_upload_emailEmail = 0;
    const wchar_t *parentType = 0;
    const wchar_t *parentId = 0;
    bool parentSequence_id;
    bool parentEtag;
    const wchar_t *parentName = 0;
    const wchar_t *item_status = 0;
    int item_collectionTotal_count;
    int item_collectionOffset;
    int item_collectionLimit;
    int i;
    int count_i;
    bool sequence_id_bool;
    bool etag_bool;
    const wchar_t *sha1 = 0;

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

    i = 0;
    count_i = jsonResponse.SizeOfArray(L"item_collection.entries");
    while (i < count_i) {
        jsonResponse.put_I(i);
        type = jsonResponse.stringOf(L"item_collection.entries[i].type");
        id = jsonResponse.stringOf(L"item_collection.entries[i].id");
        sequence_id = jsonResponse.stringOf(L"item_collection.entries[i].sequence_id");
        etag = jsonResponse.stringOf(L"item_collection.entries[i].etag");
        sha1 = jsonResponse.stringOf(L"item_collection.entries[i].sha1");
        name = jsonResponse.stringOf(L"item_collection.entries[i].name");
        i = i + 1;
    }
    }

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
  }
}