Getting Files

You can get a resource representation of a backed-up Microsoft Teams file with the specified ID.

Request

GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}?channelId=<string>

Request Headers

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

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter

Type

Description

restoreSessionId

string

Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

teamId

string

Specifies the identification number of the team. For more information on how to get this parameter, see Getting Teams.

fileId

string

Specifies the identification number of the file. For more information on how to get this parameter, see Getting Files.

The following optional parameter can be specified in the URL of the request:

Parameter

Type

Description

channelId

string

Specifies the ID of the channel whose file the server will return in the resource representation.

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 response body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a resource representation of the /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId} resource. The response body contains the following properties:

Property

Type

Description

id

string

ID of the file.

name

string

File name.

sizeBytes

integer

Size of the file.

version

string

Version of the file in the backup.

modified

UTC

Date and time of the last modification of the file.

modifiedBy

string

Name of the user who performed the latest modification of the file.

type

string

Type of the Microsoft Teams item.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of the Microsoft Teams file with the ID 9d939133-0c2c-4f8f-b317-6a3270229d32.

Request:

GET https://abc.tech.local:4443/v6/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/files/9d939133-0c2c-4f8f-b317-6a3270229d32

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "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": "/v6/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": "/v6/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

   },

   "team": {

     "href": "/v6/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

   }

 }

}