Fetch plan rules details.

Api to fetch plan rules details.

Path Parameters

• ruleId int32 required

  Id of the rule to update in Plan

Responses

• 200
• 404
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• 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

{
  "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"
  }
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

GET /v4/plan/rule/:ruleid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

ruleId — path required

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

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

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

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

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

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

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