(Tcl) OneDrive -- Search for Files

See more OneDrive Examples

Search for files within a hierarchy of items for items matching a query. You can search within a folder hierarhcy or a whole drive.

Note: This example requires Chilkat v9.5.0.97 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Use your client ID, client secret, and tenant ID in the following lines
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "client_id" "2871da2c-8176-4b7f-869b-2311aa82e743"
CkJsonObject_UpdateString $json "client_secret" "2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH"
CkJsonObject_UpdateString $json "scope" "https://graph.microsoft.com/.default"
CkJsonObject_UpdateString $json "token_endpoint" "https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token"

set http [new_CkHttp]

CkHttp_put_AuthToken $http [CkJsonObject_emit $json]

# Sends the following GET request:

# Search the entire drive like this:
# If not using "me", then the path should be /v1.0/users/{id | userPrincipalName}/...
# GET /v1.0/users/{user-id}/drive/root/search(q='{search-text}')

# Or search under a particular folder like this:
# GET /v1.0/users/{user-id}/drive/root:/{item-path}:/search(q='{search-text}')

# This example will search for files in or under the "/Misc" directory, having "penguin" in the file path.
CkHttp_SetUrlVar $http "item_path" "/Misc"
CkHttp_SetUrlVar $http "search_text" "penguins"
CkHttp_SetUrlVar $http "user_id" "4fe732c3-322e-4a6b-b729-2fd1eb5c6104"

set sbResults [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:/{$item_path}:/search(q='{$search_text}')" $sbResults]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkStringBuilder $sbResults
    exit
}

# The response should be JSON.
CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbResults

# A successful response should return a status code of 200.
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Response status = [CkHttp_get_LastStatus $http]"
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkStringBuilder $sbResults
    exit
}

puts [CkJsonObject_emit $json]
puts "--"

# Iterate over the results in the JSON response:
set lastMod [new_CkDateTime]

set photoTaken [new_CkDateTime]

set i 0
set numItems [CkJsonObject_SizeOfArray $json "value"]
while {$i < $numItems} {
    CkJsonObject_put_I $json $i
    puts "-- DriveItem [expr $i + 1]"
    puts "id: [CkJsonObject_stringOf $json {value[i].id}]"
    puts "name: [CkJsonObject_stringOf $json {value[i].name}]"
    puts "size: [CkJsonObject_IntOf $json {value[i].size}]"

    # Get the lastModifiedDateTime
    CkDateTime_SetFromTimestamp $lastMod [CkJsonObject_stringOf $json "value[i].fileSystemInfo.lastModifiedDateTime"]

    # Is this a folder?
    if {[CkJsonObject_HasMember $json "value[i].folder"] == 1} then {
        puts "This is a folder with [CkJsonObject_IntOf $json {value[i].folder.childCount}] children"
    }

    if {[CkJsonObject_HasMember $json "value[i].file"] == 1} then {
        puts "This is a file."
        puts "SHA1 hash: [CkJsonObject_stringOf $json {value[i].file.hashes.sha1Hash}]"
        puts "mimeType: [CkJsonObject_stringOf $json {value[i].mimeType}]"
    }

    if {[CkJsonObject_HasMember $json "value[i].image"] == 1} then {
        puts "This is an image."
        puts "height: [CkJsonObject_IntOf $json {value[i].image.height}]"
        puts "width: [CkJsonObject_IntOf $json {value[i].image.width}]"
    }

    if {[CkJsonObject_HasMember $json "value[i].photo"] == 1} then {
        puts "This is a photo."
        CkDateTime_SetFromTimestamp $photoTaken [CkJsonObject_stringOf $json "value[i].photo.takenDateTime"]
        puts "photo taken on [CkDateTime_getAsRfc822 $photoTaken 1]"
    }

    if {[CkJsonObject_HasMember $json "value[i].audio"] == 1} then {
        puts "This is an audio file."
        puts "duration: [CkJsonObject_IntOf $json {value[i].audio.duration}]"
    }

    set i [expr $i + 1]
}

# Sample JSON OneDrive search response:

# 	{
# 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(driveItem)",
# 	  "value": [
# 	    {
# 	      "@odata.type": "#microsoft.graph.driveItem",
# 	      "@microsoft.graph.downloadUrl": "https://public.dm2301.livefilestore.com/y4m01N6dLIV7ditztcRwWDx2Jzf1qiwJNASFiHfajfZUuJnEMgHmIZTASy3lNzwUFHQgET0I11hzqCyb0A6I5jhI9FgFAJlBJHFrToT7QXj2xvCV46LOZVJASk79LEWRRM97aOhdOHhKeIl_HxoIWSl08sX3kGyC50RP72rDE7ERSVdZAa3CmMNkp6tRtfKI5wfJNqSx3NeqLQ6LxwBBY4KgniPQOgEna0G_MKTGDt10T4",
# 	      "createdBy": {
# 	        "user": {
# 	          "displayName": "Matt Smith",
# 	          "id": "3a33fceb9b74cc15"
# 	        }
# 	      },
# 	      "createdDateTime": "2017-06-04T20:40:22.48Z",
# 	      "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NzIuMjU3",
# 	      "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODcyLjI",
# 	      "id": "3A33FCEB9B74CC15!4872",
# 	      "lastModifiedBy": {
# 	        "user": {
# 	          "displayName": "Matt Smith",
# 	          "id": "3a33fceb9b74cc15"
# 	        }
# 	      },
# 	      "lastModifiedDateTime": "2017-06-04T20:40:23.463Z",
# 	      "name": "penguins.jpg",
# 	      "parentReference": {
# 	        "driveId": "3a33fceb9b74cc15",
# 	        "id": "3A33FCEB9B74CC15!4871",
# 	        "name": "wildlife",
# 	        "path": "/drive/root:/Misc/wildlife"
# 	      },
# 	      "size": 777835,
# 	      "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pgg",
# 	      "file": {
# 	        "hashes": {
# 	          "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
# 	        },
# 	        "mimeType": "image/jpeg"
# 	      },
# 	      "fileSystemInfo": {
# 	        "createdDateTime": "2017-06-04T20:40:22.48Z",
# 	        "lastModifiedDateTime": "2009-07-14T05:32:31.674Z"
# 	      },
# 	      "image": {
# 	        "height": 768,
# 	        "width": 1024
# 	      },
# 	      "photo": {
# 	        "takenDateTime": "2008-02-18T05:07:31Z"
# 	      },
# 	      "searchResult": {
# 	        "onClickTelemetryUrl": "https://www.bing.com/personalsearchclick?IG=D10F15177AE54D49A97F361270D53290&CID=3A33FCEB9B74CC150000000000000000&ID=DevEx%2c5005&q=penguins&resid=3A33FCEB9B74CC15%214872"
# 	      }
# 	    }
# 	  ]
# 	}

delete_CkJsonObject $json
delete_CkHttp $http
delete_CkStringBuilder $sbResults
delete_CkDateTime $lastMod
delete_CkDateTime $photoTaken