# Search column metadata.

Endpoint: POST /database-column-metadata/search
Version: 3.23.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies a descending order.

## Request body:

  - `application/json` (unknown)
    A request body containing a filter expression. This enables searching
for items matching arbitrarily complex conditions. The list of
attributes which can be used in filter expressions is available
in the x-filterable vendor extension.
# Filter Expression Overview
**Note: All keywords are case-insensitive**
## Comparison Operators
| Operator | Description | Example |
|  --- | --- | --- |
| CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE |
| IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] |
| GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |
| GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |
| LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |
| LT | Tests if a field is less than a literal value | field1 LT 9.02 |
| NE | Tests if a field is not equal to a literal value | field1 NE 42 |
| EQ | Tests if a field is equal to a literal value | field1 EQ 42 |

## Search Operator
The SEARCH operator filters for items which have any filterable
attribute that contains the input string as a substring, comparison
is done case-insensitively. This is not restricted to attributes with
string values. Specifically `SEARCH '12'` would match an item with an
attribute with an integer value of `123`.
## Logical Operators
Ordered by precedence.
| Operator | Description | Example |
|  --- | --- | --- |
| NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |
| AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' |
| OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' |

## Grouping
Parenthesis `()` can be used to override operator precedence.
For example:
NOT (field1 LT 1234 AND field2 CONTAINS 'foo')
## Literal Values
| Literal | Description | Examples |
|  --- | --- | --- |
| Nil | Represents the absence of a value | nil, Nil, nIl, NIL |
| Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |
| Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |
| String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' |
| Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |
| List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] |

## Limitations
- A maximum of 8 unique identifiers may be used inside a filter expression.

## Request fields (application/json):

  - `filter_expression` (string)
    Example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"

## Request examples:

  - `Nested Object Comparison` (unknown)
    An example of a nested Object comparison testing that at least one repository has a
version which is equal to 19.0.0.

  - `Relative comparison` (unknown)
    An example of a relative comparison testing that field1 has a
value which is less than 123.

  - `Absence of an attribute value` (unknown)
    An example of using nil to test for the absence of a value for field2.

  - `Existence of an attribute value` (unknown)
    An example of using nil to test for the existence of a value for field2.

  - `Use of the CONTAINS operator` (unknown)
    An example of using the 'CONTAINS' operator to check if
field2 contains the string 'foo'. If field2 is string valued
then this is checking if 'foo' is a substring of field2. If
field2 is a list of strings then this is checking if 'foo'
is a member of the list.

  - `Use of the IN operator` (unknown)
    An example of using the 'IN' operator to check if field1
is an element of a list literal.

  - `Use of the SEARCH operator` (unknown)
    An example of using the 'SEARCH' operator to retrieve all elements
for which 'foo' is a substring of a filterable attribute.

  - `Overriding operator precedence` (unknown)
    An example of parenthesis being used to group operators & override
operator precedence.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The id of this column metadata.
    Example: 30

  - `items.column_name` (string)
    The name of the column.
    Example: my_column

  - `items.database_table_metadata_id` (string)
    The id of the database table metadata that this column belongs to.
    Example: 30

  - `items.table_name` (string)
    The name of the table that this column belongs to.
    Example: profile

  - `items.rule_set_id` (string)
    The id of the rule set that this column metadata belongs to.
    Example: 4ed2357d-f1a7-410c-b951-90f0edc1a0f6

  - `items.rule_set_name` (string)
    The name of the rule set that this table metadata belongs to.
    Example: my rule set

  - `items.engine_id` (string)
    The id of the engine associated with this column.
    Example: 5ff0dab4-368c-4d57-8b61-9a09b6e80f42

  - `items.engine_name` (string)
    The name of the engine associated with this column.
    Example: my engine

  - `items.algorithm_id` (string)
    The id of the algorithm associated with this column.
    Example: 7a1b2c3d-e4f5-4a6b-8c7d-9e0f1a2b3c4d

  - `items.algorithm_name` (string)
    The name of the algorithm associated with this column.
    Example: My Secure Lookup

  - `items.data_class_id` (string)
    The id of the data class associated with this column.
    Example: 6b5c4d3e-2a1b-4c3d-5e6f-7a8b9c0d1e2f

  - `items.data_class_name` (string)
    The name of the data class associated with this column.
    Example: My Domain

  - `items.data_type` (string)
    The data type of the column.
    Example: VARCHAR

  - `items.date_format` (string)
    The format of the date stored in the column.
    Example: YYYY-MM-DD

  - `items.column_length` (integer)
    The length of the column.
    Example: 255

  - `items.is_sensitive` (boolean)
    This field indicates whether or not a column has sensitive data.

  - `items.is_profiler_writable` (boolean)
    Indicates whether this column is writable by the profiler.

  - `items.is_primary_key` (boolean)
    Indicates whether this column is a primary key.

  - `items.is_identity` (boolean)
    Indicates whether this column is an identity column.

  - `items.is_index` (boolean)
    Indicates whether this column is indexed.

  - `items.is_foreign_key` (boolean)
    Indicates whether this column is a foreign key.

  - `items.dct_managed` (boolean)
    Whether this data class is managed by DCT or not.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.