跳到主要内容

MetadataFilterConditionRequest

One metadata filter condition as the clients send it: an element of the metadataFilters JSON of the listings and of the body of the search endpoints. All conditions are combined with AND.

NameTypeDescriptionNotes
fieldIdInteger (int32)The ID of the template field the condition is on. A custom field is addressed by ASC.Files.Core.MetadataFilterConditionRequest.Name instead.[optional] [example: 1]
nameStringThe name of a custom field, for the conditions on the custom fields, which have no identifier outside. Either the field ID or the name is given; the name is matched without regard to case.[optional] [example: Client] [nullable]
opStringThe operator, one of ASC.Files.Core.MetadataFilterOperators: eq or contains for a string field, eq, range, gt, gte, lt or lte for a number field, range, gt, gte, lt or lte for a date field, in for a choice field. Optional: an omitted operator is read as eq for a string, as range for a date, as in for a choice, and for a number as eq when a value is given or as range when a bound is. A present one has to belong to the field type and to the arguments: eq takes a value, range takes bounds.[optional] [example: eq] [nullable]
valueStringThe value of a single-valued condition: the whole or a part of a string field, the exact value of a number field, or the bound of a gt, gte, lt or lte condition on a number or a date field. A JSON number is accepted as well as a string. A number is a whole number of at most 2^53-1 in magnitude, the limit of a stored number value. A date given without a time (2026-06-30) names the whole day (UTC).[optional] [example: ACME] [nullable]
fromStringThe inclusive lower bound of a range. A number is a whole number of at most 2^53-1 in magnitude, the limit of a stored number value. A date given without a time (2026-06-01) is the start of that day (UTC).[optional] [example: 2026-01-01] [nullable]
toStringThe inclusive upper bound of a range. A number is a whole number of at most 2^53-1 in magnitude, the limit of a stored number value. A date given without a time (2026-06-30) covers the whole day (UTC); a value with a time is an instant and is taken as is.[optional] [example: 2026-06-30] [nullable]
optionIdsList (uuid)The options any of which the choice field must hold.[optional] [example: [4f1e2d3c-5b6a-4788-99aa-0c1d2e3f4a55]] [nullable]