Searching for Tabs

In this article

You can search for backed-up Microsoft Teams channel tabs.

Request

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

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.
channelId	string	Specifies the identification number of the channel. For more information on how to get this parameter, see Getting Teams Channels.

Request Body

The request body must contain the following 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.

Parameter

Type

Description

name

string

Specifies the name of the tab.

Query example: name: website.

Request Example

Request:

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

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{
"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

The response body contains the following properties:

Property	Type	Description
offset	integer	Specifies the offset value.
limit	integer	Specifies the limit of records to be displayed on the page.
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": "/v6/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": "/v6/RestoreSessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19:94e57dbfaa634f999353b374b69b5800@thread.tacv2"

"team": {

"href": "/v6/RestoreSessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

}

"_links": {

"self": {

"href": "/v6/RestoreSessions/1a4df11a-2220-42a9-b3a0-d25cdb8e5fcb/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19%3A94e57dbfaa634f999353b374b69b5800%40thread.tacv2/tabs/search?offset=0&limit=30"

}