Getting Backup Job Items

In this article

    You can get a resource representation of items in the specified backup job.

    Request

    GET https://<hostname>:4443/v5/Jobs/{jobId}/SelectedItems

    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

    An identification number of the backup job.

    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 collection resource. You get the following properties for each backup item in the collection:

    Property

    Type

    Description

    id

    string

    Specifies the ID of a backup item.

    type

    backupitemType

    Specifies the type of a backup item:

    • Group
    • User
    • Site
    • Team
    • partialOrganization
    • personalSites
    • oneDriveFolders

    _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 backup items, see backupitemType.

    Examples

    Example 1

    Request:

    GET https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/SelectedItems

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

       "type": "partialOrganization",

       "mailbox": true,

       "oneDrive": true,

       "archiveMailbox": true,

       "site": true,

       "id": "c37da450-6c4b-48c4-87e2-cc557ef5d8975db60525-e59f-49b9-b49b-407fc9bf2642",

       "_links": {}

     },

     {

       "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 1550",

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

       "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://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"

         }

       }

     }

     {

       "type": "Team",

       "team": {

         "id": "448c5b66-8dcd-4c75-b636-d3b500bce36f",

         "displayName": "IT&Finance",

         "description": "IT&Finance",

         "mail": "IT&Finance@organization.onmicrosoft.com",

         "_links": {

           "self": {

             "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

           },

           "organization": {

             "href": "https://abc.tech.local:4443/v5/organizations/5db60525-e59f-49b9-b49b-407fc9bf2642"

           }

         }

       },

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

       "_links": {

         "self": {

           "href": "https://abc.tech.local:4443/v5/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/selectedItems/7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f"

         },

         "job": {

           "href": "https://abc.tech.local:4443/v5/jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14"

         }

       }

     }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.