Get entities applicable for plan association

API to fetch list of entities that are applicable for plan association via plan assignment rules.

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• entities object[]

  Details of entity applicable for plan association.

  subclient object

  id int32

  name string

  backupset object

  id int32

  name string

  instance object

  id int32

  name string

  client object

  id int32

  name string

  apptype object

  id int32

  name string

  evaluatedPlan object

  id int32

  name string

  currentPlan object

  id int32

  name string

  ruleDetails object

  This object will hold each plan rule details.

  rule object

  id int32

  name string

  plan object

  id int32

  name string

  workloads object[]

  This will include list of apptypes that should be evaluated against workload for plan association

  id int32

  name string

  regions object[]

  This will include list of regions that should be evaluated against workload region for plan association

  id int32

  name string

  tags object[]

  This will include list of tags that should be evaluated against workload tags (if any) for plan association

  id int32

  Id for the tag

  name string

  Name for the plan rule tag which need to be matched against tag of the workload.

  value string

  Possible value that need to matched against value of tag associated to workload.

  serverGroups object[]

  This will include list of Server groups that should be evaluated against workload server group for plan association

  id int32

  name string

  rank int32

  This will suggest rank/priority of the plan rule.

  solutions object[]

  This will include list of solutions that should be evaluated against workload for plan association.

  id int32

  name string

  company object

  id int32

  name string

{
  "entities": [
    {
      "subclient": {
        "id": 0,
        "name": "string"
      },
      "backupset": {
        "id": 0,
        "name": "string"
      },
      "instance": {
        "id": 0,
        "name": "string"
      },
      "client": {
        "id": 0,
        "name": "string"
      },
      "apptype": {
        "id": 0,
        "name": "string"
      },
      "evaluatedPlan": {
        "id": 0,
        "name": "string"
      },
      "currentPlan": {
        "id": 0,
        "name": "string"
      },
      "ruleDetails": {
        "rule": {
          "id": 0,
          "name": "string"
        },
        "plan": {
          "id": 0,
          "name": "string"
        },
        "workloads": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "regions": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "tags": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "serverGroups": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "rank": 0,
        "solutions": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "company": {
          "id": 0,
          "name": "string"
        }
      }
    }
  ]
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

GET /v4/plan/rule/entities    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'