Searching for Tabs

This section explains how to search for backed-up Microsoft Teams tabs.

Request

POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/tabs/action

Request Headers

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

Request Parameters

The request URL must contain the following parameters:

Property

Type

Description

restoreSessionId

string

Specifies the identification number of the restore session. Can be obtained as described in Getting Restore Sessions.

teamId

string

Specifies the identification number of the team. Can be obtained as described in Getting Teams.

channelId

string

Specifies the identification number of the channel. Can be obtained as described in Getting Channels.

Request Body

The request body must contain the search action property:

Property

Type

Description

query

string

Specifies query parameters used to search for Microsoft Teams tabs. For more information, see Query Parameters.

Query Parameters

You can use the following parameters in the query string to search for Microsoft Teams tabs:

Parameter

Type

Description

name

string

Specifies the name of the tab.

Query example: name: website.

Request Example

Request:

POST https://abc.tech.local:4443/v5/RestoreSessions/0dccfd9f-8056-4d90-a7a3-2af1f9a249a1/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19%3A94e57dbfaa634f999353b374b69b5800%40thread.tacv2/tabs/action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "search":{
     "query": "name: word"

  }

}

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

Property

Type

Description

offset

integer

Shows the offset value.

limit

integer

Shows the offset limit.

results

Results Object

Contains the Results object.

Results Object

Property

Type

Description

Id

string

ID of the backed-up tab.

DisplayName

string

Display name of the backed-up tab.

ContentURL

string

URL address of the object published on the backed-up tab.

Type

string

Type of the backed-up tab.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Response Example

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "854dde06-0935-47f4-8e36-3c65f9f8cb89",

     "displayName": "word",

     "contentUrl": "https://abc.sharepoint.com/sites/IT&Finance/Shared Documents/General/word.docx",

     "type": "Word",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2/tabs/854dde06-0935-47f4-8e36-3c65f9f8cb89"

       },

       "channel": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

       },

       "team": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19%3A94e57dbfaa634f999353b374b69b5800%40thread.tacv2/tabs/action?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.