Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT EAP

Response structure

  • Last UpdatedApr 14, 2026
  • 1 minute read

SummaryResponse

Field

Type

Description

Summaries

repeated ResourceSummary

One entry per group. A single entry (no group fields populated) when no grouping is requested.

SummaryErrors

repeated SummaryError

Partial-failure details. The response is still returned even when errors exist.

Metrics

OperationMetrics (optional)

Includes UnauthorizedGroupCount when some resources were excluded for authorization reasons.

Context

ResponseContext

Standard response context.

ResourceSummary

message ResourceSummary {
repeated GroupByPropertyType GroupProperties = 1; // populated when GroupByProperties used
repeated GroupByRelationshipType GroupRelationships = 2; // populated when GroupByRelationships used
repeated string InRelationshipGroups = 3; // populated when InRelationshipGroups used

uint32 Count = 4; // total resources in this group

repeated PropertySummary PropertySummaries = 5; // one per PropertiesToSummarize entry that succeeded
}

Count is the total number of resources in the group — including those that did not have a numeric value for the requested property. PropertySummary.Count may therefore be lower than ResourceSummary.Count when some resources lacked a value or had a non-numeric value for that property.

PropertySummary

message PropertySummary {
string Id = 1; // property ID
string TypeId = 2; // component type ID, empty string for root properties
string Uom = 3; // unit of measure of returned values
uint32 Count = 4; // resources that contributed a numeric value
double Minimum = 5;
double Maximum = 6;
double Average = 7;
double Sum = 8;
}

Summary functions are fixed. The API always returns Count, Min, Max, Average, and Sum. There is no way to request a subset, and there are no additional functions (such as First, Last, Weighted Average) at this time.

In This Topic
Related Links