Get Rule Fields
Get Rule Fields
Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
filter
Response
OK
Whether null values are allowed on the right side of the operator
false
Data type of the field (string, enum, date, boolean, number)
"enum"
Human-readable display name for UI
"Shipment Type"
Field name identifier used internally
"ShipmentType"
List of supported operator codes (legacy, use apiOperators instead)
API field name for RSQL filter construction
"shipmentType"
Comprehensive operator metadata with display text and RSQL syntax
Attribute scope (Shipment, ShipmentItem, ShipmentAndShipmentItem) for custom attributes only
"Shipment"
Field type for UI grouping (ShipmentField, ShipmentAttribute, ItemAttribute)
"ShipmentField"
Display value for the field type group header
"Shipment Fields"
Sort descriptor with query parameter format and ascending/descending values
Whether this field supports sorting in result sets
false
List of valid enumerated values for enum/list data types

