Getting Excluded Items

In this article

You can get a resource representation of an excluded item with the specified ID.

Request

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

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
jobId	string	Specifies the identification number of the backup job. For more information on how to get this parameter, see Getting Backup Jobs.
itemId	string	Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Getting Excluded Items.

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/{itemId} resource. The response body contains the following properties:

Property	Type	Description
id	string	Specifies the excluded item ID.
type	excludeditemType	Specifies the type of an excluded item. The following types are available: Group User Site Team PartialOrganization PersonalSites OneDriveFolders
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Property

Type

Description

string

Specifies the excluded item ID.

type

excludeditemType

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

Group
User
Site
Team
PartialOrganization
PersonalSites
OneDriveFolders

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

excludeditemType

Group

An excluded item of the Group type has the following properties:

Property	Type	Description
group	Group	Specifies the organization group excluded from this backup job.
members	boolean	Defines if this backup job will exclude the Members processing option.
memberMailbox	boolean	Defines if this backup job will exclude the Mail processing option.
memberArchiveMailbox	boolean	Defines if this backup job will exclude the Archive processing option.
memberOnedrive	boolean	Defines if this backup job will exclude the OneDrive processing option.
memberSite	boolean	Defines if this backup job will exclude the Site processing option.
mailbox	boolean	Defines if this job will exclude group mailbox from backup.
groupSite	boolean	Defines if this job will exclude group site from backup.

User

An excluded item of the User type has the following properties:

Property	Type	Description
user	User	Specifies the organization user excluded from this backup job.
mailbox	boolean	Defines if this backup job will exclude the Mail processing option.
archiveMailbox	boolean	Defines if this backup job will exclude the Archive processing option.
oneDrive	boolean	Defines if this backup job will exclude the OneDrive processing option.
personalSite	boolean	Defines if this backup job will exclude the Site processing option.

Site

An excluded item of the Site type has the following properties:

Property	Type	Description
site	Site	Specifies the organization SharePoint site excluded from this backup job.

Team

An excluded item of the Team type has the following properties:

Property	Type	Description
team	Team	Specifies the team excluded from this backup job.

PartialOrganization

An excluded item of the PartialOrganization type has the following properties:

Property	Type	Description
mailbox	boolean	Defines if this backup job will exclude the Mail processing option.
archiveMailbox	boolean	Defines if this backup job will exclude the Archive processing option.
oneDrive	boolean	Defines if this backup job will exclude the OneDrive processing option.
sites	boolean	Defines if this backup job will exclude the Sites processing option.
teams	boolean	Defines if this backup job will exclude the Teams processing option.

PersonalSites

This type of an excluded item does not have properties. If the PersonalSites excluded item type is specified, all personal sites of an organization will be excluded.

OneDriveFolders

An excluded item of the OneDriveFolders type has the following properties:

Property	Type	Description
folders	string[]	Specifies a collection of OneDrive folders excluded from the backup job. Note: This property applies to all OneDrives in an organization. The specified folders will be excluded for each OneDrive.

Property

Type

Description

folders

string[]

Specifies a collection of OneDrive folders excluded from the backup job.

Note: This property applies to all OneDrives in an organization. The specified folders will be excluded for each OneDrive.

Examples

Example 1

The example returns a resource representation of an excluded item of the PartialOrganization type 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/94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"type": "PartialOrganization",

"mailbox": true,

"oneDrive": true,

"archiveMailbox": true,

"sites": true,

"teams": true,

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

"_links": {

"self": {

"href": "v6/jobs/5a9cd41a-a7cf-492e-93b3-8ed537645182/excludedItems/94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174"

"job": {

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

}

Example 2

The example returns a resource representation of an excluded item of the Site type 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/e1fa728c-4150-4724-ab3b-5deda33db0cf15d2e29f-8f52-44dd-8013-3ee42b5dc946a2b15a66-9d0d-4c74-9cb1-065ce17ef5c8

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"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/Site2",

"name": "Site2",

"isCloud": true,

"isPersonal": false,

"title": "Site",

"_links": {

"organization": {

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

}

Example 3

The example returns a resource representation of an excluded item of the Group type 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/9592732d-22d8-426a-8167-d9635158e9457ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"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": "Group2",

"name": "group2@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

}

Example 4

The example returns a resource representation of an excluded item of the User type 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/2b38d840-8098-4614-b369-ebce33f9b2c7369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000

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

}

Example 5

The example returns a resource representation of an excluded item of the Team type 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/7b985334-bc0e-4791-b30c-d03a1fecc84095e4e659-9039-45ef-826c-d1ba4b8e5d25

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"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": "Team 2",

"description": "",

"mail": "team2@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"

}

Example 6

The example returns a resource representation of a collection of OneDrive folders 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/7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"type": "OneDriveFolders",

"folders":

[

"copyFrom",

"exclude\Document.docx"

]

"id": "7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f",

"_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"

}