Xojo Plugin 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.

Xojo Plugin

Dim success As Boolean
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.
Dim curl As New Chilkat.HttpCurl
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"
Dim setupCommand As New Chilkat.StringBuilder
Dim setupReplacements As Int32

//  Register findParent; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  Register findFolder; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  Register findFile; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  Register findDestination; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  Register getFileDetails; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  Register getEnterprise; registration sends no request.
success = 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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  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) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",True,"id","folder_id")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput2("findFile","entries","name","{{file_name}}",True,"id","file_id")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",True,"id","destination_id")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput("getFileDetails","sha1","file_sha1")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
If (success <> True) Then
    System.DebugLog(curl.LastErrorText)
    Return
End If

//  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.
Dim parentName As String
parentName = "/"
Dim folderName As String
folderName = "documents"
If ((curl.GetVar("parent_name") <> parentName) Or ((parentName = "/") And (curl.VarDefined("parent_id") = False))) Then
    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 = "/") Then
        curl.SetVar "parent_id","0"
    End If

End If

If (curl.GetVar("folder_name") <> folderName) Then
    curl.SetVar "folder_name",folderName
    curl.ClearVar "folder_id"
    curl.ClearVar "file_id"
    curl.ClearVar "file_version_id"
    curl.ClearVar "file_sha1"
End If

curl.SetVar "customer_id","CUST-1001"
curl.SetVar "marker",""
Dim result As New Chilkat.JsonObject
Dim marker As String
Dim more As Boolean
more = True
Dim authorizedCommand1 As New Chilkat.StringBuilder
success = 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}'")
Dim headerReplacement1 As Int32
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"))
Dim pageCommand As String
pageCommand = authorizedCommand1.GetAsString()
While more = True
    curl.ClearTargetOutput "*"
    success = curl.DoYourThing(pageCommand)
    If ((success <> True) Or (curl.StatusCode <> 200)) Then
        System.DebugLog("Box request failed. HTTP status: " + Str(curl.StatusCode))
        System.DebugLog("Failure reason: " + Str(curl.FailReason))
        System.DebugLog(curl.ResponseBodyStr)
        Return
    End If

    success = curl.GetResponseJson(result)
    If (success <> True) Then
        System.DebugLog(curl.LastErrorText)
        Return
    End If

    System.DebugLog(result.Emit())
    more = False
    If (result.HasMember("next_marker") = True) Then
        If (result.IsNullOf("next_marker") = False) Then
            marker = result.StringOf("next_marker")
            If (marker <> "") Then
                If (marker = curl.GetVar("marker")) Then
                    System.DebugLog("Repeated marker; stopping.")
                    Return
                End If

                curl.SetVar "marker",marker
                Dim authorizedCommand2 As New Chilkat.StringBuilder
                success = 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}}""}'")
                Dim headerReplacement2 As Int32
                headerReplacement2 = authorizedCommand2.Replace("{{access_token}}",curl.GetVar("access_token"))
                pageCommand = authorizedCommand2.GetAsString()
                more = True
            End If

        End If

    End If

Wend