Xbase++ Requires Chilkat v11.7.0+
Xbase++
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.
Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oCurl
LOCAL oSetupCommand
LOCAL nSetupReplacements
LOCAL cParentName
LOCAL cFolderName
LOCAL oResult
LOCAL cMarker
LOCAL nMore
LOCAL oAuthorizedCommand1
LOCAL nHeaderReplacement1
LOCAL cPageCommand
LOCAL oAuthorizedCommand2
LOCAL nHeaderReplacement2
nSuccess := 0
// Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
// See Global Unlock Sample.
// Guide: Box API Guide.
nSuccess := 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.
oCurl := CreateObject("Chilkat.HttpCurl")
oCurl:SetVar("access_token", "BOX_ACCESS_TOKEN")
oCurl:SetVar("parent_name", "/")
// Box's fixed root ID is an implementation detail; callers supply names.
oCurl:SetVar("parent_id", "0")
oSetupCommand := CreateObject("Chilkat.StringBuilder")
// Register findParent; registration sends no request.
oSetupCommand:SetString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("findParent", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register findFolder; registration sends no request.
oSetupCommand: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"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("findFolder", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register findFile; registration sends no request.
oSetupCommand: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"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("findFile", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register findDestination; registration sends no request.
oSetupCommand:SetString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("findDestination", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register getFileDetails; registration sends no request.
oSetupCommand:SetString('curl -X GET "https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version" -H "Authorization: Bearer ACCESS_TOKEN"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("getFileDetails", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register getEnterprise; registration sends no request.
oSetupCommand:SetString('curl -X GET "https://api.box.com/2.0/users/me?fields=enterprise" -H "Authorization: Bearer ACCESS_TOKEN"')
nSetupReplacements := oSetupCommand:Replace("ACCESS_TOKEN", oCurl:GetVar("access_token"))
nSuccess := oCurl:AddFunction("getEnterprise", oSetupCommand:GetAsString())
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
nSuccess := oCurl:AddOutput2("findParent", "entries", "name", "{{parent_name}}", 1, "id", "parent_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput2("findFolder", "entries", "name", "{{folder_name}}", 1, "id", "folder_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput2("findFile", "entries", "name", "{{file_name}}", 1, "id", "file_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput2("findDestination", "entries", "name", "{{destination_name}}", 1, "id", "destination_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput("getFileDetails", "file_version.id", "file_version_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput("getFileDetails", "sha1", "file_sha1")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
nSuccess := oCurl:AddOutput("getEnterprise", "enterprise.id", "enterprise_id")
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
RETURN
ENDIF
// 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.
cParentName := "/"
cFolderName := "documents"
IF ((oCurl:GetVar("parent_name") != cParentName) .OR. ((cParentName == "/") .AND. (oCurl:VarDefined("parent_id") == 0)))
oCurl:SetVar("parent_name", cParentName)
oCurl:ClearVar("parent_id")
oCurl:ClearVar("folder_id")
oCurl:ClearVar("file_id")
oCurl:ClearVar("file_version_id")
oCurl:ClearVar("file_sha1")
IF (cParentName == "/")
oCurl:SetVar("parent_id", "0")
ENDIF
ENDIF
IF (oCurl:GetVar("folder_name") != cFolderName)
oCurl:SetVar("folder_name", cFolderName)
oCurl:ClearVar("folder_id")
oCurl:ClearVar("file_id")
oCurl:ClearVar("file_version_id")
oCurl:ClearVar("file_sha1")
ENDIF
oCurl:SetVar("customer_id", "CUST-1001")
oCurl:SetVar("marker", "")
oResult := CreateObject("Chilkat.JsonObject")
nMore := 1
oAuthorizedCommand1 := CreateObject("Chilkat.StringBuilder")
oAuthorizedCommand1: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}'')
nHeaderReplacement1 := oAuthorizedCommand1:Replace("{{access_token}}", oCurl:GetVar("access_token"))
cPageCommand := oAuthorizedCommand1:GetAsString()
DO WHILE nMore == 1
oCurl:ClearTargetOutput("*")
nSuccess := oCurl:DoYourThing(cPageCommand)
IF ((nSuccess != 1) .OR. (oCurl:StatusCode != 200))
? "Box request failed. HTTP status: " + Str(oCurl:StatusCode)
? "Failure reason: " + Str(oCurl:FailReason)
? oCurl:ResponseBodyStr
oCurl:destroy()
oSetupCommand:destroy()
oResult:destroy()
oAuthorizedCommand1:destroy()
RETURN
ENDIF
nSuccess := oCurl:GetResponseJson(oResult)
IF (nSuccess != 1)
? oCurl:LastErrorText
oCurl:destroy()
oSetupCommand:destroy()
oResult:destroy()
oAuthorizedCommand1:destroy()
RETURN
ENDIF
? oResult:Emit()
nMore := 0
IF (oResult:HasMember("next_marker") == 1)
IF (oResult:IsNullOf("next_marker") == 0)
cMarker := oResult:StringOf("next_marker")
IF (cMarker != "")
IF (cMarker == oCurl:GetVar("marker"))
? "Repeated marker; stopping."
oCurl:destroy()
oSetupCommand:destroy()
oResult:destroy()
oAuthorizedCommand1:destroy()
RETURN
ENDIF
oCurl:SetVar("marker", cMarker)
oAuthorizedCommand2 := CreateObject("Chilkat.StringBuilder")
oAuthorizedCommand2: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}}"}'')
nHeaderReplacement2 := oAuthorizedCommand2:Replace("{{access_token}}", oCurl:GetVar("access_token"))
cPageCommand := oAuthorizedCommand2:GetAsString()
nMore := 1
ENDIF
ENDIF
ENDIF
ENDDO
oCurl:destroy()
oSetupCommand:destroy()
oResult:destroy()
oAuthorizedCommand1:destroy()
oAuthorizedCommand2:destroy()