This operation returns the details of entities that are associated with a plan.
Request
Syntax
GET <webservice>/v2/Plan/{planId}/AssociatedEntities 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 Parameters
Name | Description | Required |
|---|---|---|
planId | The system-generated ID of 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 information about receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element | |||
|---|---|---|---|---|---|
snapSubclients | The number of snap subclients associated with a plan. | associatedEntitiesCount | |||
allClients | The number of clients of an application type that are associated with a plan. | associatedEntitiesCount | |||
count | The number of clients. | allClients | |||
appType | The application type of a client. | allClients | |||
_type_ | The type of CommCell object that is associated with an application type. | appType | |||
appName | The name of the application. | appType | |||
applicationId | The system-generated ID of the application. | appType | |||
subclientId | The system-generated ID of the subclient. | entities | |||
applicationId | The system-generated ID of the application. | entities | |||
otherSubclients | The subclient of an application type that is associated with a plan. | associatedEntitiesCount | |||
count | The number of subclients that are associated with a plan. | otherSubClients | |||
appType | The application type of a subclient. | otherSubClients | |||
_type_ | The type of CommCell object that is associated with a subclient. | otherSubClients\appType | |||
appName | The name of the application that is associated with a subclient. Valid values are:
| otherSubClients\appType | |||
applicationId | The ID of the application that is associated with a subclient. For a list of application IDs, see the valid values for the appName parameter. | otherSubClients\appType | |||
entities | The entity object that is associated with a plan. | associatedEntitiesCount | |||
clientName | The name of the client. | entities | |||
displayName | The display name of the client. | entities | |||
instanceId | The system-generated ID of the instance. | entities | |||
clientId | The system-generated ID of the client. | entities | |||
backupsetName | The name of the backup set. | entities | |||
instanceName | The name of the instance. | entities | |||
_type_ | The type of CommCell object that is associated with an entity. | entities | |||
appName | The name of the application. | entities | |||
planEntities | The Number of entities that are associated with a plan. | associatedEntitiesCount | |||
entity | The entity that is associated with a plan. | planEntities | |||
subclientId | The system-generated ID of the subclient that is associated with an entity. | planEntities\entity | |||
applicationId | The ID of the entity application that is associated with a plan. | planEntities\entity | |||
clientName | The name of the client. | planEntities\entity | |||
displayName | The display name of the client. | planEntities\entity | |||
backupsetId | The system-generated ID of the backup set that is associated with an entity. | planEntities\entity | |||
InstanceId | The system-generated ID of the instance. | planEntities\entity | |||
clientId | The system-generated ID of the client. | planEntities\entity | |||
backupsetName | The name of the backup set. | planEntities\entity | |||
instanceName | The name of the instance. | planEntities\entity | |||
_type_ | The type of CommCell object that is associated with a plan. Valid values are:
| planEntities\entity | |||
appName | The name of the application. | planEntities\entity |
Examples
Sample Request
GET <webservice>/V2/Plan/20/AssociatedEntities HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7fSample Response
{
"associatedEntitiesCount": {
"snapSubclients": 0,
"allClients": [
{
"count": 1,
"appType": {
"appName": "File System",
"_type_": 4,
"applicationId": 33
}
}
],
"otherSubclients": [
{
"count": 1,
"appType": {
"appName": "File System",
"_type_": 4,
"applicationId": 33
}
}
]
},
"entities": [
{
"subclientId": 0,
"applicationId": 33,
"clientName": "client_name1",
"displayName": "DN_samplename1",
"backupsetId":2195,
"instanceId":1,
"clientId":2,
"backupsetName":"fs-sub1",
"instanceName":"DefaultInstanceName",
"_type_":6,
"appName":"File System"
},
{
"subclientId":2231,
"applicationId":33,
"clientName":"client_name2",
"displayName":"DN_samplename2",
"backupsetId":2195,
"instanceId":1,
"clientId":2,
"subclientName":"default",
"backupsetName":"fs-sub1",
"instanceName":"DefaultInstanceName",
"_type_": 7,
"appName":"File System"
}
],
"planEntities": [
{
"entity": {
"subclientId":0,
"applicationId":33,
"clientName":"client_name1,
"displayName":"DN_samplename1",
"backupsetId":2195,
"instanceId":1,
"clientId":2,
"backupsetName":"fs-sub1",
"instanceName":"DefaultInstanceName",
"_type_":6,
"appName":"File System"
}
},
{
"entity": {
"subclientId":2231,
"applicationId":33,
"clientName":"client_name2",
"displayName":"DN_samplename2",
"backupsetId":2195,
"instanceId":1,
"clientId":2,
"subclientName":"default",
"backupsetName":"fs-sub1",
"instanceName":"DefaultInstanceName",
"_type_":7,
"appName":"File System"
}
}
]
}