VBScript Requires Chilkat v11.7.0+

Box: Create a Project Folder, Upload, Tag, and Link a Document

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. Resolve the parent documents folder by name, create a new project folder, upload a document, apply pre-existing projectDocument metadata, and create a collaborators-only link. Creation outputs remain cached for subsequent operations; the engine resolves the enterprise scope only when metadata needs it. Multipart formatting and deliberate writes remain explicit.

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 = "documents"
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

curl.SetVar "new_folder_name","Project CUST-1001"
'  This workflow creates a new folder. A 409 stops the example; it does not
'  silently reuse a same-named folder. Retain printed IDs if a later step fails.
curl.ClearTargetOutput "*"
curl.ClearVar "folder_id"
curl.AddTargetOutput "id","folder_id"
set authorizedCommand1 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand1.SetString("curl -X POST ""https://api.box.com/2.0/folders"" -H ""Authorization: Bearer {{access_token}}"" -H ""Content-Type: application/json"" -d '{""name"":""{{new_folder_name}}"",""parent"":{""id"":""{{parent_id}}""}}'")
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"))
success = curl.DoYourThing(authorizedCommand1.GetAsString())
If ((success <> 1) Or (curl.StatusCode <> 201)) Then
    outFile.WriteLine("Box request failed. HTTP status: " & curl.StatusCode)
    outFile.WriteLine("Failure reason: " & curl.FailReason)
    outFile.WriteLine(curl.ResponseBodyStr)
    WScript.Quit
End If

If (curl.VarDefined("!") <> 1) Then
    outFile.WriteLine("Expected response fields are missing.")
    WScript.Quit
End If

outFile.WriteLine("Created folder: " & curl.GetVar("folder_id"))
'  Resolve the multipart attributes field before passing the command to HttpCurl.
'  Box folder IDs come from configuration or a previous API response.
set uploadCommand = CreateObject("Chilkat.StringBuilder")
set authorizedCommand2 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand2.SetString("curl -X POST ""https://upload.box.com/api/2.0/files/content"" -H ""Authorization: Bearer {{access_token}}"" -F 'attributes={""name"":""invoice.pdf"",""parent"":{""id"":""{{folder_id}}""}}' -F ""file=@qa_data/pdf/invoice.pdf;type=application/pdf""")
headerReplacement2 = authorizedCommand2.Replace("{{access_token}}",curl.GetVar("access_token"))
success = uploadCommand.SetString(authorizedCommand2.GetAsString())
replacements = uploadCommand.Replace("{{folder_id}}",curl.GetVar("folder_id"))
curl.ClearTargetOutput "*"
curl.ClearVar "file_id"
curl.AddTargetOutput "entries[0].id","file_id"
success = curl.DoYourThing(uploadCommand.GetAsString())
If ((success <> 1) Or (curl.StatusCode <> 201)) Then
    outFile.WriteLine("Box request failed. HTTP status: " & curl.StatusCode)
    outFile.WriteLine("Failure reason: " & curl.FailReason)
    outFile.WriteLine(curl.ResponseBodyStr)
    WScript.Quit
End If

If (curl.VarDefined("!") <> 1) Then
    outFile.WriteLine("Expected response fields are missing.")
    WScript.Quit
End If

outFile.WriteLine("Uploaded file: " & curl.GetVar("file_id"))
curl.ClearTargetOutput "*"
set authorizedCommand3 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand3.SetString("curl -X POST ""https://api.box.com/2.0/files/{{file_id}}/metadata/enterprise_{{enterprise_id}}/projectDocument"" -H ""Authorization: Bearer {{access_token}}"" -H ""Content-Type: application/json"" -d '{""customerId"":""CUST-1001"",""status"":""received""}'")
headerReplacement3 = authorizedCommand3.Replace("{{access_token}}",curl.GetVar("access_token"))
success = curl.DoYourThing(authorizedCommand3.GetAsString())
If ((success <> 1) Or (curl.StatusCode <> 201)) Then
    outFile.WriteLine("Box request failed. HTTP status: " & curl.StatusCode)
    outFile.WriteLine("Failure reason: " & curl.FailReason)
    outFile.WriteLine(curl.ResponseBodyStr)
    WScript.Quit
End If

curl.ClearTargetOutput "*"
curl.ClearVar "shared_url"
curl.AddTargetOutput "shared_link.url","shared_url"
set authorizedCommand4 = CreateObject("Chilkat.StringBuilder")
success = authorizedCommand4.SetString("curl -X PUT ""https://api.box.com/2.0/files/{{file_id}}?fields=id,shared_link"" -H ""Authorization: Bearer {{access_token}}"" -H ""Content-Type: application/json"" -d '{""shared_link"":{""access"":""collaborators""}}'")
headerReplacement4 = authorizedCommand4.Replace("{{access_token}}",curl.GetVar("access_token"))
success = curl.DoYourThing(authorizedCommand4.GetAsString())
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

If (curl.VarDefined("!") <> 1) Then
    outFile.WriteLine("Expected response fields are missing.")
    WScript.Quit
End If

outFile.WriteLine("Document link: " & curl.GetVar("shared_url"))
'  The link is for existing collaborators. Invite users separately when needed.
'  ClearTargetOutput removes old extraction rules; it does not clear existing IDs.
curl.SetVar "folder_name",curl.GetVar("new_folder_name")
curl.SetVar "file_name","invoice.pdf"
curl.ClearVar "file_version_id"
curl.ClearVar "file_sha1"

outFile.Close