Aggregate Outputs



QueryOutputAggregateBase

Interits from: QueryOutputBase

The aggregate output base type. Defines the common schema elements of the aggregation outputs.

Name Type Required Description
Filter Query element of type:
QueryFilterBase
no The filter rules. Allows for the specification of entity filter expressions.
Name xsd:string no The output name. Used to identify the output target. Variable names are allowed.
Negate xsd:boolean no The negate option. Indicates that the aggregation result should be negated.

Avg

Interits from: QueryOutputAggregateBase

The aggregate output average type. Used to output the average value of the specified property.

Supported property data types:

  • Integer
  • Decimal

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.

Count

Interits from: QueryOutputAggregateBase

The aggregate output count type. Outputs the number of matched entities.

Name Type Required Description

ExpressionCalculator

Interits from: QueryOutputAggregateBase

The aggregate output expression calculator type. Used to output the results of simple mathematical expressions.

Supported symbols: plus +, minus -, divide / and multiply *

Use of property names, variable name and constant values is allowed. Example: Property * [Variable] - 10

Supported property data types:

  • Integer
  • Decimal

Name Type Required Description
Expression xsd:string
Pattern: [\[\]\.\-\/a-zA-Z0-9+*$ ]+
no The aggregation expression. A simple expression following this pattern: 1 + 2 - 3 / 4 * 10.9. Variable names are allowed.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.
Min xsd:string no The minimum result value. Used to ensure the returned value is not less than the specified minimum. Variable Names are allowed.
Max xsd:string no The minimum result value. Used to ensure the returned value is not less than the specified minimum. Variable Names are allowed.
Rounding RoundingOption no The rounding option value. Used to indicate how the expression result is rounded. Variable names are not supported.

Max

Interits from: QueryOutputAggregateBase

The aggregate output maximum type. Used to output the maximum value of the specified property across the selected entities.

Supported property data types:

  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.

Min

Interits from: QueryOutputAggregateBase

The aggregate output minimum type. Used to output the minimum value of the specified property across the selected entities.

Supported property data types:

  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.

Sum

Interits from: QueryOutputAggregateBase

The aggregate output sum type. Used to output the sum value of the specified property across the selected entities.

Supported property data types:

  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.
DefaultValue xsd:string no The default result value. Used to apply a default output value in the event of the property being null.

Distinct

Interits from: QueryOutputAggregateBase

The aggregate output distinct type. Used to output the a distinct CSV list of values from specified property across the selected entities.

Supported property data types:

  • Decimal
  • Integer
  • DateTime
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the aggregated result.