Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

x-vol-site
integer<int32>
x-vol-tenant
integer<int32>
required

Query Parameters

filter
string

filter

Response

OK

allowNullOnRight
boolean
required

Whether null values are allowed on the right side of the operator

Example:

false

dataType
string
required

Data type of the field (string, enum, date, boolean, number)

Example:

"enum"

displayValue
string
required

Human-readable display name for UI

Example:

"Shipment Type"

fieldName
string
required

Field name identifier used internally

Example:

"ShipmentType"

supportedOperators
string[]
required

List of supported operator codes (legacy, use apiOperators instead)

Example:
apiFieldName
string

API field name for RSQL filter construction

Example:

"shipmentType"

apiOperators
RuleOperatorDto · object[]

Comprehensive operator metadata with display text and RSQL syntax

applicableTo
string

Attribute scope (Shipment, ShipmentItem, ShipmentAndShipmentItem) for custom attributes only

Example:

"Shipment"

ruleFieldType
string

Field type for UI grouping (ShipmentField, ShipmentAttribute, ItemAttribute)

Example:

"ShipmentField"

ruleFieldTypeDisplayValue
string

Display value for the field type group header

Example:

"Shipment Fields"

sortDescriptor
SortDescriptorDto · object

Sort descriptor with query parameter format and ascending/descending values

sortable
boolean

Whether this field supports sorting in result sets

Example:

false

validEnumValues
ShipmentRuleEnumValueDto · object[]

List of valid enumerated values for enum/list data types