Getting Backup Job Items
You can get a resource representation of a backup item with the specified ID.
Request
GET https://<hostname>:4443/v6/Jobs/{jobId}/SelectedItems/{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 Backup Job 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}/SelectedItems/{itemId} resource. The response body contains the following properties:
Property | Type | Description |
---|---|---|
id | string | Specifies the backup item ID. |
type | Specifies the type of a backup item. The following types are available:
| |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Group
A backup item of the Group type has the following properties:
Property | Type | Description |
---|---|---|
group | Specifies the organization group selected for this backup job. | |
members | boolean | Defines whether this backup job will include the Members processing option. |
memberMailbox | boolean | Defines whether this backup job will include the Mail processing option. |
memberArchiveMailbox | boolean | Defines whether this backup job will include the Archive processing option. |
memberOnedrive | boolean | Defines whether this backup job will include the OneDrive processing option. |
memberSite | boolean | Defines whether this backup job will include the Site processing option. |
mailbox | boolean | Defines whether this job will back up group mailbox. |
groupSite | boolean | Defines whether this job will back up group site. |
User
A backup item of the User type has the following properties:
Property | Type | Description |
---|---|---|
user | Specifies the organization user selected for this backup job. | |
mailbox | boolean | Defines whether this backup job will include the Mail processing option. |
archiveMailbox | boolean | Defines whether this backup job will include the Archive processing option. |
oneDrive | boolean | Defines whether this backup job will include the OneDrive processing option. |
personalSite | boolean | Defines whether this backup job will include the Site processing option. |
Site
A backup item of the Site type has the following property:
Property | Type | Description |
---|---|---|
site | Specifies the organization SharePoint site selected for this backup job. |
Team
A backup item of the Team type has the following properties:
Property | Type | Description |
---|---|---|
team | Specifies the team selected for this backup job. | |
chats | boolean | Defines whether this backup job will include the Chats processing option. Note: This property is available starting from Veeam Backup for Microsoft 365 version 6a (build 6.1.0.222). |
PartialOrganization
A backup item of the PartialOrganization type has the following properties:
Property | Type | Description |
---|---|---|
mailbox | boolean | Defines whether this backup job will include the Mail processing option. |
archiveMailbox | boolean | Defines whether this backup job will include the Archive processing option. |
oneDrive | boolean | Defines whether this backup job will include the OneDrive processing option. |
sites | boolean | Defines whether this backup job will include the Sites processing option. |
teams | boolean | Defines whether this backup job will include the Teams processing option. |
teamsChats | boolean | Defines whether this job will back up team chats. Note: This property is available starting from Veeam Backup for Microsoft 365 version 6a (build 6.1.0.222). |
PersonalSites
This type of a backup item does not have properties. If the PersonalSites backup item type is specified, all personal sites of an organization will be processed.
OneDriveFolders
A backup item of the OneDriveFolders type has the following property:
Property | Type | Description |
---|---|---|
folders | string[] | Specifies an array of OneDrive folders included in the backup job. Note: This property applies to all OneDrives in an organization. Only specified folders will be processed for each OneDrive. |
Examples
Example 1
The example returns a resource representation of a backup item of the PartialOrganization type selected for the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/c37da450-6c4b-48c4-87e2-cc557ef5d8975db60525-e59f-49b9-b49b-407fc9bf2642
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "type": "PartialOrganization", "mailbox": true, "oneDrive": true, "archiveMailbox": true, "sites": true, "teams": true, "teamsChats": true, "id": "c37da450-6c4b-48c4-87e2-cc557ef5d8975db60525-e59f-49b9-b49b-407fc9bf2642", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/c37da450-6c4b-48c4-87e2-cc557ef5d8975db60525-e59f-49b9-b49b-407fc9bf2642" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } |
Example 2
The example returns a resource representation of a backup item of the Site type selected for the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/e1fa728c-4150-4724-ab3b-5deda33db0cf94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174
Request Header: 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", "title": "Group2", "name": "group2", "isCloud": false, "isPersonal": false "_links": { "organization": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" } } }, "id": "e1fa728c-4150-4724-ab3b-5deda33db0cf94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/e1fa728c-4150-4724-ab3b-5deda33db0cf94f50108-75b4-4a5e-89ae-5651ee1e3975fdc607c4-6ac6-47d9-a1f3-cbdbc9766174" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } |
Example 3
The example returns a resource representation of a backup item of the Group type selected for the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/9592732d-22d8-426a-8167-d9635158e945ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "type": "Group", "group": { "id": "ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000", "displayName": "Group", "name": "group@organization.onmicrosoft.com", "type": "Office365", "locationType": "OnPremises", "_links": { "self": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/groups/ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000" }, "organization": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" } } }, "members": true, "memberMailbox": true, "memberArchiveMailbox": false, "memberOnedrive": true, "memberSite": true, "mailbox": true, "groupSite": false, "id": "9592732d-22d8-426a-8167-d9635158e945ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/9592732d-22d8-426a-8167-d9635158e945ca4b3d46-640f-4353-b59b-5beff743ca4c00000000-0000-0000-0000-000000000000" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } |
Example 4
The example returns a resource representation of a backup item of the User type selected for the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/2b38d840-8098-4614-b369-ebce33f9b2c7b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000
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": "User1", "name": "user1@organization.onmicrosoft.com", "type": "User", "locationType": "Cloud", "_links": { "self": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000" }, "organization": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" }, "onedrives": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/users/b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000/onedrives" } } }, "mailbox": true, "oneDrive": true, "archiveMailbox": true, "personalSite": true, "id": "2b38d840-8098-4614-b369-ebce33f9b2c7b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/2b38d840-8098-4614-b369-ebce33f9b2c7b583d2b8-c143-4b98-a769-fc95ebaa45f600000000-0000-0000-0000-000000000000" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } |
Example 5
The example returns a resource representation of a backup item of the Team type selected for the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "type": "Team", "chats": true, "team": { "id": "448c5b66-8dcd-4c75-b636-d3b500bce36f", "displayName": "ABC Team", "description": "", "mail": "abc_team@abc.onmicrosoft.com", "_links": { "self": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f" }, "organization": { "href": "/v6/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642" } } }, "id": "7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } |
Example 6
The example returns a resource representation of a collection of OneDrive folders included in the backup job with the ID 31a66931-b5d3-49f7-bba1-c46db49d3d14.
Request: GET https://abc.tech.local:4443/v6/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems/857b9853-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "type": "OneDriveFolders", "folders": { [ "copyTo", "light\Document.docx" ] }, "id": "857b9853-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f", "_links": { "self": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/857b9853-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f" }, "job": { "href": "/v6/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14" } } } |