C# Requires Chilkat v11.5.0+

Box: Set Up Reusable HttpCurl Requests and Outputs

See more Box Examples

One-time registration of six read-only intermediate requests and their outputs. Keep this HttpCurl object for later operations. Names select folders/files; IDs are resolved on demand. Changing an AddOutput2 name requires rebinding its literal filter and clearing affected cached IDs. Registration and ExaminePlan make no HTTP requests.

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

C#

bool success = false;

//  Requires Chilkat 11.5.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.
Chilkat.HttpCurl curl = new Chilkat.HttpCurl();
curl.SetVar("access_token","BOX_ACCESS_TOKEN");
curl.SetVar("parent_name","/");
curl.SetVar("folder_name","images");
curl.SetVar("file_name","penguins.jpg");
curl.SetVar("destination_name","archive");
//  Box's fixed root ID is an implementation detail; callers supply names.
curl.SetVar("parent_id","0");
Chilkat.StringBuilder setupCommand = new Chilkat.StringBuilder();
int setupReplacements;

//  Register findParent; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("findParent",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Register findFolder; registration sends no request.
setupCommand.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\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("findFolder",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Register findFile; registration sends no request.
setupCommand.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\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("findFile",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Register findDestination; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("findDestination",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Register getFileDetails; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("getFileDetails",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Register getEnterprise; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"));
success = curl.AddFunction("getEnterprise",setupCommand.GetAsString());
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

//  Initial name selections. AddOutput2 stores these WHERE values literally.
success = curl.AddOutput2("findParent","entries","name",curl.GetVar("parent_name"),true,"id","parent_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput2("findFolder","entries","name",curl.GetVar("folder_name"),true,"id","folder_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput2("findFile","entries","name",curl.GetVar("file_name"),true,"id","file_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput2("findDestination","entries","name",curl.GetVar("destination_name"),true,"id","destination_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput("getFileDetails","sha1","file_sha1");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id");
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    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.
//  Inspect a cold plan. No folder_id or file_id has been supplied.
Chilkat.JsonObject setupPlan = new Chilkat.JsonObject();
setupPlan.EmitCompact = false;
Chilkat.StringBuilder authorizedCommand1 = new Chilkat.StringBuilder();
authorizedCommand1.SetString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"qa_output/penguins.jpg\"");
int headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"));
success = curl.ExaminePlan(authorizedCommand1.GetAsString(),setupPlan);
if (success != true) {
    Debug.WriteLine(curl.LastErrorText);
    return;
}

Debug.WriteLine(setupPlan.Emit());
Debug.WriteLine("Keep this configured HttpCurl object for later operations.");