Get Plan Associations

Select

SaaS

Customer Managed

Path Parameters

PlanId string required

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

associatedEntitiesCount object
snapSubclients integer
allClients object[]
count integer
appType object
appName string
_type_ integer
applicationId integer
otherSubclients object[]
count integer
appType object
appName string
_type_ integer
applicationId integer
entities object[]
subclientId integer
applicationId integer
clientName string
displayName string
backupsetId integer
instanceId integer
clientId integer
subclientName string
backupsetName string
instanceName string
_type_ integer
appName string
planEntities object[]
entity object
subclientId integer
applicationId integer
clientName string
displayName string
backupsetId integer
instanceId integer
clientId integer
subclientName string
backupsetName string
instanceName string
_type_ integer
appName string

{
  "associatedEntitiesCount": {
    "snapSubclients": 0,
    "allClients": [
      {
        "count": 0,
        "appType": {
          "appName": "string",
          "_type_": 0,
          "applicationId": 0
        }
      }
    ],
    "otherSubclients": [
      {
        "count": 0,
        "appType": {
          "appName": "string",
          "_type_": 0,
          "applicationId": 0
        }
      }
    ]
  },
  "entities": [
    {
      "subclientId": 0,
      "applicationId": 0,
      "clientName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "instanceId": 0,
      "clientId": 0,
      "subclientName": "string",
      "backupsetName": "string",
      "instanceName": "string",
      "_type_": 0,
      "appName": "string"
    }
  ],
  "planEntities": [
    {
      "entity": {
        "subclientId": 0,
        "applicationId": 0,
        "clientName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "subclientName": "string",
        "backupsetName": "string",
        "instanceName": "string",
        "_type_": 0,
        "appName": "string"
      }
    }
  ]
}

{
  "associatedEntitiesCount": {
    "snapSubclients": 0,
    "allClients": [
      {
        "count": 1,
        "appType": {
          "appName": "File System",
          "_type_": 4,
          "applicationId": 29
        }
      },
      {
        "count": 2,
        "appType": {
          "appName": "File System",
          "_type_": 4,
          "applicationId": 33
        }
      },
      {
        "count": 1,
        "appType": {
          "appName": "Exchange Mailbox",
          "_type_": 4,
          "applicationId": 137
        }
      }
    ],
    "otherSubclients": [
      {
        "count": 1,
        "appType": {
          "appName": "File System",
          "_type_": 4,
          "applicationId": 29
        }
      },
      {
        "count": 2,
        "appType": {
          "appName": "File System",
          "_type_": 4,
          "applicationId": 33
        }
      }
    ]
  },
  "entities": [
    {
      "subclientId": 6725,
      "applicationId": 33,
      "clientName": "dm2perf4",
      "displayName": "dm2perf4_DN",
      "backupsetId": 6651,
      "instanceId": 1,
      "clientId": 2,
      "subclientName": "53287_subclient",
      "backupsetName": "53287_backupset",
      "instanceName": "DefaultInstanceName",
      "_type_": 7,
      "appName": "File System"
    },
    {
      "subclientId": 6586,
      "applicationId": 29,
      "clientName": "dm2perf4_centos7",
      "displayName": "dm2perf4_centos7_DN",
      "backupsetId": 6518,
      "instanceId": 1,
      "clientId": 4,
      "subclientName": "backup_tmp",
      "backupsetName": "My_Backupset",
      "instanceName": "DefaultInstanceName",
      "_type_": 7,
      "appName": "File System"
    },
    {
      "subclientId": 0,
      "applicationId": 29,
      "clientName": "yashgdprcentos_2",
      "displayName": "yashgdprcentos_2_DN",
      "backupsetId": 0,
      "instanceId": 0,
      "clientId": 27,
      "_type_": 3,
      "appName": "File System"
    },
    {
      "subclientId": 6550,
      "applicationId": 33,
      "clientName": "dm2perf4_winis",
      "displayName": "dm2perf4_winis_DN",
      "backupsetId": 6483,
      "instanceId": 1,
      "clientId": 31,
      "subclientName": "53287_subclient",
      "backupsetName": "53287_backupset",
      "instanceName": "DefaultInstanceName",
      "_type_": 7,
      "appName": "File System"
    },
    {
      "subclientId": 0,
      "applicationId": 33,
      "clientName": "bhushan-pc_2",
      "displayName": "bhushan-pc_2_DN",
      "backupsetId": 0,
      "instanceId": 0,
      "clientId": 28,
      "_type_": 3,
      "appName": "File System"
    },
    {
      "subclientId": 0,
      "applicationId": 137,
      "clientName": "Test",
      "displayName": "Test_DN",
      "backupsetId": 0,
      "instanceId": 0,
      "clientId": 117,
      "_type_": 3,
      "appName": "Exchange Mailbox"
    },
    {
      "subclientId": 0,
      "applicationId": 33,
      "clientName": "bhushan-pc_2",
      "displayName": "bhushan-pc_2_DN",
      "backupsetId": 102,
      "instanceId": 1,
      "clientId": 28,
      "backupsetName": "defaultBackupSet",
      "instanceName": "DefaultInstanceName",
      "_type_": 6,
      "appName": "File System"
    }
  ],
  "planEntities": [
    {
      "entity": {
        "subclientId": 6725,
        "applicationId": 33,
        "clientName": "dm2perf4",
        "displayName": "dm2perf4_DN",
        "backupsetId": 6651,
        "instanceId": 1,
        "clientId": 2,
        "subclientName": "53287_subclient",
        "backupsetName": "53287_backupset",
        "instanceName": "DefaultInstanceName",
        "_type_": 7,
        "appName": "File System"
      }
    },
    {
      "entity": {
        "subclientId": 6586,
        "applicationId": 29,
        "clientName": "dm2perf4_centos7",
        "displayName": "dm2perf4_centos7_DN",
        "backupsetId": 6518,
        "instanceId": 1,
        "clientId": 4,
        "subclientName": "backup_tmp",
        "backupsetName": "My_Backupset",
        "instanceName": "DefaultInstanceName",
        "_type_": 7,
        "appName": "File System"
      }
    },
    {
      "entity": {
        "subclientId": 0,
        "applicationId": 29,
        "clientName": "yashgdprcentos_2",
        "displayName": "yashgdprcentos_2_DN",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 27,
        "_type_": 3,
        "appName": "File System"
      }
    },
    {
      "entity": {
        "subclientId": 6550,
        "applicationId": 33,
        "clientName": "dm2perf4_winis",
        "displayName": "dm2perf4_winis_DN",
        "backupsetId": 6483,
        "instanceId": 1,
        "clientId": 31,
        "subclientName": "53287_subclient",
        "backupsetName": "53287_backupset",
        "instanceName": "DefaultInstanceName",
        "_type_": 7,
        "appName": "File System"
      }
    },
    {
      "entity": {
        "subclientId": 0,
        "applicationId": 33,
        "clientName": "bhushan-pc_2",
        "displayName": "bhushan-pc_2_DN",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 28,
        "_type_": 3,
        "appName": "File System"
      }
    },
    {
      "entity": {
        "subclientId": 0,
        "applicationId": 137,
        "clientName": "Test",
        "displayName": "Test_DN",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 117,
        "_type_": 3,
        "appName": "Exchange Mailbox"
      }
    },
    {
      "entity": {
        "subclientId": 0,
        "applicationId": 33,
        "clientName": "bhushan-pc_2",
        "displayName": "bhushan-pc_2_DN",
        "backupsetId": 102,
        "instanceId": 1,
        "clientId": 28,
        "backupsetName": "defaultBackupSet",
        "instanceName": "DefaultInstanceName",
        "_type_": 6,
        "appName": "File System"
      }
    }
  ]
}

GET /v2/plan/:planid/associatedentities

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

PlanId — path required

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

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

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

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

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

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

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

Get Plan Associations​

Authorization

Request

Get Plan Associations