Getting Retrieval Jobs

In this article

You can get a resource representation of a retrieval job with the specified ID.

Request

GET https://<hostname>:4443/v6/DataRetrievals/{dataRetrievalId}

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
dataRetrievalId	string	Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Getting Retrieval 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

The response body contains the following properties:

Property	Type	Description
id	string	Specifies the retrieval job ID.
name	string	Specifies a name of the retrieval job.
description	string	Specifies a description of the retrieval job.
storageType	string	Specifies the type of the archive object storage. The following types are available: AzureArchive AmazonS3Glacier
amazonS3GlacierRetrievalPolicy	string	Specifies the retrieval policy that is selected for Amazon S3 Glacier and Amazon S3 Glacier Deep Archive object storage. The following values are available: Expedited Standard Bulk
azureArchiveRetrievalPolicy	string	Specifies the retrieval policy that is selected for Azure Archive Storage. The following values are available: StandardPriority HighPriority
pointInTime	UTC	Specifies point in time that you want to retrieve from a backup repository extended with an archive object storage.
retrievedRestorePointId	string	Specifies the retrieved restore point ID.
organizationId	string	Specifies the backed-up organization ID.
organizationUniqueId	string	Specifies the backed-up organization unique ID.
proxyId	string	Specifies the backup proxy ID.
repositoryId	string	Specifies the backup repository extended with an archive object storage ID.
dataState	string	Specifies the status of the archived data. The following values are available: Retrieving Retrieved ChangingAvailabilityPeriod Removing
lastStatus	string	Specifies the latest status of the retrieval job. The following values are available: Stopped Running Success Warning Failed NotConfigured
startTime	UTC	Specifies date and time when the retrieval job started.
expirationTime	UTC	Specifies date and time when the retrieved data becomes unavailable.
enableExpirationNotification	boolean	If set to true, indicates that Veeam Backup for Microsoft 365 sends a notification by email before the retrieved data expires.
expirationHoursThreshold	integer	Specifies how many hours should remain before the retrieved data expires to send a notification by email. Use this property only with the enableExpirationNotification property.
type	string	Specifies the retrieval job type. The following types are available: Exchange SharePoint OneDrive Teams
showDeleted	boolean	Defines if the data retrieval session will show items that have been removed by the user before the specified point in time.
showAllVersions	boolean	Defines if the data retrieval session will show all versions of items that have been modified by the user before the specified point in time.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).
_actions	Dictionary of string [key] and Object [value]	Links to related actions (navigation property).

Example

The example returns a resource representation of the retrieval job with the ID b75d54e8-4c0b-45ab-90ef-a64e2411e1ee.

Request:

GET https://abc.tech.local:4443/v6/DataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"name": "SharePoint data retrieval",

"description": "",

"storageType": "AzureArchive",

"id": "b75d54e8-4c0b-45ab-90ef-a64e2411e1ee",

"pointInTime": "2022-01-24T12:38:20.947749Z",

"retrievedRestorePointId": "f93dc1b5-5ecd-45ce-b4dd-5519160b67139182f72f-394b-4e35-b1f0-a90e6946c095",

"organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b",

"organizationUniqueId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

"proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6",

"repositoryId": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713",

"dataState": "Retrieved",

"lastStatus": "Success",

"startTime": "2022-01-27T13:36:18.6775319Z",

"expirationTime": "2022-01-29T14:27:52.0669381Z",

"enableExpirationNotification": true,

"expirationHoursThreshold": 1,

"type": "SharePoint",

"showDeleted": true,

"showAllVersions": true,

"_links": {

"self": {

"href": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee"

"retrievedRestorePoint": {

"href": "v6/restorePoints/f93dc1b5-5ecd-45ce-b4dd-5519160b67139182f72f-394b-4e35-b1f0-a90e6946c095"

"organization": {

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

"proxy": {

"href": "v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6"

"backupRepository": {

"href": "v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713"

"sites": {

"href": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee/sites"

}

"_actions": {

"update": {

"uri": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee",

"method": "PUT"

}

"azureArchiveRetrievalPolicy": "HighPriority"

}