Getting Files

This section explains how to get a resource representation of backed-up Microsoft Teams files.

Request

GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files[?channelId=<channelId>&parentId=<value>]

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following optional parameters can be specified in the URL of the request.

Parameter

Type

Description

channelId

string

Specifies the ID of the channel whose files the server will return in the resource representation. If you do not specify this parameter, the server will return a representation of files pertaining to all channels of the backed-up team.

parentId

string

Specifies what information the server will return in the resource representation. Possible values:

  • <parentID> — ID of a parent folder. In the response, the server will return a representation of files in the specified folder.
  • null — specifies that the server will return a representation of all root folders of team channels.

If you do not specify this parameter, the server will return a representation of all files in all folders.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a representation of the /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files resource.

Example 1

The following request returns a representation of backed-up Microsoft Teams files for a team with the ID 448c5b66-8dcd-4c75-b636-d3b500bce36f.

Request:

GET https://abc.tech.local:4443/v5/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/files

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "9d939133-0c2c-4f8f-b317-6a3270229d32",

     "name": "word.docx",

     "sizeBytes": 16838,

     "version": 3,

     "modified": "2020-08-20T15:20:42Z",

     "modifiedBy": "admin",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/files/9d939133-0c2c-4f8f-b317-6a3270229d32?channelId=19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

       }

     }

   },

   {

     "id": "bf2e57b0-9ae4-4eec-a62b-2233e730b8d8",

     "name": "page.html",

     "sizeBytes": 443816,

     "version": 2,

     "modified": "2020-09-24T11:06:41Z",

     "modifiedBy": "user",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/files/bf2e57b0-9ae4-4eec-a62b-2233e730b8d8?channelId=19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/files?offset=0&limit=30"

   }

 }

}

Example 2

The following request returns a representation of backed-up Microsoft Teams files pertaining to a channel with the ID 19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2.

Request:

GET https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?channelId=19%3A6b5b3b1c37a1455ca03fab7c7bf410e0%40thread.tacv2

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "527b199a-ee21-4547-820a-0421f9002807",

     "name": "file.log",

     "sizeBytes": 3570,

     "version": 6,

     "modified": "2020-09-10T11:27:05Z",

     "modifiedBy": "admin",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/527b199a-ee21-4547-820a-0421f9002807?channelId=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/channels/19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf"

       }

     }

   },

   {

     "id": "8a768a0a-ac0a-4ce7-805a-147883be414b",

     "name": "page.html",

     "sizeBytes": 448635,

     "version": 6,

     "modified": "2020-09-10T11:28:20Z",

     "modifiedBy": "admin",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/8a768a0a-ac0a-4ce7-805a-147883be414b?channelId=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/channels/19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf"

       }

     }

   }

 ],

 "_links": {

   "first": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?channelid=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2&offset=0&limit=30"

   },

   "prev": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?channelid=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2&offset=0&limit=30"

   },

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?channelid=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2&offset=0&limit=30"

   },

   "next": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?channelid=19:6b5b3b1c37a1455ca03fab7c7bf410e0@thread.tacv2&offset=4&limit=2"

   }

 }

}

Example 3

The following request returns a representation of backed-up Microsoft Teams files in the parent folder with the ID a5f16914-3403-47be-845f-83cbe0b1ac0d.

Request:

GET https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?parentId=a5f16914-3403-47be-845f-83cbe0b1ac0d

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "7eeb39a8-7338-49a9-b936-b302a7511223",

     "name": "file.log",

     "sizeBytes": 52157,

     "version": 6,

     "modified": "2020-09-10T11:26:44Z",

     "modifiedBy": "admin",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/7eeb39a8-7338-49a9-b936-b302a7511223?channelId=19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/channels/19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf"

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/a5f16914-3403-47be-845f-83cbe0b1ac0d?channelId=19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       }

     }

   },

   {

     "id": "bf26a47d-bf89-4f6c-9b90-49bd6a1624fb",

     "name": "image.png",

     "sizeBytes": 119627,

     "version": 6,

     "modified": "2020-09-10T11:26:50Z",

     "modifiedBy": "admin",

     "type": "File",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/bf26a47d-bf89-4f6c-9b90-49bd6a1624fb?channelId=19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/channels/19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf"

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files/a5f16914-3403-47be-845f-83cbe0b1ac0d?channelId=19:27a6128adf4d4acc8fe9efe4d8dc1c8a@thread.tacv2"

       }

     }

   }

 ],

 "_links": {

   "first": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?parentid=a5f16914-3403-47be-845f-83cbe0b1ac0d&offset=0&limit=30"

   },

   "prev": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?parentid=a5f16914-3403-47be-845f-83cbe0b1ac0d&offset=0&limit=30"

   },

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/files?parentid=a5f16914-3403-47be-845f-83cbe0b1ac0d&offset=0&limit=30"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.