Getting Restore Session Events

You can get a list of events for a restore session with the specified ID.

Request

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

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

restoreSessionId

string

Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

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 /RestoreSessions/{restoreSessionId}/Events collection resource.

Example

The example returns a list all events for the restore session with the ID d9d4d55d-d7d9-46b4-b5bf-dec5e5459184.

Request:

GET https://abc.tech.local:4443/v6/RestoreSessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/Events

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "_links": {

   "self": {

     "href": "/v6/RestoreSessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/Events?offset=0&limit=30"

   }

 },

 "results": [

   {

     "itemSizeBytes": 0,

     "id": "45963836-69ab-48b8-bc87-66de3b08937c",

     "type": "None",

     "status": "Success",

     "startTime": "2022-02-02T15:59:09.7680229Z",

     "endTime": "2022-02-02T15:59:09.7680229Z",

     "duration": "00:00:00",

     "title": "Restore session started",

     "message": "Restore session started",

     "order": 0,

     "_links": {

       "self": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/events/45963836-69ab-48b8-bc87-66de3b08937c"

       },

       "restoreSession": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184"

       }

     }

   },

   {

     "itemName": "Channel posts: General",

     "itemType": "Posts",

     "itemSizeBytes": 0,

     "source": "abc\\General (channel ID: 19:7b46f447c781408684308262df55feb4@thread.tacv2)",

     "target": "C:\\RestoreFolder",

     "id": "6c0ef726-a284-422d-be63-ed31f92b9953",

     "type": "Restore",

     "status": "Success",

     "startTime": "2022-02-02T16:00:05.7112267Z",

     "endTime": "2022-02-02T16:00:10.0444754Z",

     "duration": "00:00:04.3332487",

     "title": "Posts successfully restored (1 items restored)",

     "message": "Item Channel posts: General was restored successfully (type: Posts; source: abc\\General (channel ID: 19:7b46f447c781408684308262df55feb4@thread.tacv2); target: C:\\RestoreFolder)",

     "order": 1,

     "_links": {

       "self": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/events/6c0ef726-a284-422d-be63-ed31f92b9953"

       },

       "restoreSession": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184"

       }

     }

   },

   {

     "itemSizeBytes": 0,

     "id": "07d23b99-a0a8-42ef-ae09-df4885389c34",

     "type": "None",

     "status": "Success",

     "startTime": "2022-02-02T16:23:07.5643888Z",

     "endTime": "2022-02-02T16:23:07.5643888Z",

     "duration": "00:00:00",

     "title": "Restore session completed",

     "message": "Restore session completed",

     "order": 2,

     "_links": {

       "self": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/events/07d23b99-a0a8-42ef-ae09-df4885389c34"

       },

       "restoreSession": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184"

       }

     }

   }

 ],

 "setId": "00000000-0000-0000-0000-000000000000"

}