Child pages
  • Admin API Complex Type orderedField

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
The orderedField class holds a field to order a query by, together with the direction of the ordering.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.

Component

Type

Occurs

Description

aggregationFunction

aggregation

0..1

Either null, or (if specified) the aggregationFunction associated with the aggregated query

fieldName

string

0..1

The field name to order by

sortOrder

resultOrder

0..1

The direction to order by (ascending or descending)

Remarks
The orderedField complex type is used within a queryLimit complex type to specify the sort order of the results returned. Each orderedField specifies a field name and a sort order, and the queryLimit contains an array of orderedField complex types, which are composed to generate a sort order.
The fieldName is the name of the field, being the member variable name within the relevant returned complex type. The sortOrder is an enum of type resultOrder; using a sortOrder of ASC sorts that field in ascending order, and a sortOrder of DESC sorts it in descending order.

  • No labels