Getting Tabs

In this article

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

    Request

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

    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.

    tabId

    string

    Specifies the identification number of the channel tab. For more information on how to get this parameter, see Getting Tabs.

    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}/channels/{channelId}/tabs/{tabId} resource. The response body contains the following parameters:

    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. Possible values:

    • Website 
    • Planner
    • Word
    • Excel
    • PowerPoint
    • Visio
    • PDF
    • Document Library
    • OneNote (restore for tabs of this type is not supported)
    • SharePoint
    • Stream
    • Forms
    • Power BI
    • Flow
    • Azure DevOps

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    The following request returns a resource representation of a channel tab with the ID 854dde06-0935-47f4-8e36-3c65f9f8cb89.

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/b23ba83e-e45c-4615-97ab-190f506c643e/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels/19%3A94e57dbfaa634f999353b374b69b5800%40thread.tacv2/tabs/854dde06-0935-47f4-8e36-3c65f9f8cb89

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "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/b23ba83e-e45c-4615-97ab-190f506c643e/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/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"

       }

     }

    }