Represents a backup job's excluded item with a specified ID.
Resource URL
The URL of the reference resource representation:
https://<Backup-Office365>:4443/v2/Jobs/{ID}/ExcludedItems/{ID} |
Related Resources
Methods
The following methods are supported for the /Jobs/{ID}/ExcludedItems/{ID} resource:
(GET) /Jobs/{ID}/ExcludedItems/{itemid}
Properties
The /Jobs/{ID}/ExcludedItems/{ID} resource has the following properties:
Property | Type | Description |
|---|---|---|
Id | string | Specifies the ID of the backup item. For example, "Id": "164db76c-8e1b-49f2-91e1-d978510dec0d". |
Type | Specifies the type of the backup item:
For example, "type": "group". | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
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. For example, "group": "support_north". |
Members | bool | Specifies if this backup job will exclude Members processing option. For example, if "members": "true" this backup job will not back up organization members data. |
MemberMailbox | bool | Specifies if this backup job will exclude Mailbox processing option. For example, if "mailbox": "true" this backup job will not back up organization mailbox data. |
MemberArchiveMailbox | bool | Specifies if this backup job will exclude Archive Mailbox processing option. For example, if "archiveMailbox": "true" this backup job will not back up organization archive mailbox data. |
MemberOneDrive | bool | Specifies if this backup job will exclude OneDrive processing option. For example, if "OneDrive": "true" this backup job will not back up organization OneDrive data. |
MemberSite | bool | Specifies if this backup job will exclude SharePoint sites processing option. For example, if "site": "true" this backup job will not back up organization site data. |
GroupMail | bool | Specifies if this job will exclude group mail from backup. For example, if "groupMail": "true" this backup job will not back up organization group mail data. |
GroupSite | bool | Specifies if this job will exclude group site from backup. For example, if "groupSite": "true" this backup job will not back up organization group site data. |
User
The user backup item type has the following properties:
Property | Type | Description |
|---|---|---|
User | user | Specifies the organization user excluded for this backup job. For example, "user": "support_north". |
Mailbox | bool | Specifies if this backup job will exclude Mailbox processing option. For example, "mailbox": "true". |
ArchiveMailbox | bool | Specifies if this backup job will exclude Archive Mailbox processing option. For example, "archiveMailbox": "true". |
OneDrive | bool | Specifies if this backup job will exclude OneDrive processing option. For example, "OneDrive": "true". |
Site | bool | Specifies if this backup job will exclude SharePoint sites processing option. For example, "site": "true". |
Site
The site backup item type has the following properties:
Property | Type | Description |
|---|---|---|
Site | bool | Specifies if this backup job will exclude SharePoint sites processing option. For example, "site": "true". |
PartialOrganization
The partialOrganization backup item type has the following properties:
Property | Type | Description |
|---|---|---|
Mailbox | bool | Specifies if this backup job will exclude Mailbox processing option. For example, "mailbox": "true". |
ArchiveMailbox | bool | Specifies if this backup job will exclude Archive Mailbox processing option. For example, "archiveMailbox": "true". |
OneDrive | bool | Specifies if this backup job will exclude OneDrive processing option. For example, "OneDrive": "true". |
Site | bool | Specifies if this backup job will exclude SharePoint sites processing option. For example, "site": "true". |
Resource Representation
The /Jobs/{ID}/ExcludedItems/{ID} resource has the following representation:
Example 1
{ "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
{ "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
{ "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" } } } |
