PowerBuilder Requires Chilkat v11.7.0+

Box: Search Files with Offset 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. Search within a folder hierarchy. Box search is indexed and may lag recent changes; use returned upload IDs for immediate follow-up requests. Search uses offset pagination, not folder-list markers.

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

PowerBuilder

integer li_rc
long li_Success
oleobject loo_Curl
oleobject loo_SetupCommand
long li_SetupReplacements
string ls_ParentName
string ls_FolderName
oleobject loo_Page
oleobject loo_Number
long li_Offset
long li_Count
long li_PageLimit
long li_Total
long i
long li_More
oleobject loo_AuthorizedCommand1
long li_HeaderReplacement1

li_Success = 0

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

li_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.
loo_Curl = create oleobject
li_rc = loo_Curl.ConnectToNewObject("Chilkat.HttpCurl")
if li_rc < 0 then
    destroy loo_Curl
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Curl.SetVar("access_token","BOX_ACCESS_TOKEN")
loo_Curl.SetVar("parent_name","/")
//  Box's fixed root ID is an implementation detail; callers supply names.
loo_Curl.SetVar("parent_id","0")
loo_SetupCommand = create oleobject
li_rc = loo_SetupCommand.ConnectToNewObject("Chilkat.StringBuilder")

//  Register findParent; registration sends no request.
loo_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~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("findParent",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

//  Register findFolder; registration sends no request.
loo_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~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("findFolder",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

//  Register findFile; registration sends no request.
loo_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~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("findFile",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

//  Register findDestination; registration sends no request.
loo_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~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("findDestination",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

//  Register getFileDetails; registration sends no request.
loo_SetupCommand.SetString("curl -X GET ~"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version~" -H ~"Authorization: Bearer ACCESS_TOKEN~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("getFileDetails",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

//  Register getEnterprise; registration sends no request.
loo_SetupCommand.SetString("curl -X GET ~"https://api.box.com/2.0/users/me?fields=enterprise~" -H ~"Authorization: Bearer ACCESS_TOKEN~"")
li_SetupReplacements = loo_SetupCommand.Replace("ACCESS_TOKEN",loo_Curl.GetVar("access_token"))
li_Success = loo_Curl.AddFunction("getEnterprise",loo_SetupCommand.GetAsString())
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    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.
li_Success = loo_Curl.AddOutput2("findParent","entries","name","{{parent_name}}",1,"id","parent_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput2("findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput2("findFile","entries","name","{{file_name}}",1,"id","file_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput2("findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput("getFileDetails","file_version.id","file_version_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput("getFileDetails","sha1","file_sha1")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    return
end if

li_Success = loo_Curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
if li_Success <> 1 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_Curl
    destroy loo_SetupCommand
    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.
ls_ParentName = "/"
ls_FolderName = "images"
if (loo_Curl.GetVar("parent_name") <> ls_ParentName) OR ((ls_ParentName = "/") AND (loo_Curl.VarDefined("parent_id") = 0)) then
    loo_Curl.SetVar("parent_name",ls_ParentName)
    loo_Curl.ClearVar("parent_id")
    loo_Curl.ClearVar("folder_id")
    loo_Curl.ClearVar("file_id")
    loo_Curl.ClearVar("file_version_id")
    loo_Curl.ClearVar("file_sha1")
    if ls_ParentName = "/" then
        loo_Curl.SetVar("parent_id","0")
    end if

end if

if loo_Curl.GetVar("folder_name") <> ls_FolderName then
    loo_Curl.SetVar("folder_name",ls_FolderName)
    loo_Curl.ClearVar("folder_id")
    loo_Curl.ClearVar("file_id")
    loo_Curl.ClearVar("file_version_id")
    loo_Curl.ClearVar("file_sha1")
end if

loo_Curl.SetVar("query","penguins")
loo_Page = create oleobject
li_rc = loo_Page.ConnectToNewObject("Chilkat.JsonObject")

loo_Number = create oleobject
li_rc = loo_Number.ConnectToNewObject("Chilkat.StringBuilder")

li_Offset = 0

li_More = 1
do while li_More = 1
    loo_Number.Clear()
    loo_Number.AppendInt(li_Offset)
    loo_Curl.SetVar("offset",loo_Number.GetAsString())
    loo_Curl.ClearTargetOutput("*")
    loo_AuthorizedCommand1 = create oleobject
    li_rc = loo_AuthorizedCommand1.ConnectToNewObject("Chilkat.StringBuilder")

    loo_AuthorizedCommand1.SetString("curl -X GET ~"https://api.box.com/2.0/search?query={{query}}&type=file&ancestor_folder_ids={{folder_id}}&content_types=name&limit=100&offset={{offset}}~" -H ~"Authorization: Bearer {{access_token}}~"")
    li_HeaderReplacement1 = loo_AuthorizedCommand1.Replace("{{access_token}}",loo_Curl.GetVar("access_token"))
    li_Success = loo_Curl.DoYourThing(loo_AuthorizedCommand1.GetAsString())
    if (li_Success <> 1) OR (loo_Curl.StatusCode <> 200) then
        Write-Debug "Box request failed. HTTP status: " + string(loo_Curl.StatusCode)
        Write-Debug "Failure reason: " + string(loo_Curl.FailReason)
        Write-Debug loo_Curl.ResponseBodyStr
        destroy loo_Curl
        destroy loo_SetupCommand
        destroy loo_Page
        destroy loo_Number
        destroy loo_AuthorizedCommand1
        return
    end if

    li_Success = loo_Curl.GetResponseJson(loo_Page)
    if li_Success <> 1 then
        Write-Debug loo_Curl.LastErrorText
        destroy loo_Curl
        destroy loo_SetupCommand
        destroy loo_Page
        destroy loo_Number
        destroy loo_AuthorizedCommand1
        return
    end if

    li_Count = loo_Page.SizeOfArray("entries")
    i = 0
    do while i < li_Count
        loo_Page.I = i
        Write-Debug loo_Page.StringOf("entries[i].id") + " " + loo_Page.StringOf("entries[i].name")
        i = i + 1
    loop
    li_PageLimit = loo_Page.IntOf("limit")
    li_Total = loo_Page.IntOf("total_count")
    if li_PageLimit <= 0 then
        Write-Debug "Missing or invalid search page limit."
        destroy loo_Curl
        destroy loo_SetupCommand
        destroy loo_Page
        destroy loo_Number
        destroy loo_AuthorizedCommand1
        return
    end if

    li_Offset = li_Offset + li_PageLimit
    li_More = (li_Offset < li_Total) AND (li_Count > 0)
    if (li_More = 1) AND (li_Offset > 9999) then
        Write-Debug "Search offset limit reached; narrow the query or folder scope."
        destroy loo_Curl
        destroy loo_SetupCommand
        destroy loo_Page
        destroy loo_Number
        destroy loo_AuthorizedCommand1
        return
    end if

loop


destroy loo_Curl
destroy loo_SetupCommand
destroy loo_Page
destroy loo_Number
destroy loo_AuthorizedCommand1