Getting Group Data by Repository and Group ID

In this article

    You can get group data in the specified backup repository and group.

    Request

    GET https://<hostname>:4443/v5/BackupRepositories/{repositoryId}/GroupData/{groupId}

    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

    repositoryId

    string

    Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

    groupId

    string

    Specifies the identification number of the group. For more information on how to get this parameter, see Getting Organization Groups.

    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

    The response contains the following information:

    Property

    Type

    Description

    id

    string

    Specifies the ID of a backup repository.

    accountId

    string

    Specifies the ID of the backed-up group.

    displayName

    string

    Specifies the name of the backed-up group.

    email

    string

    Specifies the group email.

    oneDriveUrl

    string

    Specifies the URL for the backed-up group Microsoft OneDrive.

    personalSiteUrl

    string

    Specifies the URL for the backed-up group Microsoft SharePoint site.

    organizationId

    string

    Specifies the ID of a backed-up organization.

    Examples

    Example 1

    The example returns a resource representation of the backed-up users group data with the ID 7718365c-91a1-45e5-b70a-9254d79f7413.

    Request:

    GET https://abc.tech.local:4443/v5/BackupRepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/GroupData/7718365c-91a1-45e5-b70a-9254d79f7413

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

     {

     "id": "organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-0000000000007718365c-91a1-45e5-b70a-9254d79f7413:00000000-0000-0000-0000-000000000000",

     "accountId": "7718365c-91a1-45e5-b70a-9254d79f7413:00000000-0000-0000-0000-000000000000",

     "displayName": "users",

     "email": "user@organization.onmicrosoft.com",

     "organizationId": "organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "oneDriveUrl": [],

     "personalSiteUrl": [

       "https://organization.sharepoint.com/sites/users"

     ],

     "_links": {

       "self": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/groupdata/7718365c-91a1-45e5-b70a-9254d79f7413:00000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/organizationdata/organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

       },

       "backupRepository": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41"

       }

     }

    }