Lua Requires Chilkat v11.7.0+

Box: Find a File by Name Across All Folder Pages

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. Find one exact, case-sensitive filename in a parent folder selected by name, checking the item type and every page before using its ID.

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

Lua

local chilkat = require("chilkat")

-- Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
-- See Global Unlock Sample.
-- Guide: Box API Guide.

local 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.
local curl = chilkat.HttpCurl.new()
curl:set_var("access_token", "BOX_ACCESS_TOKEN")
curl:set_var("parent_name", "/")
-- Box's fixed root ID is an implementation detail; callers supply names.
curl:set_var("parent_id", "0")
local setupCommand = chilkat.StringBuilder.new()

-- Register findParent; registration sends no request.
setupCommand:set_string("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
local setupReplacements = setupCommand:replace("ACCESS_TOKEN", curl:get_var("access_token"))
success = curl:add_function("findParent", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register findFolder; registration sends no request.
setupCommand:set_string("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:get_var("access_token"))
success = curl:add_function("findFolder", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register findFile; registration sends no request.
setupCommand:set_string("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:get_var("access_token"))
success = curl:add_function("findFile", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register findDestination; registration sends no request.
setupCommand:set_string("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:get_var("access_token"))
success = curl:add_function("findDestination", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register getFileDetails; registration sends no request.
setupCommand:set_string("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:get_var("access_token"))
success = curl:add_function("getFileDetails", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register getEnterprise; registration sends no request.
setupCommand:set_string("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand:replace("ACCESS_TOKEN", curl:get_var("access_token"))
success = curl:add_function("getEnterprise", setupCommand:get_as_string())
if not success then
    print(curl.last_error_text)
    return
end

-- Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
-- when extracting each output, using the current value at that time.
success = curl:add_output2("findParent", "entries", "name", "{{parent_name}}", true, "id", "parent_id")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output2("findFolder", "entries", "name", "{{folder_name}}", true, "id", "folder_id")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output2("findFile", "entries", "name", "{{file_name}}", true, "id", "file_id")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output2("findDestination", "entries", "name", "{{destination_name}}", true, "id", "destination_id")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output("getFileDetails", "file_version.id", "file_version_id")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output("getFileDetails", "sha1", "file_sha1")
if not success then
    print(curl.last_error_text)
    return
end

success = curl:add_output("getEnterprise", "enterprise.id", "enterprise_id")
if not success then
    print(curl.last_error_text)
    return
end

-- 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.
local parentName = "/"
local folderName = "images"
if (curl:get_var("parent_name") ~= parentName) or ((parentName == "/") and (not curl:var_defined("parent_id"))) then
    curl:set_var("parent_name", parentName)
    curl:clear_var("parent_id")
    curl:clear_var("folder_id")
    curl:clear_var("file_id")
    curl:clear_var("file_version_id")
    curl:clear_var("file_sha1")
    if parentName == "/" then
        curl:set_var("parent_id", "0")
    end
end

if curl:get_var("folder_name") ~= folderName then
    curl:set_var("folder_name", folderName)
    curl:clear_var("folder_id")
    curl:clear_var("file_id")
    curl:clear_var("file_version_id")
    curl:clear_var("file_sha1")
end

curl:set_var("marker", "")
local page = chilkat.JsonObject.new()
local i = 0
local count = 0
local more = true
local nextMarker = ""
local authorizedCommand1 = chilkat.StringBuilder.new()
authorizedCommand1:set_string("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}}\"")
local headerReplacement1 = authorizedCommand1:replace("{{access_token}}", curl:get_var("access_token"))
local pageCommand = authorizedCommand1:get_as_string()
local wantedName = "penguins.jpg"
local fileId = ""
local matches = 0
while more do
    curl:clear_target_output("*")
    success = curl:do_your_thing(pageCommand)
    if (not success) or (curl.status_code ~= 200) then
        print("Box request failed. HTTP status: " .. curl.status_code)
        print("Failure reason: " .. curl.fail_reason)
        print(curl.response_body_str)
        return
    end

    success = curl:get_response_json(page)
    if not success then
        print(curl.last_error_text)
        return
    end

    count = page:size_of_array("entries")
    i = 0
    while i < count do
        page.i = i
        if (page:string_of("entries[i].type") == "file") and (page:string_of("entries[i].name") == wantedName) then
            fileId = page:string_of("entries[i].id")
            matches = matches + 1
        end

        i = i + 1
    end

    more = false
    if page:has_member("next_marker") then
        if not page:is_null_of("next_marker") then
            nextMarker = page:string_of("next_marker")
            if nextMarker ~= "" then
                if nextMarker == curl:get_var("marker") then
                    print("Box returned the same pagination marker; stopping.")
                    return
                end

                curl:set_var("marker", nextMarker)
                local authorizedCommand2 = chilkat.StringBuilder.new()
                authorizedCommand2:set_string("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}}\"")
                local headerReplacement2 = authorizedCommand2:replace("{{access_token}}", curl:get_var("access_token"))
                pageCommand = authorizedCommand2:get_as_string()
                more = true
            end
        end
    end
end

if matches ~= 1 then
    print("Expected exactly one matching file. Matches: " .. matches)
    return
end

curl:set_var("file_id", fileId)
print("File ID: " .. fileId)
curl:clear_target_output("*")
local authorizedCommand3 = chilkat.StringBuilder.new()
authorizedCommand3:set_string("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,type,name,parent,size\" -H \"Authorization: Bearer {{access_token}}\"")
local headerReplacement3 = authorizedCommand3:replace("{{access_token}}", curl:get_var("access_token"))
success = curl:do_your_thing(authorizedCommand3:get_as_string())
if (not success) or (curl.status_code ~= 200) then
    print("Box request failed. HTTP status: " .. curl.status_code)
    print("Failure reason: " .. curl.fail_reason)
    print(curl.response_body_str)
    return
end

print(curl.response_body_str)