View Plan Details (REST API: GET)

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

Request Headers

Response

Response Parameters

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      ]    }  }

}