`FlexibleFieldSearchSpecification`¶

Represents a single search criterion for searching the archive via application-level custom fields.

A custom field is referenced through the its identifier (FlexibleFieldSearchSpecification.FlexibleFieldId) or via its name (FlexibleFieldSearchSpecification.FlexibleFieldName).

In addition, the TrustID Cloud supports different types of search criteria which need to be specified via the FlexibleFieldSearchSpecification.__type property.

FlexibleFieldSearchSpecification.FlexibleFieldId¶

= FlexibleFieldId

Identifier for the flexible-field against which the search specified in this record will be evaluated.

Note

This identifier or the exact Flexible-field Name (FlexibleFieldSearchSpecification.FlexibleFieldName) must be provided.

The identifier is not referring to the version identifier as this would not search against historic values.

FlexibleFieldSearchSpecification.FlexibleFieldName¶

= FlexibleFieldName

The internal name for the flexible-field. This name must contain the exact match for the flexible-field to be evaluated against unless a flexible field identifier is provided instead (FlexibleFieldSearchSpecification.FlexibleFieldId).

FlexibleFieldSearchSpecification.__type¶

= __type

Type of search criteria. The following types are available:

`__type` Argument	Data Type	Available properties
`FlexibleFieldSearchStringValues:#TT.Models`	String	`FlexibleFieldSearchSpecification.StringExactMatchList` `FlexibleFieldSearchSpecification.StringPartialMatchList`
`FlexibleFieldSearchEnumValues:#TT.Models`	Enum	`FlexibleFieldSearchSpecification.EnumExactMatchList`
`FlexibleFieldSearchIntegerValues:#TT.Models`	Integer	`FlexibleFieldSearchSpecification.IntExactMatchList` `FlexibleFieldSearchSpecification.IntRangeList`
`FlexibleFieldSearchDecimalValues:#TT.Models`	Decimal	`FlexibleFieldSearchSpecification.DecimalExactMatchList` `FlexibleFieldSearchSpecification.DecimalRangeList`
`FlexibleFieldSearchDateTimeValues:#TT.Models`	Date	`FlexibleFieldSearchSpecification.DateExactMatchList` `FlexibleFieldSearchSpecification.DateRangeList`

FlexibleFieldSearchSpecification.StringExactMatchList¶

= StringExactMatchList

String Exact-Match list. If this property contains one or more string values it will be used to find containers whose given flexible-field value exactly matches one of the list elements. This implies an OR operation.

Note

The case of the search string will be ignored.

FlexibleFieldSearchSpecification.StringPartialMatchList¶

= StringPartialMatchList

String partial-match list. Each element of the list is a partial string to match against.

Note

The service will look for the given string in any container whose given flexible-field value contains this string. If more than one partial-match string values are specified it implies an OR operation. If exact-match strings are also supplied, this implies an OR operation.

FlexibleFieldSearchSpecification.EnumExactMatchList¶

= EnumExactMatchList

Enum Exact-Match list. If this property contains one or more enum (string) values it will be used to find containers whose given flexible-field value exactly matches one of the list elements. This implies an OR operation. e.g. List(“Yes”, “N/A”) will match against flexible-field values whose value is one of the above.

Note

The case of the search string will be ignored.

FlexibleFieldSearchSpecification.IntExactMatchList¶

= IntExactMatchList

Integer Exact-Match list. If this property contains one or more integer values it will be used to find containers whose given flexible-field value exactly matches one of the list elements. This implies an OR operation.

FlexibleFieldSearchSpecification.IntRangeList¶

= IntRangeList

Integer Range list. Each element of the list is a tuple defining a range of integers to match against. e.g. Tuple(115, 118) = match any container whose given flexible-field value is in the range between 115 and 118 inclusive. If more than one range is specified it implies an OR operation. If exact-match integers are also supplied, this implies an OR operation.

FlexibleFieldSearchSpecification.DecimalExactMatchList¶

= DecimalExactMatchList

Decimal Exact-Match list. If this contains one or more decimal values it will be used to find containers whose given flexible-field value exactly matches one of the list elements. This implies an OR operation.

FlexibleFieldSearchSpecification.DecimalRangeList¶

= DecimalRangeList

Decimal Range list. Each element of the list is a tuple defining a range of decimals to match against. e.g. Tuple(2.0, 3.5) = match any container whose given flexible-field value is in the range between 2.0 and 3.5 inclusive. If more than one range is specified it implies an OR operation. If exact-match decimals are also supplied, this implies an OR operation.

FlexibleFieldSearchSpecification.DateExactMatchList¶

= DateExactMatchList

Date Exact-Match list. If this contains one or more date-time values it will be used to find containers whose given flexible-field value exactly matches one of the list elements. This implies an OR operation.

Note

Only the date component is used in the match: The time component is ignored.

FlexibleFieldSearchSpecification.DateRangeList¶

= DateRangeList

Date Range list. Each element of the list is a tuple defining a range of dates to match against. e.g. Tuple(2-3-2018, 31-2-2018) = match any container whose given flexible-field value is in the range between 2-3-2018 and 31-2-2018 inclusive. If more than one range is specified it implies an OR operation. If exact-match dates are also supplied, this implies an OR operation.

Note

Only the date component is used in the match: The time component is ignored.

FlexibleFieldSearchSpecification¶

`FlexibleFieldSearchSpecification`¶