Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

(GET) /Jobs/{ID}/ExcludedItems/{ID}

Returns a resource representation of a backup job's excluded item with a specified ID.

Request

To get a a resource representation of the excluded item with a specified ID, send the GET HTTPS request to the URL of the /Jobs/{ID}/ExcludedItems/{ID} resource:

HTTPS Request

GET https://<Backup-Office365>:4443/v2/Jobs/{ID}/ExcludedItems/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

Content-Type: application/json

true

Specifies the type of the content for your request.

Authorization: Bearer <Access-Token>

true

The request header must contain the authorization token for the current logon session.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a representation of the /Jobs/{ID}/ExcludedItems/{ID} resource.

Example 1

Request:

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

 

Request Header:

Content-Type: application/json

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://support.east.local:4443/v2/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

       }

     }

   },

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

   "_links": {

     "job": {

       "href": "https://support.east.local:4443/v2/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

 

Example 2

Request:

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

 

Request Header:

Content-Type: application/json

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://support.east.local:4443/v2/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/groups/ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://support.east.local:4443/v2/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://support.east.local:4443/v2/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

 

Example 3

Request:

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

 

Request Header:

Content-Type: application/json

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://support.east.local:4443/v2/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://support.east.local:4443/v2/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

       },

       "onedrives": {

         "href": "https://support.east.local:4443/v2/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://support.east.local:4443/v2/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

     }

   }

 }

 

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference