Getting Restore Session Event by Event ID

In this article

    You can get a list of properties for the specified restore session event.

    Request

    GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Events/{eventId}

    Request Headers

    The request header must contain an authorization token of the current session.

    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

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization, whose database is available to explore and restore during the restore session.

    name

    string

    Specifies the name of the organization, whose database is available to explore and restore during the restore session.

    initiatedBy

    string

    Specifies the name of the who initiated the restore session.

    endTime

    UTC

    Specifies date and time when the restore session ended.

    startTime

    UTC

    Specifies date and time when the restore session started.

    status

    eventStatus

    Specifies the status of the restore session:

    • Running
    • Success
    • Warning
    • Failed

    duration

    integer

    Specifies the duration of the restore session

    message

    string

    Specifies the message of the restore session event.

    type

    eventType

    Specifies the type of the restore session event:

    • None
    • Save
    • Export
    • Send
    • Restore
    • View

    itemName

    string

    Specifies the name of the restored item.

    itemType

    string

    Specifies the type of the restored item.

    itemSizeBytes

    long

    Specifies the size of the restored item.

    source

    string

    Specifies the source path of the restored item.

    target

    string

    Specifies the target path for the item restore.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/Events/755d207e-ebd6-49da-9943-3b9e5eb31dee

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

         "itemName": "commonName",

         "itemType": "Site",

         "itemSizeBytes": 0,

         "source": "commonName/sites/commonName",

         "target": "https://company.sharepoint.com/sites/commonName_restored",

         "id": "9dc6426b-4630-4645-97a9-d7921daaac65",

         "type": "Restore",

         "status": "Success",

         "startTime": "2019-03-15T19:51:11.6624545Z",

         "endTime": "2019-03-15T20:00:18.0118225Z",

         "duration": "00:09:06.3493680",

         "title": "Site is successfully restored.",

         "message": "Item commonName was restored successfully (type: Site; source: commonName/sites/commonName; target: https://company.sharepoint.com/sites/commonName_restored)",

         "order": 17,

         "_links": {

           "self": {

             "href": "https://localhost:4443/v5/RestoreSessions/e8327633-48d6-41a3-ab11-5588182f8e67/events/9dc6426b-4630-4645-97a9-d7921daaac65"

           },

           "restoreSession": {

             "href": "https://localhost:4443/v5/RestoreSessions/e8327633-48d6-41a3-ab11-5588182f8e67"

           }

         }

       }

    I want to report a typo

    There is a misspelling right here:

     

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