Objective-C Requires Chilkat v11.7.0+

Box: Create a Project Folder, Upload, Tag, and Link a Document

See more Box Examples

Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Resolve the parent documents folder by name, create a new project folder, upload a document, apply pre-existing projectDocument metadata, and create a collaborators-only link. Creation outputs remain cached for subsequent operations; the engine resolves the enterprise scope only when metadata needs it. Multipart formatting and deliberate writes remain explicit.

See the Box API guide for setup and the complete workflow.

Objective-C

#import <CkoHttpCurl.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

BOOL success = NO;

//  Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
//  See Global Unlock Sample.
//  Guide: Box API Guide.

success = NO;

//  BEGIN ONE-TIME SETUP
//  This block is repeated so each published example can run on its own.
//  In an application, run the setup example once and pass the SAME curl object
//  to operation code below. Do not recreate it for every operation.
//  See Reusable Box HttpCurl Setup.
CkoHttpCurl *curl = [[CkoHttpCurl alloc] init];
[curl SetVar: @"access_token" varValue: @"BOX_ACCESS_TOKEN"];
[curl SetVar: @"parent_name" varValue: @"/"];
//  Box's fixed root ID is an implementation detail; callers supply names.
[curl SetVar: @"parent_id" varValue: @"0"];
CkoStringBuilder *setupCommand = [[CkoStringBuilder alloc] init];
int setupReplacements;

//  Register findParent; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findParent" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register findFolder; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findFolder" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register findFile; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findFile" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register findDestination; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findDestination" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register getFileDetails; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"getFileDetails" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register getEnterprise; registration sends no request.
[setupCommand SetString: @"curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\""];
setupReplacements = [[setupCommand Replace: @"ACCESS_TOKEN" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"getEnterprise" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
//  when extracting each output, using the current value at that time.
success = [curl AddOutput2: @"findParent" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{parent_name}}" caseSensitive: YES subPath: @"id" varName: @"parent_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findFolder" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{folder_name}}" caseSensitive: YES subPath: @"id" varName: @"folder_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findFile" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{file_name}}" caseSensitive: YES subPath: @"id" varName: @"file_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findDestination" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{destination_name}}" caseSensitive: YES subPath: @"id" varName: @"destination_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getFileDetails" jsonPath: @"file_version.id" varName: @"file_version_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getFileDetails" jsonPath: @"sha1" varName: @"file_sha1"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getEnterprise" jsonPath: @"enterprise.id" varName: @"enterprise_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

//  END ONE-TIME SETUP
//  The name lookups below assume each listing fits in one page (1000 items).
//  Parent and destination names select root children; folder_name selects a child
//  of parent_name. "/" selects the root parent. These are not arbitrary paths.

//  BEGIN OPERATION -- keep the configured object when reusing it.
//  Inputs are names. Retain cached IDs when the selected names have not changed.
NSString *parentName = @"documents";
if (([curl GetVar: @"parent_name"] != parentName) || ((parentName == @"/") && ([curl VarDefined: @"parent_id"] == NO))) {
    [curl SetVar: @"parent_name" varValue: parentName];
    [curl ClearVar: @"parent_id"];
    [curl ClearVar: @"folder_id"];
    [curl ClearVar: @"file_id"];
    [curl ClearVar: @"file_version_id"];
    [curl ClearVar: @"file_sha1"];
    if (parentName == @"/") {
        [curl SetVar: @"parent_id" varValue: @"0"];
    }

}

[curl SetVar: @"new_folder_name" varValue: @"Project CUST-1001"];
//  This workflow creates a new folder. A 409 stops the example; it does not
//  silently reuse a same-named folder. Retain printed IDs if a later step fails.
[curl ClearTargetOutput: @"*"];
[curl ClearVar: @"folder_id"];
[curl AddTargetOutput: @"id" varName: @"folder_id"];
CkoStringBuilder *authorizedCommand1 = [[CkoStringBuilder alloc] init];
[authorizedCommand1 SetString: @"curl -X POST \"https://api.box.com/2.0/folders\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"name\":\"{{new_folder_name}}\",\"parent\":{\"id\":\"{{parent_id}}\"}}'"];
int headerReplacement1 = [[authorizedCommand1 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand1 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 201)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

if ([curl VarDefined: @"!"] != YES) {
    NSLog(@"%@",@"Expected response fields are missing.");
    return;
}

NSLog(@"%@%@",@"Created folder: ",[curl GetVar: @"folder_id"]);
//  Resolve the multipart attributes field before passing the command to HttpCurl.
//  Box folder IDs come from configuration or a previous API response.
CkoStringBuilder *uploadCommand = [[CkoStringBuilder alloc] init];
CkoStringBuilder *authorizedCommand2 = [[CkoStringBuilder alloc] init];
[authorizedCommand2 SetString: @"curl -X POST \"https://upload.box.com/api/2.0/files/content\" -H \"Authorization: Bearer {{access_token}}\" -F 'attributes={\"name\":\"invoice.pdf\",\"parent\":{\"id\":\"{{folder_id}}\"}}' -F \"file=@qa_data/pdf/invoice.pdf;type=application/pdf\""];
int headerReplacement2 = [[authorizedCommand2 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
[uploadCommand SetString: [authorizedCommand2 GetAsString]];
int replacements = [[uploadCommand Replace: @"{{folder_id}}" replacement: [curl GetVar: @"folder_id"]] intValue];
[curl ClearTargetOutput: @"*"];
[curl ClearVar: @"file_id"];
[curl AddTargetOutput: @"entries[0].id" varName: @"file_id"];
success = [curl DoYourThing: [uploadCommand GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 201)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

if ([curl VarDefined: @"!"] != YES) {
    NSLog(@"%@",@"Expected response fields are missing.");
    return;
}

NSLog(@"%@%@",@"Uploaded file: ",[curl GetVar: @"file_id"]);
[curl ClearTargetOutput: @"*"];
CkoStringBuilder *authorizedCommand3 = [[CkoStringBuilder alloc] init];
[authorizedCommand3 SetString: @"curl -X POST \"https://api.box.com/2.0/files/{{file_id}}/metadata/enterprise_{{enterprise_id}}/projectDocument\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"customerId\":\"CUST-1001\",\"status\":\"received\"}'"];
int headerReplacement3 = [[authorizedCommand3 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand3 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 201)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

[curl ClearTargetOutput: @"*"];
[curl ClearVar: @"shared_url"];
[curl AddTargetOutput: @"shared_link.url" varName: @"shared_url"];
CkoStringBuilder *authorizedCommand4 = [[CkoStringBuilder alloc] init];
[authorizedCommand4 SetString: @"curl -X PUT \"https://api.box.com/2.0/files/{{file_id}}?fields=id,shared_link\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"shared_link\":{\"access\":\"collaborators\"}}'"];
int headerReplacement4 = [[authorizedCommand4 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand4 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 200)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

if ([curl VarDefined: @"!"] != YES) {
    NSLog(@"%@",@"Expected response fields are missing.");
    return;
}

NSLog(@"%@%@",@"Document link: ",[curl GetVar: @"shared_url"]);
//  The link is for existing collaborators. Invite users separately when needed.
//  ClearTargetOutput removes old extraction rules; it does not clear existing IDs.
[curl SetVar: @"folder_name" varValue: [curl GetVar: @"new_folder_name"]];
[curl SetVar: @"file_name" varValue: @"invoice.pdf"];
[curl ClearVar: @"file_version_id"];
[curl ClearVar: @"file_sha1"];