This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Excluded Items
You can get a resource representation of items excluded from the specified backup job.
Request
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 collection 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 | excludeditemType | Specifies the type of the excluded item:
|
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
For more information about properties that you get for different types of the excluded items, see excludeditemType.
Mind that if you perform the request in Veeam Backup for Microsoft 365 version 6, REST API v5.0 returns the groupsite property instead of the site property for items of the Group type.
Examples
Example 1
Request: GET https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems
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", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000" }, "organization": { "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" }, "onedrives": { "href": "https://abc.tech.local:4443/v5/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/v5/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } }, { "type": "Group", "group": { "id": "ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000", "displayName": "USER", "name": "userAlpha@organization.onmicrosoft.com", "type": "Office365", "locationType": "OnPremises", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/groups/ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000" }, "organization": { "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" } } }, "members": true, "memberMailbox": true, "memberArchiveMailbox": false, "memberOneDrive": true, "memberSite": true, "mailbox": 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/v5/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } }, { "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, "isAvailable": false, "_links": { "organization": { "href": "https://abc.tech.local:4443/v5/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/v5/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } ] |
