C Requires Chilkat v11.7.0+
C
Box: List All Files and Subfolders with 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. List every page of direct children using marker pagination. This does not recursively traverse subfolders.
See the Box API guide for setup and the complete workflow.
Chilkat C Downloads
#include <C_CkHttpCurl.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttpCurl curl;
HCkStringBuilder setupCommand;
int setupReplacements;
const char *parentName;
const char *folderName;
HCkJsonObject page;
int i;
int count;
BOOL more;
const char *nextMarker;
HCkStringBuilder authorizedCommand1;
int headerReplacement1;
const char *pageCommand;
HCkStringBuilder authorizedCommand2;
int headerReplacement2;
success = 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.
curl = CkHttpCurl_Create();
CkHttpCurl_SetVar(curl,"access_token","BOX_ACCESS_TOKEN");
CkHttpCurl_SetVar(curl,"parent_name","/");
// Box's fixed root ID is an implementation detail; callers supply names.
CkHttpCurl_SetVar(curl,"parent_id","0");
setupCommand = CkStringBuilder_Create();
// Register findParent; registration sends no request.
CkStringBuilder_SetString(setupCommand,"curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"findParent",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register findFolder; registration sends no request.
CkStringBuilder_SetString(setupCommand,"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 = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"findFolder",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register findFile; registration sends no request.
CkStringBuilder_SetString(setupCommand,"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 = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"findFile",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register findDestination; registration sends no request.
CkStringBuilder_SetString(setupCommand,"curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"findDestination",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register getFileDetails; registration sends no request.
CkStringBuilder_SetString(setupCommand,"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"getFileDetails",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register getEnterprise; registration sends no request.
CkStringBuilder_SetString(setupCommand,"curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = CkStringBuilder_Replace(setupCommand,"ACCESS_TOKEN",CkHttpCurl_getVar(curl,"access_token"));
success = CkHttpCurl_AddFunction(curl,"getEnterprise",CkStringBuilder_getAsString(setupCommand));
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
success = CkHttpCurl_AddOutput2(curl,"findParent","entries","name","{{parent_name}}",TRUE,"id","parent_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput2(curl,"findFolder","entries","name","{{folder_name}}",TRUE,"id","folder_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput2(curl,"findFile","entries","name","{{file_name}}",TRUE,"id","file_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput2(curl,"findDestination","entries","name","{{destination_name}}",TRUE,"id","destination_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput(curl,"getFileDetails","file_version.id","file_version_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput(curl,"getFileDetails","sha1","file_sha1");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
return;
}
success = CkHttpCurl_AddOutput(curl,"getEnterprise","enterprise.id","enterprise_id");
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
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.
parentName = "/";
folderName = "images";
if ((CkHttpCurl_getVar(curl,"parent_name") != parentName) || ((parentName == "/") && (CkHttpCurl_VarDefined(curl,"parent_id") == FALSE))) {
CkHttpCurl_SetVar(curl,"parent_name",parentName);
CkHttpCurl_ClearVar(curl,"parent_id");
CkHttpCurl_ClearVar(curl,"folder_id");
CkHttpCurl_ClearVar(curl,"file_id");
CkHttpCurl_ClearVar(curl,"file_version_id");
CkHttpCurl_ClearVar(curl,"file_sha1");
if (parentName == "/") {
CkHttpCurl_SetVar(curl,"parent_id","0");
}
}
if (CkHttpCurl_getVar(curl,"folder_name") != folderName) {
CkHttpCurl_SetVar(curl,"folder_name",folderName);
CkHttpCurl_ClearVar(curl,"folder_id");
CkHttpCurl_ClearVar(curl,"file_id");
CkHttpCurl_ClearVar(curl,"file_version_id");
CkHttpCurl_ClearVar(curl,"file_sha1");
}
CkHttpCurl_SetVar(curl,"marker","");
page = CkJsonObject_Create();
i = 0;
count = 0;
more = TRUE;
authorizedCommand1 = CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand1,"curl -X GET \"https://api.box.com/2.0/folders/{{folder_id}}/items?usemarker=true&limit=1000&fields=id,type,name\" -H \"Authorization: Bearer {{access_token}}\"");
headerReplacement1 = CkStringBuilder_Replace(authorizedCommand1,"{{access_token}}",CkHttpCurl_getVar(curl,"access_token"));
pageCommand = CkStringBuilder_getAsString(authorizedCommand1);
while ((more == TRUE)) {
CkHttpCurl_ClearTargetOutput(curl,"*");
success = CkHttpCurl_DoYourThing(curl,pageCommand);
if ((success != TRUE) || (CkHttpCurl_getStatusCode(curl) != 200)) {
printf("Box request failed. HTTP status: %d\n",CkHttpCurl_getStatusCode(curl));
printf("Failure reason: %d\n",CkHttpCurl_getFailReason(curl));
printf("%s\n",CkHttpCurl_responseBodyStr(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkJsonObject_Dispose(page);
CkStringBuilder_Dispose(authorizedCommand1);
return;
}
success = CkHttpCurl_GetResponseJson(curl,page);
if (success != TRUE) {
printf("%s\n",CkHttpCurl_lastErrorText(curl));
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkJsonObject_Dispose(page);
CkStringBuilder_Dispose(authorizedCommand1);
return;
}
count = CkJsonObject_SizeOfArray(page,"entries");
i = 0;
while (i < count) {
CkJsonObject_putI(page,i);
printf("%s %s %s\n",CkJsonObject_stringOf(page,"entries[i].type"),CkJsonObject_stringOf(page,"entries[i].id"),CkJsonObject_stringOf(page,"entries[i].name"));
i = i + 1;
}
more = FALSE;
if (CkJsonObject_HasMember(page,"next_marker") == TRUE) {
if (CkJsonObject_IsNullOf(page,"next_marker") == FALSE) {
nextMarker = CkJsonObject_stringOf(page,"next_marker");
if (nextMarker != "") {
if (nextMarker == CkHttpCurl_getVar(curl,"marker")) {
printf("Box returned the same pagination marker; stopping.\n");
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkJsonObject_Dispose(page);
CkStringBuilder_Dispose(authorizedCommand1);
return;
}
CkHttpCurl_SetVar(curl,"marker",nextMarker);
authorizedCommand2 = CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand2,"curl -X GET \"https://api.box.com/2.0/folders/{{folder_id}}/items?usemarker=true&limit=1000&fields=id,type,name&marker={{marker}}\" -H \"Authorization: Bearer {{access_token}}\"");
headerReplacement2 = CkStringBuilder_Replace(authorizedCommand2,"{{access_token}}",CkHttpCurl_getVar(curl,"access_token"));
pageCommand = CkStringBuilder_getAsString(authorizedCommand2);
more = TRUE;
}
}
}
}
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkJsonObject_Dispose(page);
CkStringBuilder_Dispose(authorizedCommand1);
CkStringBuilder_Dispose(authorizedCommand2);
}