Get Eligible Plans

This API returns a list of eligible plans that can be associated with an entity based on the provided filters.

Request Params

Name	Description
clientId	The ID of the client whose eligible plans are to be retrieved
backupSetId	The ID of the backupset whose eligible plans are to be retrieved
appId	The application ID whose eligible plans are to be retrieved.
subclientId	The ID of the subclient whose eligible plans are to be retrieved.

Response will contain a list of plan objects that are eligible to be associated with the specified params

Query Parameters

• clientId string
• appId string
• subclientId string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• G E T Eligible Plans

---

Schema

• plans object[]

  numCopies integer

  description string

  type integer

  numDevices integer

  subtype integer

  isElastic boolean

  numAssocEntities integer

  restrictions integer

  numCompanies integer

  planStatusFlag integer

  rpoInMinutes integer

  numUsers integer

  permissions object[]

  permissionId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  plan object

  planSubtype integer

  _type_ integer

  planType integer

  planSummary string

  planName string

  planId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  planOwner object

  _type_ integer

  userName string

  userId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

{
  "plans": [
    {
      "numCopies": 0,
      "description": "string",
      "type": 0,
      "numDevices": 0,
      "subtype": 0,
      "isElastic": true,
      "numAssocEntities": 0,
      "restrictions": 0,
      "numCompanies": 0,
      "planStatusFlag": 0,
      "rpoInMinutes": 0,
      "numUsers": 0,
      "permissions": [
        {
          "permissionId": 0,
          "entityInfo": {
            "companyId": 0,
            "companyName": "string",
            "multiCommcellId": 0
          }
        }
      ],
      "plan": {
        "planSubtype": 0,
        "_type_": 0,
        "planType": 0,
        "planSummary": "string",
        "planName": "string",
        "planId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "planOwner": {
        "_type_": 0,
        "userName": "string",
        "userId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    }
  ]
}

{
  "plans": [
    {
      "numCopies": 2,
      "description": "Server plan",
      "type": 2,
      "numDevices": 0,
      "subtype": 33554437,
      "isElastic": false,
      "numAssocEntities": 0,
      "restrictions": 1,
      "numCompanies": 0,
      "planStatusFlag": 0,
      "rpoInMinutes": 240,
      "numUsers": 0,
      "permissions": [
        {
          "permissionId": 31,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 157,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 158,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 159,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        }
      ],
      "plan": {
        "planSubtype": 33554437,
        "_type_": 158,
        "planType": 2,
        "planSummary": "RPOHours:4,NumberOfCopies:2,AssociatedEntitiesCount:0,PrimaryStorageType:Disk",
        "planName": "Server plan",
        "planId": 1,
        "entityInfo": {
          "companyId": 0,
          "companyName": "",
          "multiCommcellId": 0
        }
      },
      "planOwner": {
        "_type_": 13,
        "userName": "Administrator",
        "userId": 1,
        "entityInfo": {
          "companyId": 0,
          "companyName": "",
          "multiCommcellId": 0
        }
      }
    },
    {
      "numCopies": 2,
      "description": "Common Plan",
      "type": 2,
      "numDevices": 0,
      "subtype": 33554437,
      "isElastic": false,
      "numAssocEntities": 2,
      "restrictions": 1,
      "numCompanies": 0,
      "planStatusFlag": 0,
      "rpoInMinutes": 40320,
      "numUsers": 0,
      "permissions": [
        {
          "permissionId": 31,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 157,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 158,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        },
        {
          "permissionId": 159,
          "entityInfo": {
            "companyId": 0,
            "companyName": "",
            "multiCommcellId": 0
          }
        }
      ],
      "plan": {
        "planSubtype": 33554437,
        "_type_": 158,
        "planType": 2,
        "planSummary": "RPOHours:672,NumberOfCopies:2,AssociatedEntitiesCount:2,PrimaryStorageType:Disk",
        "planName": "Common Plan",
        "planId": 487,
        "entityInfo": {
          "companyId": 0,
          "companyName": "",
          "multiCommcellId": 0
        }
      },
      "planOwner": {
        "_type_": 13,
        "userName": "Administrator",
        "userId": 1,
        "entityInfo": {
          "companyId": 0,
          "companyName": "",
          "multiCommcellId": 0
        }
      }
    }
  ]
}

Loading...