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

Objective-C Example

#import <CkoRest.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

CkoRest *rest = [[CkoRest alloc] init];
BOOL success;

//  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.box.com" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@%d",@"ConnectFailReason: ",[rest.ConnectFailReason intValue]);
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateNumber: @"parent.id" numericStr: @"DESTINATION_FOLDER_ID"];

[rest AddHeader: @"Authorization" value: @"Bearer BOX_ACCESS_TOKEN"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/2.0/folders/FOLDER_ID/copy" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
[jsonResponse LoadSb: sbResponseBody];

NSString *type = 0;
NSString *id = 0;
NSString *sequence_id = 0;
NSString *etag = 0;
NSString *name = 0;
NSString *created_at = 0;
NSString *modified_at = 0;
NSString *description = 0;
int size;
int path_collectionTotal_count;
NSString *created_byType = 0;
NSString *created_byId = 0;
NSString *created_byName = 0;
NSString *created_byLogin = 0;
NSString *modified_byType = 0;
NSString *modified_byId = 0;
NSString *modified_byName = 0;
NSString *modified_byLogin = 0;
NSString *owned_byType = 0;
NSString *owned_byId = 0;
NSString *owned_byName = 0;
NSString *owned_byLogin = 0;
NSString *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;
NSString *shared_linkAccess = 0;
BOOL shared_linkPermissionsCan_download;
BOOL shared_linkPermissionsCan_preview;
NSString *folder_upload_emailAccess = 0;
NSString *folder_upload_emailEmail = 0;
NSString *parentType = 0;
NSString *parentId = 0;
BOOL parentSequence_id;
BOOL parentEtag;
NSString *parentName = 0;
NSString *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;
NSString *sha1 = 0;

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"] intValue];
path_collectionTotal_count = [[jsonResponse IntOf: @"path_collection.total_count"] intValue];
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"] intValue];
shared_linkPreview_count = [[jsonResponse IntOf: @"shared_link.preview_count"] intValue];
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"] intValue];
item_collectionOffset = [[jsonResponse IntOf: @"item_collection.offset"] intValue];
item_collectionLimit = [[jsonResponse IntOf: @"item_collection.limit"] intValue];
i = 0;
count_i = [[jsonResponse SizeOfArray: @"path_collection.entries"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: 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"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: 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;
}

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