Skip to main content

Fetch plan rules list.​

Select

SaaS
Customer Managed

Api to fetch plan rules list.

Responses

OK

Schema
  • rules object[]

    list of rules

  • rule object
  • id int32
  • name string
  • plan object
  • id int32
  • GUID string
  • 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
  • GUID string
  • name string
  • tags object[]

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

  • GUID string

    GUID for the tag

  • 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
  • GUID string
  • 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
  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
GET /v4/plan/rule

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Rule' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'