Android™ 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

Android™ Example

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    CkRest rest = new CkRest();
    boolean success;

    //  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
    boolean bTls = true;
    int port = 443;
    boolean bAutoReconnect = true;
    success = rest.Connect("api.box.com",port,bTls,bAutoReconnect);
    if (success != true) {
        Log.i(TAG, "ConnectFailReason: " + String.valueOf(rest.get_ConnectFailReason()));
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    CkJsonObject json = new CkJsonObject();
    json.UpdateNumber("parent.id","DESTINATION_FOLDER_ID");

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

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    json.EmitSb(sbRequestBody);
    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = rest.FullRequestSb("POST","/2.0/folders/FOLDER_ID/copy",sbRequestBody,sbResponseBody);
    if (success != true) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    CkJsonObject jsonResponse = new CkJsonObject();
    jsonResponse.LoadSb(sbResponseBody);

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

    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) {
        jsonResponse.put_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;
        }

    i = 0;
    count_i = jsonResponse.SizeOfArray("item_collection.entries");
    while (i < count_i) {
        jsonResponse.put_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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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