VBScript Requires Chilkat v11.7.0+

Box: List All Files and Subfolders with Pagination

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. List every page of direct children using marker pagination. This does not recursively traverse subfolders.

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

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

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

success = 0

'  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.
set curl = CreateObject("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"
set setupCommand = CreateObject("Chilkat.StringBuilder")

'  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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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}}",1,"id","parent_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput2("findFile","entries","name","{{file_name}}",1,"id","file_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput("getFileDetails","sha1","file_sha1")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
End If

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
If (success <> 1) Then
    outFile.WriteLine(curl.LastErrorText)
    WScript.Quit
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.
parentName = "/"
folderName = "images"
If ((curl.GetVar("parent_name") <> parentName) Or ((parentName = "/") And (curl.VarDefined("parent_id") = 0))) 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 "marker",""
set page = CreateObject("Chilkat.JsonObject")
i = 0
count = 0
more = 1

set authorizedCommand1 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand1.SetString("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}}""")
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"))
pageCommand = authorizedCommand1.GetAsString()
Do While (more = 1)
    curl.ClearTargetOutput "*"
    success = curl.DoYourThing(pageCommand)
    If ((success <> 1) Or (curl.StatusCode <> 200)) Then
        outFile.WriteLine("Box request failed. HTTP status: " & curl.StatusCode)
        outFile.WriteLine("Failure reason: " & curl.FailReason)
        outFile.WriteLine(curl.ResponseBodyStr)
        WScript.Quit
    End If

    success = curl.GetResponseJson(page)
    If (success <> 1) Then
        outFile.WriteLine(curl.LastErrorText)
        WScript.Quit
    End If

    count = page.SizeOfArray("entries")
    i = 0
    Do While i < count
        page.I = i
        outFile.WriteLine(page.StringOf("entries[i].type") & " " & page.StringOf("entries[i].id") & " " & page.StringOf("entries[i].name"))
        i = i + 1
    Loop
    more = 0
    If (page.HasMember("next_marker") = 1) Then
        If (page.IsNullOf("next_marker") = 0) Then
            nextMarker = page.StringOf("next_marker")
            If (nextMarker <> "") Then
                If (nextMarker = curl.GetVar("marker")) Then
                    outFile.WriteLine("Box returned the same pagination marker; stopping.")
                    WScript.Quit
                End If

                curl.SetVar "marker",nextMarker
                set authorizedCommand2 = CreateObject("Chilkat.StringBuilder")
                success = authorizedCommand2.SetString("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}}""")
                headerReplacement2 = authorizedCommand2.Replace("{{access_token}}",curl.GetVar("access_token"))
                pageCommand = authorizedCommand2.GetAsString()
                more = 1
            End If

        End If

    End If

Loop

outFile.Close