Get Aggregate count of Entity

Select

SaaS

Customer Managed

Get aggregate count of entity

Path Parameters

• globalSearchEntity string required

  Possible values: [SERVER, FILESERVER, ARCHIVESERVER, EPIC_CLIENT, DEVICE, USER, USERGROUP, ROLE, SERVERGROUP, PLAN, COMPANY, VMGROUPS, VM, HYPERVISOR, KUBERNETES_APPLICATION, KUBERNETES_APPLICATION_GROUP, KUBERNETES_CLUSTER, DATABASES, DBINSTANCE]

  name of global search entity

Query Parameters

• fq string

  Filter criteria to filter out global search entities

• groupBy string

  comma-separated list of entity response attributes based on which aggregate results would be grouped

• func string required

  Possible values: [COUNT, MIN, MAX, AVG, SUM]

  aggregation function to be applied.

• aggregateOn string

  attribute on which aggregation function would be applied.

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)
• / V4/ V M/aggregate?fq=vm Status Info List.vm Status:eq:1&group By=vendor,sla Status&func= C O U N T

---

Schema

• aggregation object[]

  funcValue string

  value returned by aggregation function for global search entities for a particular group

  groupByVals object[]

  list of groupby attribute's Name and value pair.

  name string

  value string
• commcellName string

{
  "aggregation": [
    {
      "funcValue": "string",
      "groupByVals": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "commcellName": "string"
}

{
  "aggregation": [
    {
      "funcValue": "3",
      "groupByVals": [
        {
          "name": "vendor",
          "value": "4"
        },
        {
          "name": "slaStatus",
          "value": "1"
        }
      ]
    },
    {
      "funcValue": "3",
      "groupByVals": [
        {
          "name": "vendor",
          "value": "1"
        },
        {
          "name": "slaStatus",
          "value": "1"
        }
      ]
    },
    {
      "funcValue": "2",
      "groupByVals": [
        {
          "name": "vendor",
          "value": "1"
        },
        {
          "name": "slaStatus",
          "value": "2"
        }
      ]
    }
  ]
}

requested details not found.

Loading...