Visual FoxPro 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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loCurl
LOCAL loSetupCommand
LOCAL lnSetupReplacements
LOCAL lcParentName
LOCAL lcFolderName
LOCAL loResult
LOCAL lcMarker
LOCAL lnMore
LOCAL loAuthorizedCommand1
LOCAL lnHeaderReplacement1
LOCAL lcPageCommand
LOCAL loAuthorizedCommand2
LOCAL lnHeaderReplacement2

lnSuccess = 0

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

lnSuccess = 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.
loCurl = CreateObject('Chilkat.HttpCurl')
loCurl.SetVar("access_token","BOX_ACCESS_TOKEN")
loCurl.SetVar("parent_name","/")
*  Box's fixed root ID is an implementation detail; callers supply names.
loCurl.SetVar("parent_id","0")
loSetupCommand = CreateObject('Chilkat.StringBuilder')

*  Register findParent; registration sends no request.
loSetupCommand.SetString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("findParent",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register findFolder; registration sends no request.
loSetupCommand.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"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("findFolder",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register findFile; registration sends no request.
loSetupCommand.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"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("findFile",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register findDestination; registration sends no request.
loSetupCommand.SetString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("findDestination",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register getFileDetails; registration sends no request.
loSetupCommand.SetString('curl -X GET "https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version" -H "Authorization: Bearer ACCESS_TOKEN"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("getFileDetails",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register getEnterprise; registration sends no request.
loSetupCommand.SetString('curl -X GET "https://api.box.com/2.0/users/me?fields=enterprise" -H "Authorization: Bearer ACCESS_TOKEN"')
lnSetupReplacements = loSetupCommand.Replace("ACCESS_TOKEN",loCurl.GetVar("access_token"))
lnSuccess = loCurl.AddFunction("getEnterprise",loSetupCommand.GetAsString())
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

*  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
*  when extracting each output, using the current value at that time.
lnSuccess = loCurl.AddOutput2("findParent","entries","name","{{parent_name}}",1,"id","parent_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput2("findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput2("findFile","entries","name","{{file_name}}",1,"id","file_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput2("findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput("getFileDetails","file_version.id","file_version_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput("getFileDetails","sha1","file_sha1")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
ENDIF

lnSuccess = loCurl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
IF (lnSuccess <> 1) THEN
    ? loCurl.LastErrorText
    RELEASE loCurl
    RELEASE loSetupCommand
    CANCEL
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.
lcParentName = "/"
lcFolderName = "documents"
IF ((loCurl.GetVar("parent_name") <> lcParentName) OR ((lcParentName = "/") AND (loCurl.VarDefined("parent_id") = 0))) THEN
    loCurl.SetVar("parent_name",lcParentName)
    loCurl.ClearVar("parent_id")
    loCurl.ClearVar("folder_id")
    loCurl.ClearVar("file_id")
    loCurl.ClearVar("file_version_id")
    loCurl.ClearVar("file_sha1")
    IF (lcParentName = "/") THEN
        loCurl.SetVar("parent_id","0")
    ENDIF

ENDIF

IF (loCurl.GetVar("folder_name") <> lcFolderName) THEN
    loCurl.SetVar("folder_name",lcFolderName)
    loCurl.ClearVar("folder_id")
    loCurl.ClearVar("file_id")
    loCurl.ClearVar("file_version_id")
    loCurl.ClearVar("file_sha1")
ENDIF

loCurl.SetVar("customer_id","CUST-1001")
loCurl.SetVar("marker","")
loResult = CreateObject('Chilkat.JsonObject')

lnMore = 1
loAuthorizedCommand1 = CreateObject('Chilkat.StringBuilder')
loAuthorizedCommand1.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}'')
lnHeaderReplacement1 = loAuthorizedCommand1.Replace("{{access_token}}",loCurl.GetVar("access_token"))
lcPageCommand = loAuthorizedCommand1.GetAsString()
DO WHILE lnMore = 1
    loCurl.ClearTargetOutput("*")
    lnSuccess = loCurl.DoYourThing(lcPageCommand)
    IF ((lnSuccess <> 1) OR (loCurl.StatusCode <> 200)) THEN
        ? "Box request failed. HTTP status: " + STR(loCurl.StatusCode)
        ? "Failure reason: " + STR(loCurl.FailReason)
        ? loCurl.ResponseBodyStr
        RELEASE loCurl
        RELEASE loSetupCommand
        RELEASE loResult
        RELEASE loAuthorizedCommand1
        CANCEL
    ENDIF

    lnSuccess = loCurl.GetResponseJson(loResult)
    IF (lnSuccess <> 1) THEN
        ? loCurl.LastErrorText
        RELEASE loCurl
        RELEASE loSetupCommand
        RELEASE loResult
        RELEASE loAuthorizedCommand1
        CANCEL
    ENDIF

    ? loResult.Emit()
    lnMore = 0
    IF (loResult.HasMember("next_marker") = 1) THEN
        IF (loResult.IsNullOf("next_marker") = 0) THEN
            lcMarker = loResult.StringOf("next_marker")
            IF (lcMarker <> "") THEN
                IF (lcMarker = loCurl.GetVar("marker")) THEN
                    ? "Repeated marker; stopping."
                    RELEASE loCurl
                    RELEASE loSetupCommand
                    RELEASE loResult
                    RELEASE loAuthorizedCommand1
                    CANCEL
                ENDIF

                loCurl.SetVar("marker",lcMarker)
                loAuthorizedCommand2 = CreateObject('Chilkat.StringBuilder')
                loAuthorizedCommand2.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}}"}'')
                lnHeaderReplacement2 = loAuthorizedCommand2.Replace("{{access_token}}",loCurl.GetVar("access_token"))
                lcPageCommand = loAuthorizedCommand2.GetAsString()
                lnMore = 1
            ENDIF

        ENDIF

    ENDIF

ENDDO

RELEASE loCurl
RELEASE loSetupCommand
RELEASE loResult
RELEASE loAuthorizedCommand1
RELEASE loAuthorizedCommand2