Getting Excluded Items

You can get a resource representation of items excluded from a backup job with the specified ID.

Request

GET https://<hostname>:4443/v6/Jobs/{jobId}/ExcludedItems

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

jobId

string

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

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 /Jobs/{jobId}/ExcludedItems resource. You get the following properties for each item in the collection:

Property

Type

Description

id

string

Specifies the ID of an item excluded from the backup job.

type

string

Specifies the type of the excluded item. The following types are available:

  • Group
  • User
  • Site
  • Team
  • PartialOrganization
  • PersonalSites
  • OneDriveFolders

For more information about properties that you get for different types of excluded items, see excludeditemType.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a list of items excluded from the backup job with the ID 5a9cd41a-a7cf-492e-93b3-8ed537645182.

Request:

GET https://abc.tech.local:4443/v6/Jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/ExcludedItems

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "type": "User",

   "id": "2b38d840-8098-4614-b369-ebce33f9b2c7369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

   "_links": {

     "self": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/excludedItems/2b38d840-8098-4614-b369-ebce33f9b2c7369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000"

     },

     "job": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182"

     }

   },

   "mailbox": true,

   "oneDrive": true,

   "archiveMailbox": true,

   "user": {

     "id": "369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

     "displayName": "Administrator",

     "name": "administrator@abc.onmicrosoft.com",

     "type": "User",

     "locationType": "Cloud",

     "_links": {

       "self": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/users/369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       },

       "onedrives": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/users/369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000/onedrives"

       }

     }

   },

   "personalSite": true

 },

 {

   "type": "Group",

   "id": "9592732d-22d8-426a-8167-d9635158e9457ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000",

   "_links": {

     "self": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/excludedItems/9592732d-22d8-426a-8167-d9635158e9457ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000"

     },

     "job": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182"

     }

   },

   "mailbox": true,

   "group": {

     "id": "7ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000",

     "displayName": "Administrators Group",

     "name": "admins_group@abc.onmicrosoft.com",

     "type": "Office365",

     "locationType": "Cloud",

     "_links": {

       "self": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/groups/7ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       }

     }

   },

   "members": true,

   "memberMailbox": true,

   "memberArchiveMailbox": true,

   "memberOnedrive": true,

   "memberSite": true

 },

 {

   "type": "Site",

   "id": "e1fa728c-4150-4724-ab3b-5deda33db0cf15d2e29f-8f52-44dd-8013-3ee42b5dc946a2b15a66-9d0d-4c74-9cb1-065ce17ef5c8",

   "_links": {

     "self": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/excludedItems/e1fa728c-4150-4724-ab3b-5deda33db0cf15d2e29f-8f52-44dd-8013-3ee42b5dc946a2b15a66-9d0d-4c74-9cb1-065ce17ef5c8"

     },

     "job": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182"

     }

   },

   "site": {

     "id": "15d2e29f-8f52-44dd-8013-3ee42b5dc946a2b15a66-9d0d-4c74-9cb1-065ce17ef5c8",

     "url": "https://abc.sharepoint.com/sites/AdminsSite",

     "name": "AdminisSite",

     "isCloud": true,

     "isPersonal": false,

     "title": "Administrators Site",

     "_links": {

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       }

     }

   }

 },

 {

   "type": "Team",

   "id": "7b985334-bc0e-4791-b30c-d03a1fecc84095e4e659-9039-45ef-826c-d1ba4b8e5d25",

   "_links": {

     "self": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/excludedItems/7b985334-bc0e-4791-b30c-d03a1fecc84095e4e659-9039-45ef-826c-d1ba4b8e5d25"

     },

     "job": {

       "href": "/v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182"

     }

   },

   "team": {

     "id": "95e4e659-9039-45ef-826c-d1ba4b8e5d25",

     "displayName": "ABC Team",

     "description": "",

     "mail": "abc_team@abc.onmicrosoft.com",

     "_links": {

       "self": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/teams/95e4e659-9039-45ef-826c-d1ba4b8e5d25"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       }

     }

   }

 }

]