Skip to main content

Filterapiv1

filterConstraints object[]

A JSON array of constraints.

  • Array [
  • dataFieldTypestring

    Description for dataFieldType in FilterConstraintsApiV1

    dataItemTypestring

    The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.

    filterElementstring

    The constraint operator.

    filterSelectionstring

    The field on which the constraint will be applied.

    secondValuestring

    The constraint second value. Required for filter elements with two values.

    valuestring

    The constraint value. Required for filter elements with one or two values.

    valuesstring[]

    An array of values.

  • ]
  • sortDetails object

    Description for sortDetails in FilterApiV1

    dataFieldTypestring

    Description for dataFieldType in SortDetailsApiV1

    dataItemTypestring

    Description for dataItemType in SortDetailsApiV1

    sortingColumnstring

    Description for sortingColumn in SortDetailsApiV1

    sortingOrderstring

    Description for sortingOrder in SortDetailsApiV1

    Filterapiv1
    {
    "filterConstraints": [
    {
    "dataFieldType": "string",
    "dataItemType": "string",
    "filterElement": "string",
    "filterSelection": "string",
    "secondValue": "string",
    "value": "string",
    "values": [
    "string"
    ]
    }
    ],
    "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
    }
    }