Getting Restore Session Event by Event ID
You can get a list of properties for the specified event of a restore session with the specified ID.
Request
GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Events/{eventId} |
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 |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
eventId | string | Specifies the identification number of the restore session event. For more information on how to get this parameter, see Getting Restore Session Events. |
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/{eventId} resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
itemName | string | Specifies the name of the restored item. |
itemType | string | Specifies the type of the restored item. |
itemSizeBytes | integer | 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. |
id | string | Specifies the ID of the restore session event. |
type | string | Specifies the type of the restore session event. The following types are available:
|
startTime | UTC | Specifies date and time when the restore session started. |
endTime | UTC | Specifies date and time when the restore session ended. |
status | string | Specifies the status of the restore session. The following values are available:
|
duration | string | Specifies the duration of the restore session. |
message | string | Specifies the message of the restore session event. |
title | string | Specifies the restore session event title. |
order | integer | Specifies the order number of the restore session event. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the restore session event with the ID 635b22cf-9cdc-4004-9160-9b90f90f1bbf.
Request: GET https://abc.tech.local:4443/v6/RestoreSessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/Events/6c0ef726-a284-422d-be63-ed31f92b9953
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "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" } } } |