Getting Excluded Items

In this article

    This section explains how to get a resource representation of an excluded item with the specified ID.

    Request

    GET https://<hostname>:4443/v5/Jobs/{jobId}/ExcludedItems/{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

    An identification number of the backup job.

    itemId

    string

    An identification number of the item in the backup file.

    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

    The /Jobs/{jobId}/ExcludedItems/{itemId} resource has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the excluded item.

    type

    excludeditemType

    Specifies the type of the excluded item:

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

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    excludeditemType

    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.

    members

    boolean

    Specifies if this backup job will exclude Members processing option.

    memberMailbox

    boolean

    Specifies if this backup job will exclude Mailbox processing option.

    memberArchiveMailbox

    boolean

    Specifies if this backup job will exclude Archive Mailbox processing option.

    memberOneDrive

    boolean

    Specifies if this backup job will exclude OneDrive processing option.

    memberSite

    boolean

    Specifies if this backup job will exclude SharePoint sites processing option.

    groupMail

    boolean

    Specifies if this job will exclude group mail from backup.

    groupSite

    boolean

    Specifies if this job will exclude group site from backup.

    User

    The user backup item type has the following properties:

    Property

    Type

    Description

    user

    user

    Specifies the organization user excluded for this backup job.

    mailbox

    boolean

    Specifies if this backup job will exclude Mailbox processing option.

    archiveMailbox

    boolean

    Specifies if this backup job will exclude Archive Mailbox processing option.

    oneDrive

    boolean

    Specifies if this backup job will exclude OneDrive processing option.

    site

    boolean

    Specifies if this backup job will exclude SharePoint sites processing option.

    Site

    The site backup item type has the following properties:

    Property

    Type

    Description

    site

    boolean

    Specifies if this backup job will exclude SharePoint sites processing option.

    Team

    The team backup item type has the following properties:

    Property

    Type

    Description

    team

    boolean

    Specifies if this backup job will exclude Microsoft Teams processing option.

    partialOrganization

    The partialOrganization backup item type has the following properties:

    Property

    Type

    Description

    mailbox

    boolean

    Specifies if this backup job will exclude Mailbox processing option.

    archiveMailbox

    boolean

    Specifies if this backup job will exclude Archive Mailbox processing option.

    oneDrive

    boolean

    Specifies if this backup job will exclude OneDrive processing option.

    site

    boolean

    Specifies if this backup job will exclude SharePoint sites processing option.

    Example 1

    Request:

    GET https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/94f50108-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",

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

         }

       }

     }

    Example 2

    Request:

    GET https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/ca4b3d46-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": "User",

         "name": "userAlpha@organization.onmicrosoft.com",

         "type": "Office365",

         "locationType": "On-Premises",

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

         }

       }

     }

    Example 3

    Request:

    GET https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/b583d2b8-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": "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"

         }

       }

     }

    I want to report a typo

    There is a misspelling right here:

     

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