Zig Requires Chilkat v11.7.0+
Zig
Box: Search Files with Offset Pagination
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. Search within a folder hierarchy. Box search is indexed and may lag recent changes; use returned upload IDs for immediate follow-up requests. Search uses offset pagination, not folder-list markers.
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 = "/";
const folder_name = "images";
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");
}
}
if (!std.mem.eql(u8, try curl.getVar(alloc, "folder_name"), folder_name)) {
curl.setVar("folder_name", folder_name);
curl.clearVar("folder_id");
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
}
curl.setVar("query", "penguins");
const page = try chilkat.JsonObject.init();
defer page.deinit();
const number = try chilkat.StringBuilder.init();
defer number.deinit();
var offset: i32 = 0;
var count: i32 = 0;
var page_limit: i32 = 0;
var total: i32 = 0;
var i: i32 = 0;
var more: bool = true;
while (more) {
number.clear();
number.appendInt(offset) catch {};
curl.setVar("offset", try number.getAsString(alloc));
curl.clearTargetOutput("*");
const authorized_command1 = try chilkat.StringBuilder.init();
defer authorized_command1.deinit();
authorized_command1.setString("curl -X GET \"https://api.box.com/2.0/search?query={{query}}&type=file&ancestor_folder_ids={{folder_id}}&content_types=name&limit=100&offset={{offset}}\" -H \"Authorization: Bearer {{access_token}}\"") 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() != 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;
}
curl.getResponseJson(page) catch {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
};
count = page.sizeOfArray("entries");
i = 0;
while (i < count) {
page.setI(i);
std.debug.print("{s} {s}\n", .{ try page.stringOf(alloc, "entries[i].id"), try page.stringOf(alloc, "entries[i].name") });
i = i + 1;
}
page_limit = page.intOf("limit");
total = page.intOf("total_count");
if (page_limit <= 0) {
std.debug.print("Missing or invalid search page limit.\n", .{});
return;
}
offset = offset + page_limit;
more = (offset < total) and (count > 0);
if ((more) and (offset > 9999)) {
std.debug.print("Search offset limit reached; narrow the query or folder scope.\n", .{});
return;
}
}
}