AutoIt 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.

AutoIt

Local $bSuccess = False

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

$bSuccess = 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.
$oCurl = ObjCreate("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 = ObjCreate("Chilkat.StringBuilder")
Local $iSetupReplacements

;  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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("findParent",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("findFolder",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("findFile",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("findDestination",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("getFileDetails",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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""")
$iSetupReplacements = $oSetupCommand.Replace("ACCESS_TOKEN",$oCurl.GetVar("access_token"))
$bSuccess = $oCurl.AddFunction("getEnterprise",$oSetupCommand.GetAsString())
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

;  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
;  when extracting each output, using the current value at that time.
$bSuccess = $oCurl.AddOutput2("findParent","entries","name","{{parent_name}}",True,"id","parent_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput2("findFolder","entries","name","{{folder_name}}",True,"id","folder_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput2("findFile","entries","name","{{file_name}}",True,"id","file_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput2("findDestination","entries","name","{{destination_name}}",True,"id","destination_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput("getFileDetails","file_version.id","file_version_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput("getFileDetails","sha1","file_sha1")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oCurl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
If ($bSuccess <> True) Then
    ConsoleWrite($oCurl.LastErrorText & @CRLF)
    Exit
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.
Local $sParentName = "/"
Local $sFolderName = "documents"
If (($oCurl.GetVar("parent_name") <> $sParentName) Or (($sParentName = "/") And ($oCurl.VarDefined("parent_id") = False))) Then
    $oCurl.SetVar "parent_name",$sParentName
    $oCurl.ClearVar "parent_id"
    $oCurl.ClearVar "folder_id"
    $oCurl.ClearVar "file_id"
    $oCurl.ClearVar "file_version_id"
    $oCurl.ClearVar "file_sha1"
    If ($sParentName = "/") Then
        $oCurl.SetVar "parent_id","0"
    EndIf

EndIf

If ($oCurl.GetVar("folder_name") <> $sFolderName) Then
    $oCurl.SetVar "folder_name",$sFolderName
    $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 = ObjCreate("Chilkat.JsonObject")
Local $sMarker
Local $bMore = True
$oAuthorizedCommand1 = ObjCreate("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}'")
Local $iHeaderReplacement1 = $oAuthorizedCommand1.Replace("{{access_token}}",$oCurl.GetVar("access_token"))
Local $sPageCommand = $oAuthorizedCommand1.GetAsString()
While $bMore = True
    $oCurl.ClearTargetOutput "*"
    $bSuccess = $oCurl.DoYourThing($sPageCommand)
    If (($bSuccess <> True) Or ($oCurl.StatusCode <> 200)) Then
        ConsoleWrite("Box request failed. HTTP status: " & $oCurl.StatusCode & @CRLF)
        ConsoleWrite("Failure reason: " & $oCurl.FailReason & @CRLF)
        ConsoleWrite($oCurl.ResponseBodyStr & @CRLF)
        Exit
    EndIf

    $bSuccess = $oCurl.GetResponseJson($oResult)
    If ($bSuccess <> True) Then
        ConsoleWrite($oCurl.LastErrorText & @CRLF)
        Exit
    EndIf

    ConsoleWrite($oResult.Emit() & @CRLF)
    $bMore = False
    If ($oResult.HasMember("next_marker") = True) Then
        If ($oResult.IsNullOf("next_marker") = False) Then
            $sMarker = $oResult.StringOf("next_marker")
            If ($sMarker <> "") Then
                If ($sMarker = $oCurl.GetVar("marker")) Then
                    ConsoleWrite("Repeated marker; stopping." & @CRLF)
                    Exit
                EndIf

                $oCurl.SetVar "marker",$sMarker
                $oAuthorizedCommand2 = ObjCreate("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}}""}'")
Local $iHeaderReplacement2 = $oAuthorizedCommand2.Replace("{{access_token}}",$oCurl.GetVar("access_token"))
                $sPageCommand = $oAuthorizedCommand2.GetAsString()
                $bMore = True
            EndIf

        EndIf

    EndIf

Wend