Zig Requires Chilkat v11.7.0+
Zig
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.
Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
var success: bool = false;
// Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
// See Global Unlock Sample.
// Guide: Box API Guide.
success = false;
// 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.
const curl = try chilkat.HttpCurl.init();
defer curl.deinit();
curl.setVar("access_token", "BOX_ACCESS_TOKEN");
curl.setVar("parent_name", "/");
// Box's fixed root ID is an implementation detail; callers supply names.
curl.setVar("parent_id", "0");
const setup_command = try chilkat.StringBuilder.init();
defer setup_command.deinit();
var setup_replacements: i32 = 0;
// Register findParent; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findParent", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findFolder; registration sends no request.
setup_command.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\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findFolder", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findFile; registration sends no request.
setup_command.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\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findFile", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findDestination; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findDestination", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register getFileDetails; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("getFileDetails", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register getEnterprise; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("getEnterprise", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
success = if (curl.addOutput2("findParent", "entries", "name", "{{parent_name}}", true, "id", "parent_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findFolder", "entries", "name", "{{folder_name}}", true, "id", "folder_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findFile", "entries", "name", "{{file_name}}", true, "id", "file_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findDestination", "entries", "name", "{{destination_name}}", true, "id", "destination_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getFileDetails", "file_version.id", "file_version_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getFileDetails", "sha1", "file_sha1")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getEnterprise", "enterprise.id", "enterprise_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
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.
const parent_name = "documents";
if ((!std.mem.eql(u8, try curl.getVar(alloc, "parent_name"), parent_name)) or ((std.mem.eql(u8, parent_name, "/")) and (!curl.varDefined("parent_id")))) {
curl.setVar("parent_name", parent_name);
curl.clearVar("parent_id");
curl.clearVar("folder_id");
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
if (std.mem.eql(u8, parent_name, "/")) {
curl.setVar("parent_id", "0");
}
}
curl.setVar("new_folder_name", "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", "folder_id");
const authorized_command1 = try chilkat.StringBuilder.init();
defer authorized_command1.deinit();
authorized_command1.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}}\"}}'") catch {};
_ = authorized_command1.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command1.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 201)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
if (!curl.varDefined("!")) {
std.debug.print("Expected response fields are missing.\n", .{});
return;
}
std.debug.print("Created folder: {s}\n", .{try curl.getVar(alloc, "folder_id")});
// Resolve the multipart attributes field before passing the command to HttpCurl.
// Box folder IDs come from configuration or a previous API response.
const upload_command = try chilkat.StringBuilder.init();
defer upload_command.deinit();
const authorized_command2 = try chilkat.StringBuilder.init();
defer authorized_command2.deinit();
authorized_command2.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\"") catch {};
_ = authorized_command2.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
upload_command.setString(try authorized_command2.getAsString(alloc)) catch {};
_ = upload_command.replace("{{folder_id}}", try curl.getVar(alloc, "folder_id"));
curl.clearTargetOutput("*");
curl.clearVar("file_id");
curl.addTargetOutput("entries[0].id", "file_id");
success = if (curl.doYourThing(try upload_command.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 201)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
if (!curl.varDefined("!")) {
std.debug.print("Expected response fields are missing.\n", .{});
return;
}
std.debug.print("Uploaded file: {s}\n", .{try curl.getVar(alloc, "file_id")});
curl.clearTargetOutput("*");
const authorized_command3 = try chilkat.StringBuilder.init();
defer authorized_command3.deinit();
authorized_command3.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\"}'") catch {};
_ = authorized_command3.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command3.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 201)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
curl.clearTargetOutput("*");
curl.clearVar("shared_url");
curl.addTargetOutput("shared_link.url", "shared_url");
const authorized_command4 = try chilkat.StringBuilder.init();
defer authorized_command4.deinit();
authorized_command4.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\"}}'") catch {};
_ = authorized_command4.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command4.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 200)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
if (!curl.varDefined("!")) {
std.debug.print("Expected response fields are missing.\n", .{});
return;
}
std.debug.print("Document link: {s}\n", .{try curl.getVar(alloc, "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", try curl.getVar(alloc, "new_folder_name"));
curl.setVar("file_name", "invoice.pdf");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
}