Get Plan Data

You can get a representation of a VAO plan with the specified ID.

Request

To retrieve a representation of a specific plan, send the HTTP GET request to the /Plans/{planId} endpoint.

Tip

VAO entity can be edited by another user while you are working with the VAO REST API. To define whether to include changes of the current editing session to the response, specify the includeEditingChanges parameter after the endpoint of the request URL: ?includeEditingChanges=true/false.

HTTP Request

GET https://<hostname>:<port>/api/v3/Plans/{planId}

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

  • application/xml
  • text/json
  • application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /Plans/{planId} resource. The RecoveryPlanInfo schema is used for the resource representation.

Get Plan DataExample

The following example returns an entity representation of a VAO plan with the ID cd47d232-44f6-4c1c-84e2-8033049a5cfa.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/Plans/cd47d232-44f6-4c1c-84e2-8033049a5cfa

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "success": true,

 "data":

  {

     "$id": "1",

     "id": "cd47d232-44f6-4c1c-84e2-8033049a5cfa",

     "planType": "Restore",

     "recoveryLocationId": "c0be2a24-b25d-41d1-b4d0-75615e01c60d",

     "serverId": "759c7afa-9ed0-4a60-8452-16bcfb5998d5",

     "siteScopeId": "a2e5219e-7883-45cd-9e87-ea0703367bd8",

     "siteScopeName": "Admin Scope",

     "name": "RestoreL02",

     "state": "Unpublished",

     "stateName": "Not Verified",

     "stateOrder": "410. Not Verified",

     "resultName": "Check or test required",

     "lastStableState": "Unpublished",

     "lastStableStateName": "Not Verified",

     "previousExecutionState": "TestStopping",

     "reportTemplateId": "2347caea-801a-4e90-9397-61be1074ad1d",

     "description": "Restore plan for L02 VMs",

     "reportDocumentFormat": "Pdf",

     "serverName": "win12-VAO.n.local",

     "siteName": "AutoLabSetup",

     "scheduleInfo": null,

     "nearestFailoverScheduleTime": null,

     "scheduledTestsInfo": [

       {

         "scheduleInfo": {

           "id": "23af7318-82c6-48ae-bfa4-c011e01ceb8e",

           "timeSchedule": {

             "scheduleMode": "Daily",

             "startTime": "2020-07-23T00:00:00Z",

             "time": {

               "hours": 10,

               "minutes": 20

             },

             "exactTime": null,

             "daysOfWeek": "None"

           },

           "runAfterItemId": null,

           "runAfterItemName": ""

         },

         "scheduleName": "TestRestL02",

         "scheduleDescription": "Restore plan for L02 Vms testing",

         "virtualLabId": "f290a2e5-7459-42f0-bdca-3c0debe2b4d9",

         "virtualLabName": "win12-v10lab-vic1",

         "backupServerName": "win12-vbr.n.local",

         "virtualLabWaitTimeMinutes": 0,

         "keepPlanRunning": true,

         "keepLabRunning": true,

         "recoveryTimeObjective": 60,

         "stopWhenRTOExceeded": true,

         "id": "55076913-0cd4-46dc-93cc-0a3d7c6c803e",

         "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa",

         "planName": "RestoreL02",

         "type": "ScheduleTest"

       }

     ],

     "nearestTestScheduleTime": "2020-07-24T10:20:00Z",

     "haltedReason": "Interrupt",

     "isEditingByCurrentUser": false,

     "currentEditingUser": "",

     "progress": 0,

     "lastTestResult": "Warning",

     "lastTestTime": "2020-07-23T10:16:19.2806538Z",

     "lastCheckResult": "Error",

     "lastCheckTime": "2020-07-23T10:13:19.1934602Z",

     "lastTestResultName": "Warning",

     "lastTestResultOrderNumber": 3,

     "lastCheckResultName": "Failed",

     "lastCheckResultOrderNumber": 2,

     "virtualLabId": null,

     "contactName": "Wendy May",

     "contactEmail": "wendy.may@veeam.com",

     "contactTel": "3232556666",

     "isRunningState": false,

     "isStableState": true,

     "currentRunResult": "Undefined",

     "currentTestResult": "Warning",

     "currentCheckResult": "Error",

     "definitionReportStartTime": "2020-07-23T04:00:00Z",

     "readinessCheckStartTime": "2020-07-23T05:00:00Z",

     "targetRecoveryTimeObjective": 120,

     "currentRecoveryTimeObjective": 0,

     "targetRecoveryPointObjective": 21000,

     "currentRecoveryPointObjective": 0,

     "roles": [

       "DRSiteAdmin"

     ]

   }

}

I want to report a typo

There is a misspelling right here:

 

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