Getting Excluded Items

This section explains how to get a resource representation of an excluded item with the specified ID.

Request

GET https://<hostname>:4443/v4/Jobs/{backup_job_id}/ExcludedItems/{item_Id}

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

backup_job_id

string

An identification number of the backup job.

item_Id

string

An identification number of the item in the backup file.

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 /Jobs/{id}/ExcludedItems/{itemId} resource has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the backup item.

Type

backupitemType

Specifies the type of the backup item:

  • Group
  • User
  • Site
  • partialOrganization
  • personalSites
  • oneDriveFolders

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

ExcludeditemType

Group

The group backup item type has the following properties:

Property

Type

Description

Group

group

Specifies the organization users group excluded for this backup job.

Members

boolean

Specifies if this backup job will exclude Members processing option.

MemberMailbox

boolean

Specifies if this backup job will exclude Mailbox processing option.

MemberArchiveMailbox

boolean

Specifies if this backup job will exclude Archive Mailbox processing option.

MemberOneDrive

boolean

Specifies if this backup job will exclude OneDrive processing option.

MemberSite

boolean

Specifies if this backup job will exclude SharePoint sites processing option.

GroupMail

boolean

Specifies if this job will exclude group mail from backup.

GroupSite

boolean

Specifies if this job will exclude group site from backup.

User

The user backup item type has the following properties:

Property

Type

Description

User

user

Specifies the organization user excluded for this backup job.

Mailbox

boolean

Specifies if this backup job will exclude Mailbox processing option.

ArchiveMailbox

boolean

Specifies if this backup job will exclude Archive Mailbox processing option.

OneDrive

boolean

Specifies if this backup job will exclude OneDrive processing option.

Site

boolean

Specifies if this backup job will exclude SharePoint sites processing option.

Site

The site backup item type has the following properties:

Property

Type

Description

Site

boolean

Specifies if this backup job will exclude SharePoint sites processing option.

PartialOrganization

The partialOrganization backup item type has the following properties:

Property

Type

Description

Mailbox

boolean

Specifies if this backup job will exclude Mailbox processing option.

ArchiveMailbox

boolean

Specifies if this backup job will exclude Archive Mailbox processing option.

OneDrive

boolean

Specifies if this backup job will exclude OneDrive processing option.

Site

boolean

Specifies if this backup job will exclude SharePoint sites processing option.

Example 1

Request:

GET https://abc.tech.local:4443/v4/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

   "type": "Site",

   "site": {

     "id": "94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174",

     "url": "https://organization.sharepoint.com/sites/group2",

     "name": "Group 2",

     "isCloud": false,

     "isBackedup": false,

     "isAvailable": false,

     "_links": {

       "organization": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

       }

     }

   },

   "id": "e1fa728c-4150-4724-ab3b-5deda33db0cf94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174",

   "_links": {

     "job": {

       "href": "https://abc.tech.local:4443/v4/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

Example 2

Request:

GET https://abc.tech.local:4443/v4/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

   "type": "Group",

   "group": {

     "id": "ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000",

     "displayName": "USER",

     "name": "userAlpha@organization.onmicrosoft.com",

     "type": "Office365",

     "locationType": "OnPremises",

     "isBackedup": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/groups/ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

       }

     }

   },

   "members": true,

   "memberMail": true,

   "memberArchive": false,

   "memberOnedrive": true,

   "memberSite": true,

   "mail": true,

   "site": false,

   "id": "9592732d-22d8-426a-8167-d9635158e945ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000",

   "_links": {

     "job": {

       "href": "https://abc.tech.local:4443/v4/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

Example 3

Request:

GET https://abc.tech.local:4443/v4/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

   "type": "User",

   "user": {

     "id": "b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000",

     "displayName": "USER",

     "name": "userAlpha@organization.onmicrosoft.com",

     "type": "User",

     "isBackedUp": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

       },

       "onedrives": {

         "href": "https://abc.tech.local:4443/v4/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000/onedrives"

       }

     }

   },

   "mailbox": true,

   "oneDrive": true,

   "archiveMailbox": true,

   "site": true,

   "id": "2b38d840-8098-4614-b369-ebce33f9b2c7b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000",

   "_links": {

     "job": {

       "href": "https://abc.tech.local:4443/v4/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

I want to report a typo

There is a misspelling right here:

 

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