(Ruby) Retrieve the metadata for a DriveItem

See more OneDrive Examples

Fetches the JSON metadata for a DriveItem.

For more information, see https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get?view=odsp-graph-online

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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
json = Chilkat::CkJsonObject.new()
json.UpdateString("client_id","2871da2c-8176-4b7f-869b-2311aa82e743")
json.UpdateString("client_secret","2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH")
json.UpdateString("scope","https://graph.microsoft.com/.default")
json.UpdateString("token_endpoint","https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token")

http = Chilkat::CkHttp.new()
http.put_AuthToken(json.emit())

# Sends the following GET request:
# GET https://graph.microsoft.com/v1.0/users/{user-id}/drive/root:/{item-path}

# Make sure to automatically follow redirects
http.put_FollowRedirects(true)

# This example will get the metadata for /Misc/wildlife/penguins.jpg
http.SetUrlVar("item_path","Misc//penguins.jpg")
http.SetUrlVar("user_id","4fe732c3-322e-4a6b-b729-2fd1eb5c6104")

metaData = http.quickGetStr("https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:/{$item_path}")
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

json.put_EmitCompact(false)
success = json.Load(metaData)
print json.emit() + "\n";

# Sample JSON metadata result:

# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('admin%40chilkat.io')/drive/root/$entity",
#   "@microsoft.graph.downloadUrl": "https://public.dm.files.1drv.com/y4mh0z_Og97O7Q...o2q1HhNBU",
#   "createdDateTime": "2017-06-04T20:40:22.48Z",
#   "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NzIuMjU3",
#   "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODcyLjY",
#   "id": "3A33FCEB9B74CC15!4872",
#   "lastModifiedDateTime": "2018-10-20T18:22:29.977Z",
#   "name": "penguins.jpg",
#   "size": 777835,
#   "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pgg",
#   "rating": {
#     "rating": 75,
#     "simpleRating": 4
#   },
#   "createdBy": {
#     "user": {
#       "displayName": "Joe Programmer",
#       "id": "3a33fceb9b74cc15"
#     }
#   },
#   "lastModifiedBy": {
#     "user": {
#       "displayName": "Joe Programmer",
#       "id": "3a33fceb9b74cc15"
#     }
#   },
#   "parentReference": {
#     "driveId": "3a33fceb9b74cc15",
#     "driveType": "personal",
#     "id": "3A33FCEB9B74CC15!4871",
#     "name": "wildlife",
#     "path": "/drive/root:/Misc/wildlife"
#   },
#   "file": {
#     "mimeType": "image/jpeg",
#     "hashes": {
#       "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
#     }
#   },
#   "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"
#   },
#   "shared": {
#     "scope": "users",
#     "owner": {
#       "user": {
#         "displayName": "Joe Programmer",
#         "id": "3a33fceb9b74cc15"
#       }
#     }
#   }
# }
# 

# If the response status code was not 200, then it failed.
if (http.get_LastStatus() != 200)
    print "Response Status Code = " + http.get_LastStatus().to_s() + "\n";
    print "Failed." + "\n";
    exit
end

# Demonstrate how to parse the JSON...

odata_context = json.stringOf("\"@odata.context\"")
microsoft_graph_downloadUrl = json.stringOf("\"@microsoft.graph.downloadUrl\"")
createdDateTime = json.stringOf("createdDateTime")
cTag = json.stringOf("cTag")
eTag = json.stringOf("eTag")
id = json.stringOf("id")
lastModifiedDateTime = json.stringOf("lastModifiedDateTime")
name = json.stringOf("name")
size = json.IntOf("size")
webUrl = json.stringOf("webUrl")
ratingRating = json.IntOf("rating.rating")
ratingSimpleRating = json.IntOf("rating.simpleRating")
createdByUserDisplayName = json.stringOf("createdBy.user.displayName")
createdByUserId = json.stringOf("createdBy.user.id")
lastModifiedByUserDisplayName = json.stringOf("lastModifiedBy.user.displayName")
lastModifiedByUserId = json.stringOf("lastModifiedBy.user.id")
parentReferenceDriveId = json.stringOf("parentReference.driveId")
parentReferenceDriveType = json.stringOf("parentReference.driveType")
parentReferenceId = json.stringOf("parentReference.id")
parentReferenceName = json.stringOf("parentReference.name")
parentReferencePath = json.stringOf("parentReference.path")
fileMimeType = json.stringOf("file.mimeType")
fileHashesSha1Hash = json.stringOf("file.hashes.sha1Hash")
fileSystemInfoCreatedDateTime = json.stringOf("fileSystemInfo.createdDateTime")
fileSystemInfoLastModifiedDateTime = json.stringOf("fileSystemInfo.lastModifiedDateTime")
imageHeight = json.IntOf("image.height")
imageWidth = json.IntOf("image.width")
photoTakenDateTime = json.stringOf("photo.takenDateTime")
sharedScope = json.stringOf("shared.scope")
sharedOwnerUserDisplayName = json.stringOf("shared.owner.user.displayName")
sharedOwnerUserId = json.stringOf("shared.owner.user.id")