Get entities created for protection rule

Retrieves the entities created for protection rule

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• id int32

  This is protection rule id

• name string

  This is protection rules name

• clients object[]

  clientId int32

  clientName string

  entityType string

  Possible values: [COMMCELL, CLIENT, INSTANCE, BACKUPSET, SUBCLIENT, CLIENT_GROUP, USER, USER_GROUP, LIBRARY, MEDIAAGENT, RESOURCEPOOL, STORAGE_POOL, STORAGE_POLICY, SCHEDULE_POLICY, SUBCLIENT_POLICY, ALERT, PLAN, VIRTUAL_MACHINE, ROLE, DEVICE, REGION, NETWORK_TOPOLOGY, COMPANY]

  entities object[]

  subclientId int32

  subclientName string

  backupsetId int32

  backupsetName string

  instanceId int32

  instanceName string

  appId int32

  appName string

  clientId int32

  clientName string

  workloadId int32

  workloadName string

  entityType string

  Possible values: [COMMCELL, CLIENT, INSTANCE, BACKUPSET, SUBCLIENT, CLIENT_GROUP, USER, USER_GROUP, LIBRARY, MEDIAAGENT, RESOURCEPOOL, STORAGE_POOL, STORAGE_POLICY, SCHEDULE_POLICY, SUBCLIENT_POLICY, ALERT, PLAN, VIRTUAL_MACHINE, ROLE, DEVICE, REGION, NETWORK_TOPOLOGY, COMPANY]

  workloads object[]

  solution object

  solution details

  id int32

  name string

  workload object

  workload details

  id int32

  name string

  workloadOptions object

  credential object

  id int32

  name string

  isRapidRecovery boolean

  isLongTermRetention boolean

  plan object

  id int32

  name string

{
  "id": 0,
  "name": "string",
  "clients": [
    {
      "clientId": 0,
      "clientName": "string",
      "entityType": "COMMCELL",
      "entities": [
        {
          "subclientId": 0,
          "subclientName": "string",
          "backupsetId": 0,
          "backupsetName": "string",
          "instanceId": 0,
          "instanceName": "string",
          "appId": 0,
          "appName": "string",
          "clientId": 0,
          "clientName": "string",
          "workloadId": 0,
          "workloadName": "string",
          "entityType": "COMMCELL"
        }
      ],
      "workloads": [
        {
          "solution": {
            "id": 0,
            "name": "string"
          },
          "workload": {
            "id": 0,
            "name": "string"
          },
          "workloadOptions": {
            "credential": {
              "id": 0,
              "name": "string"
            },
            "isRapidRecovery": true,
            "isLongTermRetention": true
          }
        }
      ],
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Loading...