Get Summary of a Plan

Select

SaaS

Customer Managed

Get Summary of a Plan

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• plans object[]

  plan object

  id int32

  name string

  planType string

  Possible values: [Server, Laptop, FSIBMiVTL, ExchangeJournal, ExchangeUser, Office365, DataClassification, Archiver, CDM, ObjectStore, DLO, Database, Snap, FSServer, VSAServer, Dynamics365]

  parentPlan object

  id int32

  name string

  targetApp string[]

  Possible values: [NOT_AVAILABLE, FILE_STORAGE_OPTIMIZATION, SENSITIVE_DATA_GOVERNANCE, CASE_MANAGER, CONTENT_INDEXING, THREAT_ANALYSIS]

  This tells the content indexing target apps for data classification plans

  associatedEntities int32

  Count of associated entities for the plan

  RPO int32

  RPO in minutes for the plan

  numberOfCopies int32

  Number of copies for the plan

  status string

  Possible values: [ENABLED, DISABLED, INCOMPLETE, HIDDEN, BACKUP_DISABLED]

  missingEntities object[]

  For plans in incomplete state contains list of entities missing from the plan

  id int32

  name string

  resourcePool object[]

  This lists the various resource Pools of different app types associated with storage pools of plan

  id int32

  name string

  tags object[]

  Tags associated with this plan

  id int32

  name string

  value string

  company object

  id int32

  name string

  commcell string

  Tells which commcell this plan belongs to.

  derivable boolean

  Tells if this plan can be used to derive from and create a new child plan

  globalConfigInfo object

  Only applicable on Global CommCells

  id string

  name string

  commcells object[]

  List of Service CommCells where the global configuration is applied

  id int32

  name string

  guid string

  scope string

  The entity level at which the config is applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string used for filtering the scope

  applyOnAllCommCells boolean

  Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  isMarkedForDeletion boolean

  Indicates whether global configuration deletion has been started.

  status string
• plansCount int32

  Number of plans returned

{
  "plans": [
    {
      "plan": {
        "id": 0,
        "name": "string"
      },
      "planType": "Server",
      "parentPlan": {
        "id": 0,
        "name": "string"
      },
      "targetApp": [
        "NOT_AVAILABLE"
      ],
      "associatedEntities": 0,
      "RPO": 0,
      "numberOfCopies": 0,
      "status": "ENABLED",
      "missingEntities": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "resourcePool": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "company": {
        "id": 0,
        "name": "string"
      },
      "commcell": "string",
      "derivable": true,
      "globalConfigInfo": {
        "id": "string",
        "name": "string",
        "commcells": [
          {
            "id": 0,
            "name": "string",
            "guid": "string"
          }
        ],
        "scope": "string",
        "scopeFilterQuery": "string",
        "applyOnAllCommCells": true,
        "isMarkedForDeletion": true,
        "status": "string"
      }
    }
  ],
  "plansCount": 0
}

Requested Details not found

GET /v4/plan/summary    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Summary' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'