View Plan Details (REST API: GET)

Updated

This operation returns the details associated with a plan.

Request

Syntax

GET <webservice>/Plan/{planId} HTTP/1.1

Host: <host name>

Accept: {application/xml | application/json}

Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameter

Name

Description

Required

planId

The plan ID for the plan. If the plan ID is not known, use the GET Plan API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

slaInMinutes

The service level agreement for the plan. Enter the value in minutes.

summary

restrictions

summary

type

summary

slaInterval

summary

planStatusFlag

summary

numDevices

The number of devices protected by the plan.

summary

rpoInMinutes

The backup frequency for the plan. Enter the value in minutes.

summary

subtype

summary

numUsers

The number of users and user groups associated with the plan.

summary

permissionId

permissions

_type_

planOwner

userName

The name of the user who created the plan.

planOwner

userId

The system-generated ID assigned to the user who created the plan.

planOwner

planSubtype

Valid values are:

  • 33554437, server plans

  • 33554439, laptop plans

plan

_type_

plan

planType

plan

planName

The name of the plan.

plan

planId

The system-generated ID assigned to the plan.

plan

definesEntity

definesStorage

overrideEntity

definesStorage

userId

The system-generated ID assigned to the user who is part of the security association on the plan.

securityAssociations/associations/userOrGroup

_type_

securityAssociations/associations/userOrGroup

userName

The name of the user who is part of the security association on the plan.

securityAssociations/associations/userOrGroup

isCreatorAssociation

properties

_type_

role

roleId

The system-generated ID assigned to the role that is part of the security association on the plan.

securityAssociations/properties/role

roleName

The name of the role that is part of the security association on the plan.

securityAssociations/properties/role

isSealed

The option that indicated whether the plan is a base plan or not. Sealed plans cannot act as base plans.

Valid values are:

  • false, the plan is a base plan

  • true, the plan is not a base plan

inheritance

storagePolicyId

storagePolicy

definesEntity

definesSchedule

overrideEntity

definesSchedule

roleId

The system-generated ID assigned to the role created for the plan. A role is automatically created to group the features selected for the plan.

features/role

roleName

The name of the role created for the plan. A role is automatically created to group the features selected for the plan.

features/role

permissionId

The system-generated ID assigned to feature.

categoriesPermissionList

permissionName

The name of the feature.

Valid values are:

  • Archiving

  • DLP

  • Edge Drive

  • Laptop

categoriesPermissionList

categoryPermission

accessPolicies

definesEntity

definesAccessPolicies

overrideEntity

definesAccessPolicies

idatype

backupContent

backupsetId

backupSetEntity

definesEntity

definesSubclientWin

overrideEntity

definesSubclientWin

definesEntity

definesSubclientMac

overrideEntity

definesSubclientMac

definesEntity

definesSubclientLin

overrideEntity

definesSubclientLin

definesEntity

definesFeatures

overrideEntity

definesFeatures

definesEntity

definesDCPolicy

overrideEntity

definesDCPolicy

ruleId

operationWindow

alertName

The name of the alert on the plan.

alerts

alertId

The system-generated ID assigned to the alert on the plan.

alerts

taskId

schedule/task

slaInMinutes

database

rpoInMinutes

database

clientGroupId

clientGroup

clientGroupName

clientGroup

userGroupId

localUserGroup

userGroupName

localUserGroup

definesEntity

definesContentAnalyzerCloud

overrideEntity

definesContentAnalyzerCloud

definesEntity

definesAnalyticsIndexServer

overrideEntity

definesAnalyticsIndexServer

edgeDriveQuota

The amount of data in gigabytes that can be stored on the Edge Drive.

options

forcedArchiving

options

quota

The amount of data in gigabytes that can be backed up.

options

enableThrottle

The option to enable throttling. This must be set to true if you set values for the sendRate and recvRate parameters.

Valid value is true/false.

network

shareBandwidth

Valid value is true

throttle

sendRate

The amount of data in Kbps (kilobits per second) that can be sent. To set the sendRate parameter, the enableThrottle parameter must be set to true.

throttle

recvRate

The amount of data in Kbps (kilobits per second) that can be received. To set the recvRate parameter, the enableThrottle parameter must be set to true.

throttle

definesEntity

exchange/definesMBRetention

overrideEntity

exchange/definesMBRetention

definesEntity

exchange/definesMBCleanup

overrideEntity

exchange/definesMBCleanup

definesEntity

exchange/definesMBArchiving

overrideEntity

exchange/definesMBArchiving

definesEntity

exchange/definesMBJournal

overrideEntity

exchange/definesMBJournal

possible

definition

required

definition

Examples

Sample Request

GET <webservice>/Plan/20 HTTP/1.1

Host: client.mydomain.com

Accept: application/json

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{  "error": {},  "plan": {    "summary": {      "slaInMinutes": 1440,      "restrictions": 1,      "type": 2,      "slaInterval": 0,      "planStatusFlag": 0,      "numDevices": 0,      "rpoInMinutes": 1440,      "subtype": 33554439,      "numUsers": 0,      "permissions": [{        "permissionId": 1      }, {        "permissionId": 2      }, {        "permissionId": 3      }, {        "permissionId": 4      }, {        "permissionId": 5      }, {        "permissionId": 6      }, {        "permissionId": 26      }, {        "permissionId": 27      }, {        "permissionId": 29      }, {        "permissionId": 31      }, {        "permissionId": 118      }, {        "permissionId": 158      }, {        "permissionId": 159      }, {        "permissionId": 178      }, {        "permissionId": 215      }, {        "permissionId": 217      }],      "planOwner": {        "_type_": 13,        "userName": "Administrator",        "userId": 1      },      "plan": {        "planSubtype": 33554439,        "_type_": 158,        "planType": 2,        "planName": "Laptop plan",        "planId": 20      }    },    "definesStorage": {      "definesEntity": true,      "overrideEntity": 0    },    "securityAssociations": {      "associations": [{        "userOrGroup": [{          "userId": 1,          "_type_": 13,          "userName": "admin"        }],        "properties": {          "isCreatorAssociation": true,          "role": {            "_type_": 120,            "roleId": 10,            "roleName": "Plan Creator Role"          }        }      }],      "ownerAssociations": {}    },    "featureInfo": {      "edgedriveInfo": {},      "definesEdgeDriveInfo": {        "definesEntity": false,        "overrideEntity": 0      }    },    "inheritance": {      "isSealed": true    },    "storage": {      "storagePolicy": {        "storagePolicyId": 5      }    },    "definesSchedule": {      "definesEntity": true,      "overrideEntity": 0    },    "laptop": {      "features": {        "role": {          "roleId": 17,          "roleName": "Laptop plan features"        },        "categoryPermission": {          "categoriesPermissionList": [{            "permissionId": 145,            "permissionName": "Laptop"          }]        }      },      "accessPolicies": {        "categoryPermission": {}      },      "definesAccessPolicies": {        "definesEntity": false,        "overrideEntity": 0      },      "content": {        "backupContent": [{          "idatype": 2,          "subClientPolicy": {            "backupSetEntity": {              "backupsetId": 7            }          }        }, {          "idatype": 3,          "subClientPolicy": {            "backupSetEntity": {              "backupsetId": 8            }          }        }, {          "idatype": 4,          "subClientPolicy": {            "backupSetEntity": {              "backupsetId": 9            }          }        }],        "definesSubclientWin": {          "definesEntity": true,          "overrideEntity": 0        },        "definesSubclientMac": {          "definesEntity": true,          "overrideEntity": 0        },        "definesSubclientLin": {          "definesEntity": true,          "overrideEntity": 0        }      },      "users": {},      "definesFeatures": {        "definesEntity": true,        "overrideEntity": 0      }    },    "definesDCPolicy": {      "definesEntity": false,      "overrideEntity": 0    },    "operationWindow": {      "ruleId": 0    },    "alerts": {      "alerts": [{        "alertName": "No backup for last 4 days",        "alertId": 7      }, {        "alertName": "Restore Job failed",        "alertId": 8      }]    },    "replicationTargets": {},    "schedule": {      "task": {        "taskId": 47      }    },    "database": {      "slaInMinutes": 0,      "rpoInMinutes": 0,      "scheduleLog": {        "task": {}      },      "storageLog": {        "storagePolicy": {}      },      "definesScheduleLog": {        "definesEntity": false,        "overrideEntity": 0      },      "definesStorageLog": {        "definesEntity": false,        "overrideEntity": 0      }    },    "autoCreatedEntities": {      "clientGroup": {        "clientGroupId": 5,        "clientGroupName": "Laptop plan clients"      },      "localUserGroup": {        "userGroupId": 4,        "userGroupName": "Laptop plan users"      }    },    "eDiscoveryInfo": {      "definesContentAnalyzerCloud": {        "definesEntity": false,        "overrideEntity": 0      },      "definesAnalyticsIndexServer": {        "definesEntity": false,        "overrideEntity": 0      }    },    "options": {      "edgeDriveQuota": 0,      "forcedArchiving": false,      "quota": 0,      "network": {        "enableThrottle": true,        "throttle": {          "shareBandwidth": true,          "throttle": [{            "sendRate": 0,            "recvRate": 0          }]        }      }    },    "exchange": {      "definesMBRetention": {        "definesEntity": false,        "overrideEntity": 0      },      "definesMBCleanup": {        "definesEntity": false,        "overrideEntity": 0      },      "definesMBArchiving": {        "definesEntity": false,        "overrideEntity": 0      },      "definesMBJournal": {        "definesEntity": false,        "overrideEntity": 0      }    },    "definition": {      "possible": [        1,        2,        4,        8,        16,        32,        64,        128,        256,        512,        1024,        2048,        4096,        8192,        16384,        32768,        65536,        65537,        65538,        65539,        65540,        65541,        65542      ],      "required": [        1,        4,        8,        16,        256,        512,        1024,        2048      ]    }  }

}