Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 2.92 KB

MetadataFilterConditionRequest.md

File metadata and controls

35 lines (27 loc) · 2.92 KB

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.

Properties

Name Type Description Notes
field_id int The ID of the template field the condition is on. A custom field is addressed by ASC.Files.Core.MetadataFilterConditionRequest.Name instead. [optional]
name str The 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]
op str The 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]
value str The 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 date given without a time (2026-06-30) names the whole day (UTC). [optional]
var_from str The inclusive lower bound of a range. A date given without a time (2026-06-01) is the start of that day (UTC). [optional]
to str The inclusive upper bound of a range. 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]
option_ids List[UUID] The options any of which the choice field must hold. [optional]

Example

from docspace_api_sdk.models.metadata_filter_condition_request import MetadataFilterConditionRequest

# TODO update the JSON string below
json = "{}"
# create an instance of MetadataFilterConditionRequest from a JSON string
metadata_filter_condition_request_instance = MetadataFilterConditionRequest.from_json(json)
# print the JSON string representation of the object
print(MetadataFilterConditionRequest.to_json())

# convert the object into a dict
metadata_filter_condition_request_dict = metadata_filter_condition_request_instance.to_dict()
# create an instance of MetadataFilterConditionRequest from a dict
metadata_filter_condition_request_from_dict = MetadataFilterConditionRequest.from_dict(metadata_filter_condition_request_dict)

[Back to Model list] [Back to API list] [Back to README]