Ruby Requires Chilkat v11.7.0+

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.

Ruby

require 'chilkat'

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 = Chilkat::CkHttpCurl.new()
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")
setupCommand = Chilkat::CkStringBuilder.new()

#  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)
    print curl.lastErrorText() + "\n";
    exit
end

#  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)
    print curl.lastErrorText() + "\n";
    exit
end

#  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)
    print curl.lastErrorText() + "\n";
    exit
end

#  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)
    print curl.lastErrorText() + "\n";
    exit
end

#  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)
    print curl.lastErrorText() + "\n";
    exit
end

#  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)
    print curl.lastErrorText() + "\n";
    exit
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.AddOutput2("findParent","entries","name","{{parent_name}}",true,"id","parent_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",true,"id","folder_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findFile","entries","name","{{file_name}}",true,"id","file_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",true,"id","destination_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getFileDetails","sha1","file_sha1")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
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.
parentName = "/"
folderName = "documents"
if ((curl.getVar("parent_name") != parentName) or ((parentName == "/") and (curl.VarDefined("parent_id") == false)))
    curl.SetVar("parent_name",parentName)
    curl.ClearVar("parent_id")
    curl.ClearVar("folder_id")
    curl.ClearVar("file_id")
    curl.ClearVar("file_version_id")
    curl.ClearVar("file_sha1")
    if (parentName == "/")
        curl.SetVar("parent_id","0")
    end

end

if (curl.getVar("folder_name") != folderName)
    curl.SetVar("folder_name",folderName)
    curl.ClearVar("folder_id")
    curl.ClearVar("file_id")
    curl.ClearVar("file_version_id")
    curl.ClearVar("file_sha1")
end

curl.SetVar("customer_id","CUST-1001")
curl.SetVar("marker","")
result = Chilkat::CkJsonObject.new()

more = true
authorizedCommand1 = Chilkat::CkStringBuilder.new()
authorizedCommand1.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}'")
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.getVar("access_token"))
pageCommand = authorizedCommand1.getAsString()
while more == true
    curl.ClearTargetOutput("*")
    success = curl.DoYourThing(pageCommand)
    if ((success != true) or (curl.get_StatusCode() != 200))
        print "Box request failed. HTTP status: " + curl.get_StatusCode().to_s() + "\n";
        print "Failure reason: " + curl.get_FailReason().to_s() + "\n";
        print curl.responseBodyStr() + "\n";
        exit
    end

    success = curl.GetResponseJson(result)
    if (success != true)
        print curl.lastErrorText() + "\n";
        exit
    end

    print result.emit() + "\n";
    more = false
    if (result.HasMember("next_marker") == true)
        if (result.IsNullOf("next_marker") == false)
            marker = result.stringOf("next_marker")
            if (marker != "")
                if (marker == curl.getVar("marker"))
                    print "Repeated marker; stopping." + "\n";
                    exit
                end

                curl.SetVar("marker",marker)
                authorizedCommand2 = Chilkat::CkStringBuilder.new()
                authorizedCommand2.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}}\"}'")
                headerReplacement2 = authorizedCommand2.Replace("{{access_token}}",curl.getVar("access_token"))
                pageCommand = authorizedCommand2.getAsString()
                more = true
            end

        end

    end

end