Delphi DLL Requires Chilkat v11.7.0+

Box: Resolve Folder and File IDs with the HttpCurl Dependency Engine

See more Box Examples

Download images/penguins.jpg using search-based HttpCurl dependencies and one DoYourThing call. Register search requests/output rules once, then supply names. Search results must each contain exactly one item; exact names and immediate parent IDs are checked before saving the downloaded bytes. The candidate content is downloaded into memory before validation, so this example is for small files. Multiple results are rejected instead of paginated or silently choosing a candidate. Search indexing can delay visibility of newly created or renamed items.

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

Delphi DLL

var
success: Boolean;
curl: HCkHttpCurl;
setupCommand: HCkStringBuilder;
setupReplacements: Integer;
folderName: PWideChar;
fileName: PWideChar;
queryText: HCkStringBuilder;
localPath: PWideChar;
plan: HCkJsonObject;
authorizedCommand1: HCkStringBuilder;
headerReplacement1: Integer;
authorizedCommand2: HCkStringBuilder;
headerReplacement2: Integer;
contents: HCkBinData;

begin
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
//  Requires Chilkat 11.7.0. Registration sends no requests.
//  Run this once and keep the SAME HttpCurl object for later downloads.
//  This focused setup searches for a root folder and a file directly inside it.
curl := CkHttpCurl_Create();
CkHttpCurl_SetVar(curl,'access_token','BOX_ACCESS_TOKEN');
setupCommand := CkStringBuilder_Create();

//  searchFolder: Box searches names; quotes request a phrase match.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/search?query={{folder_query}}&type=folder&content_types=name&fields=id,type,name,parent&limit=2" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'searchFolder',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
//  Deferred selection: folder_name need not be set during setup.
success := CkHttpCurl_AddOutput2(curl,'searchFolder','entries','name','{{folder_name}}',True,'id','folder_id');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput2(curl,'searchFolder','entries','name','{{folder_name}}',True,'name','folder_result_name');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput2(curl,'searchFolder','entries','name','{{folder_name}}',True,'parent.id','folder_parent_id');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput(curl,'searchFolder','total_count','folder_search_count');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;

//  searchFile: Box searches names; quotes request a phrase match.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/search?query={{file_query}}&type=file&content_types=name&fields=id,type,name,parent&limit=2&ancestor_folder_ids={{folder_id}}" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'searchFile',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
//  Deferred selection: file_name need not be set during setup.
success := CkHttpCurl_AddOutput2(curl,'searchFile','entries','name','{{file_name}}',True,'id','file_id');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput2(curl,'searchFile','entries','name','{{file_name}}',True,'name','file_result_name');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput2(curl,'searchFile','entries','name','{{file_name}}',True,'parent.id','file_parent_id');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkHttpCurl_AddOutput(curl,'searchFile','total_count','file_search_count');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
//  END ONE-TIME SETUP
//  Search is indexed: newly uploaded/renamed items may not appear immediately.
//  Search matches phrases, not exact strings, and ancestor filtering includes
//  subfolders. The operation validates counts, exact names, and immediate parents.
//  limit=2 is enough to demonstrate an ambiguous search; total_count covers all
//  results, not just this page. This introductory example requires exactly one
//  search result at each step and does not select among multiple candidates.

//  BEGIN OPERATION -- use the previously configured object.
//  Human-readable inputs. No resource IDs are supplied by the caller.
folderName := 'images';
fileName := 'penguins.jpg';
//  Encode the quoted search queries separately from the literal output filters.
//  In this build, URL variable substitution does not encode '&' in a name.
queryText := CkStringBuilder_Create();
CkStringBuilder_SetString(queryText,'"');
CkStringBuilder_Append(queryText,folderName);
CkStringBuilder_Append(queryText,'"');
CkHttpCurl_SetVar(curl,'folder_query',CkStringBuilder__getEncoded(queryText,'url','utf-8'));
CkStringBuilder_SetString(queryText,'"');
CkStringBuilder_Append(queryText,fileName);
CkStringBuilder_Append(queryText,'"');
CkHttpCurl_SetVar(curl,'file_query',CkStringBuilder__getEncoded(queryText,'url','utf-8'));
if (CkHttpCurl__getVar(curl,'folder_name') <> folderName) then
  begin
    CkHttpCurl_ClearVar(curl,'folder_id');
    CkHttpCurl_ClearVar(curl,'folder_result_name');
    CkHttpCurl_ClearVar(curl,'folder_parent_id');
    CkHttpCurl_ClearVar(curl,'folder_search_count');
    CkHttpCurl_ClearVar(curl,'file_id');
    CkHttpCurl_ClearVar(curl,'file_result_name');
    CkHttpCurl_ClearVar(curl,'file_parent_id');
    CkHttpCurl_ClearVar(curl,'file_search_count');
    CkHttpCurl_SetVar(curl,'folder_name',folderName);
  end;
if (CkHttpCurl__getVar(curl,'file_name') <> fileName) then
  begin
    CkHttpCurl_ClearVar(curl,'file_id');
    CkHttpCurl_ClearVar(curl,'file_result_name');
    CkHttpCurl_ClearVar(curl,'file_parent_id');
    CkHttpCurl_ClearVar(curl,'file_search_count');
    CkHttpCurl_SetVar(curl,'file_name',fileName);
  end;
//  With unchanged names, cached IDs and validation fields can be reused.
//  Clear the corresponding cached fields to refresh after a remote rename/move.
localPath := 'qa_output/penguins.jpg';
//  A cold plan is searchFolder -> searchFile -> targetCurl.
//  No listing endpoint or manual search call is used.
plan := CkJsonObject_Create();
CkJsonObject_putEmitCompact(plan,False);
authorizedCommand1 := CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand1,'curl -X GET "https://api.box.com/2.0/files/{{file_id}}/content" -H "Authorization: Bearer {{access_token}}" -L');
headerReplacement1 := CkStringBuilder_Replace(authorizedCommand1,'{{access_token}}',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_ExaminePlan(curl,CkStringBuilder__getAsString(authorizedCommand1),plan);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
Memo1.Lines.Add(CkJsonObject__emit(plan));
//  Keep the candidate download in memory; do not write an unvalidated result.
CkHttpCurl_putResponseFilePath(curl,'');
CkHttpCurl_ClearTargetOutput(curl,'*');
authorizedCommand2 := CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand2,'curl -X GET "https://api.box.com/2.0/files/{{file_id}}/content" -H "Authorization: Bearer {{access_token}}" -L');
headerReplacement2 := CkStringBuilder_Replace(authorizedCommand2,'{{access_token}}',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_DoYourThing(curl,CkStringBuilder__getAsString(authorizedCommand2));
if ((success <> True) or (CkHttpCurl_getStatusCode(curl) <> 200)) then
  begin
    Memo1.Lines.Add('Box request failed. HTTP status: ' + IntToStr(CkHttpCurl_getStatusCode(curl)));
    Memo1.Lines.Add('Failure reason: ' + IntToStr(CkHttpCurl_getFailReason(curl)));
    Exit;
  end;
//  AddOutput2 supplies candidate IDs. Box's phrase search and recursive
//  ancestor filter are not an exact path lookup, so validate before saving.
if ((CkHttpCurl__getVar(curl,'folder_search_count') <> '1') or (CkHttpCurl__getVar(curl,'file_search_count') <> '1')) then
  begin
    Memo1.Lines.Add('Search was ambiguous or incomplete. Expected exactly one result per search; no file was saved.');
    Memo1.Lines.Add('Folder results: ' + CkHttpCurl__getVar(curl,'folder_search_count') + ' File results: ' + CkHttpCurl__getVar(curl,'file_search_count'));
    CkHttpCurl_ClearVar(curl,'folder_id');
    CkHttpCurl_ClearVar(curl,'folder_result_name');
    CkHttpCurl_ClearVar(curl,'folder_parent_id');
    CkHttpCurl_ClearVar(curl,'folder_search_count');
    CkHttpCurl_ClearVar(curl,'file_id');
    CkHttpCurl_ClearVar(curl,'file_result_name');
    CkHttpCurl_ClearVar(curl,'file_parent_id');
    CkHttpCurl_ClearVar(curl,'file_search_count');
    Exit;
  end;
if ((CkHttpCurl__getVar(curl,'folder_result_name') <> folderName) or (CkHttpCurl__getVar(curl,'folder_parent_id') <> '0') or (CkHttpCurl__getVar(curl,'file_result_name') <> fileName) or (CkHttpCurl__getVar(curl,'file_parent_id') <> CkHttpCurl__getVar(curl,'folder_id'))) then
  begin
    Memo1.Lines.Add('The search result is not the exact root-folder/filename requested; no file was saved.');
    CkHttpCurl_ClearVar(curl,'folder_id');
    CkHttpCurl_ClearVar(curl,'folder_result_name');
    CkHttpCurl_ClearVar(curl,'folder_parent_id');
    CkHttpCurl_ClearVar(curl,'folder_search_count');
    CkHttpCurl_ClearVar(curl,'file_id');
    CkHttpCurl_ClearVar(curl,'file_result_name');
    CkHttpCurl_ClearVar(curl,'file_parent_id');
    CkHttpCurl_ClearVar(curl,'file_search_count');
    Exit;
  end;
//  Validation is after the network download but before writing the destination.
//  This in-memory example is intended for small files such as penguins.jpg.
//  Create qa_output before running it.
contents := CkBinData_Create();
success := CkHttpCurl_GetResponseBd(curl,contents);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
    Exit;
  end;
success := CkBinData_WriteFile(contents,localPath);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkBinData__lastErrorText(contents));
    Exit;
  end;
Memo1.Lines.Add('Downloaded to ' + localPath);

CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkStringBuilder_Dispose(queryText);
CkJsonObject_Dispose(plan);
CkStringBuilder_Dispose(authorizedCommand1);
CkStringBuilder_Dispose(authorizedCommand2);
CkBinData_Dispose(contents);