Getting Backup Job Items

In this article

    You can get a resource representation of items added to a backup job with the specified ID.

    Request

    GET https://<hostname>:4443/v6/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

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

    Property

    Type

    Description

    id

    string

    Specifies the backup item ID.

    type

    string

    Specifies the type of a backup item. The following types are available:

    • Group
    • User
    • Site
    • Team
    • PartialOrganization
    • PersonalSites
    • OneDriveFolders

    For more information about properties that you get for different types of backup items, see backupitemType.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a list of items added to the backup job with the ID b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504.

    Request:

    GET https://abc.tech.local:4443/v6/Jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/SelectedItems

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

       "type": "User",

       "id": "2b38d840-8098-4614-b369-ebce33f9b2c78325737c-7738-4a3c-9434-33641dcb40a600000000-0000-0000-0000-000000000000",

       "_links": {

         "self": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems/2b38d840-8098-4614-b369-ebce33f9b2c78325737c-7738-4a3c-9434-33641dcb40a600000000-0000-0000-0000-000000000000"

         },

         "job": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

         }

       },

       "mailbox": true,

       "oneDrive": true,

       "archiveMailbox": true,

       "user": {

         "id": "8325737c-7738-4a3c-9434-33641dcb40a600000000-0000-0000-0000-000000000000",

         "displayName": "User1",

         "name": "user1@abc.onmicrosoft.com",

         "type": "User",

         "locationType": "Cloud",

         "_links": {

           "self": {

             "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/users/8325737c-7738-4a3c-9434-33641dcb40a600000000-0000-0000-0000-000000000000"

           },

           "organization": {

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

           },

           "onedrives": {

             "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/users/8325737c-7738-4a3c-9434-33641dcb40a600000000-0000-0000-0000-000000000000/onedrives"

           }

         }

       },

       "personalSite": true

     },

     {

       "type": "User",

       "id": "2b38d840-8098-4614-b369-ebce33f9b2c7369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

       "_links": {

         "self": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems/2b38d840-8098-4614-b369-ebce33f9b2c7369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000"

         },

         "job": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

         }

       },

       "mailbox": true,

       "oneDrive": true,

       "archiveMailbox": true,

       "user": {

         "id": "369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

         "displayName": "User2",

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

     },

      {

       "type": "Group",

       "id": "9592732d-22d8-426a-8167-d9635158e94595e4e659-9039-45ef-826c-d1ba4b8e5d2500000000-0000-0000-0000-000000000000",

       "_links": {

         "self": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems/9592732d-22d8-426a-8167-d9635158e94595e4e659-9039-45ef-826c-d1ba4b8e5d2500000000-0000-0000-0000-000000000000"

         },

         "job": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

         }

       },

       "mailbox": true,

       "groupSite": false,

       "group": {

         "id": "95e4e659-9039-45ef-826c-d1ba4b8e5d2500000000-0000-0000-0000-000000000000",

         "displayName": "ABC Group",

         "name": "abc_group@abc.onmicrosoft.com",

         "type": "Office365",

         "locationType": "Cloud",

         "_links": {

           "self": {

             "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/groups/95e4e659-9039-45ef-826c-d1ba4b8e5d2500000000-0000-0000-0000-000000000000"

           },

           "organization": {

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

           }

         }

       },

       "members": true,

       "memberMailbox": true,

       "memberArchiveMailbox": true,

       "memberOnedrive": true,

       "memberSite": true

     },

     {

       "type": "Site",

       "id": "e1fa728c-4150-4724-ab3b-5deda33db0cf5359c4b5-5e3f-4fbb-a97f-a916bcba00a1ea863003-4637-4414-ad37-1757dd8f85cc",

       "_links": {

         "self": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems/e1fa728c-4150-4724-ab3b-5deda33db0cf5359c4b5-5e3f-4fbb-a97f-a916bcba00a1ea863003-4637-4414-ad37-1757dd8f85cc"

         },

         "job": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

         }

       },

       "site": {

         "id": "5359c4b5-5e3f-4fbb-a97f-a916bcba00a1ea863003-4637-4414-ad37-1757dd8f85cc",

         "url": "https://abc.sharepoint.com/sites/ABC_site",

         "name": "ABC_site",

         "isCloud": true,

         "isPersonal": false,

         "title": "ABC Site",

         "_links": {

           "organization": {

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

           }

         }

       },

     {

       "type": "Team",

       "team": {

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

         "displayName": "ABC Team",

         "description": "",

         "mail": "abc_team@abc.onmicrosoft.com",

         "_links": {

           "self": {

             "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

           },

           "organization": {

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

           }

         }

       },

       "chats": true,

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

       "_links": {

         "self": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems/7b985334-bc0e-4791-b30c-d03a1fecc840448c5b66-8dcd-4c75-b636-d3b500bce36f"

         },

         "job": {

           "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

         }

       }

     }

    ]