Zig Requires Chilkat v11.7.0+
Zig
Box: Query Documents by Customer Metadata
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. Query the projectDocument enterprise template using a parameterized customer ID and marker pagination. Requires the template and access to matching content; metadata queries are distinct from full-text search. The enterprise scope ID is resolved from the current user profile; enterprise membership and the pre-existing template are required.
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 = "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");
}
}
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("customer_id", "CUST-1001");
curl.setVar("marker", "");
const result = try chilkat.JsonObject.init();
defer result.deinit();
var marker: [:0]const u8 = "";
var more: bool = true;
const authorized_command1 = try chilkat.StringBuilder.init();
defer authorized_command1.deinit();
authorized_command1.setString("curl -X POST \"https://api.box.com/2.0/metadata_queries/execute\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"from\":\"enterprise_{{enterprise_id}}.projectDocument\",\"ancestor_folder_id\":\"{{folder_id}}\",\"query\":\"customerId = :customer\",\"query_params\":{\"customer\":\"{{customer_id}}\"},\"limit\":100}'") catch {};
_ = authorized_command1.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
var page_command: [:0]const u8 = try authorized_command1.getAsString(alloc);
while (more) {
curl.clearTargetOutput("*");
success = if (curl.doYourThing(page_command)) 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(result) catch {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
};
std.debug.print("{s}\n", .{try result.emit(alloc)});
more = false;
if (result.hasMember("next_marker")) {
if (!result.isNullOf("next_marker")) {
marker = try result.stringOf(alloc, "next_marker");
if (!std.mem.eql(u8, marker, "")) {
if (std.mem.eql(u8, marker, try curl.getVar(alloc, "marker"))) {
std.debug.print("Repeated marker; stopping.\n", .{});
return;
}
curl.setVar("marker", marker);
const authorized_command2 = try chilkat.StringBuilder.init();
defer authorized_command2.deinit();
authorized_command2.setString("curl -X POST \"https://api.box.com/2.0/metadata_queries/execute\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"from\":\"enterprise_{{enterprise_id}}.projectDocument\",\"ancestor_folder_id\":\"{{folder_id}}\",\"query\":\"customerId = :customer\",\"query_params\":{\"customer\":\"{{customer_id}}\"},\"limit\":100,\"marker\":\"{{marker}}\"}'") catch {};
_ = authorized_command2.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
page_command = try authorized_command2.getAsString(alloc);
more = true;
}
}
}
}
}