Getting Group Data by Repository and Group ID

This section explains how to get group data in the specified backup repository and group.

Request

GET https://<hostname>:4443/v4/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 posted as URL.

Parameter

Type

Description

repositoryId

string

An identification number of the backup repository.

groupId

string

An identification number of the group.

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

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.

Example

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

Request:

GET https://abc.tech.local:4443/v4/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/v4/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/v4/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/v4/backuprepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.