(PureBasic) OneDrive -- Rename or Move File or Folder

See more OneDrive Examples

Demonstrates how to rename or move a file or folder.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    ; This example uses the OAuth client credentials flow.
    ; See How to Create an Azure App Registration for OAuth 2.0 Client Credentials

    ; Use your client ID, client secret, and tenant ID in the following lines
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckEmit(json))

    ; First get the new parent folder ID.
    CkHttp::ckSetUrlVar(http,"user_id","4fe732c3-322e-4a6b-b729-2fd1eb5c6104")
    CkHttp::ckSetUrlVar(http,"dir_path","/Pictures")
    respStr.s = CkHttp::ckQuickGetStr(http,"https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:{$dir_path}")
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,respStr)
    If CkHttp::ckLastStatus(http) <> 200
        Debug "Failed to get parent folder item id, status code = " + Str(CkHttp::ckLastStatus(http))
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    newParentFolderId.s = CkJsonObject::ckStringOf(json,"id")

    ; This example will both rename and move the file /TestDir/penguins.jpg to /Pictures/three_penguins.jpg

    ; The body of the PATCH request will contain the following JSON:

    ; 	{
    ; 	    "name": "three_penguins.jpg",
    ; 	    "parentReference" : {"id": "{parent_folder_id}"}
    ; 	}

    jsonReqBody.i = CkJsonObject::ckCreate()
    If jsonReqBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonReqBody,"name","three_penguins.jpg")
    CkJsonObject::ckUpdateString(jsonReqBody,"parentReference.id",newParentFolderId)
    Debug CkJsonObject::ckEmit(jsonReqBody)

    CkHttp::ckSetUrlVar(http,"user_id","4fe732c3-322e-4a6b-b729-2fd1eb5c6104")
    CkHttp::ckSetUrlVar(http,"from_path","/TestDir/penguins.jpg")
    url.s = "https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:{$from_path}"
    resp.i = CkHttp::ckPText(http,"PATCH",url,CkJsonObject::ckEmit(jsonReqBody),"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonReqBody)
        ProcedureReturn
    EndIf

    ; If successful, a 200 status code is returned.
    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))
    Debug CkJsonObject::ckEmit(json)

    If CkHttpResponse::ckStatusCode(resp) = 200
        Debug "Success."
    Else
        Debug "Response status = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug "failed."
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; For a successful response, the DriveItem JSON object is returned.  For example:

    ; 	{
    ; 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/drive/root/$entity",
    ; 	  "@microsoft.graph.downloadUrl": "https://uj3pqw.dm2301.livefilestore.com/y4p1tXxbqLb4LVCdbXoXCXsqGaHcfH2Zw02p4_01Bg2eOyJxlU5o-40JLulT1oIOfDemlT4Hir7mrwKfYOj7-oNUweGNDSjqCpejYh30ZkYWV4f-zOsk8GAy2F8YmUx6UF_2R5bGIdseSpUVQ4wPJ4lDvFxA4GdEJN5ZS8flZFzHLvJSkAUKw98ZTbd_HHMQLUBcqw4fA3is52dtk0dwJIyW0queRqX5OIO6vysKJRGzU0",
    ; 	  "createdBy": {
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "createdDateTime": "2017-06-04T15:24:06.84Z",
    ; 	  "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NjkuMjU3",
    ; 	  "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODY5LjM",
    ; 	  "id": "3A33FCEB9B74CC15!4869",
    ; 	  "lastModifiedBy": {
    ; 	    "application": {
    ; 	      "displayName": "Chilkat",
    ; 	      "id": "441c9990"
    ; 	    },
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "lastModifiedDateTime": "2017-06-04T16:30:28.057Z",
    ; 	  "name": "three_penguins.jpg",
    ; 	  "parentReference": {
    ; 	    "driveId": "3a33fceb9b74cc15",
    ; 	    "id": "3A33FCEB9B74CC15!185",
    ; 	    "name": "Pictures",
    ; 	    "path": "/drive/root:/Pictures"
    ; 	  },
    ; 	  "size": 777835,
    ; 	  "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pgU",
    ; 	  "file": {
    ; 	    "hashes": {
    ; 	      "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
    ; 	    },
    ; 	    "mimeType": "image/jpeg"
    ; 	  },
    ; 	  "fileSystemInfo": {
    ; 	    "createdDateTime": "2017-06-04T15:24:06.84Z",
    ; 	    "lastModifiedDateTime": "2017-06-04T16:30:28.056Z"
    ; 	  },
    ; 	  "image": {
    ; 	    "height": 768,
    ; 	    "width": 1024
    ; 	  },
    ; 	  "photo": {
    ; 	    "takenDateTime": "2008-02-18T05:07:31Z"
    ; 	  }
    ; 	}
    ; 
    ; 


    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonReqBody)


    ProcedureReturn
EndProcedure