# Search masking jobs.

Endpoint: POST /masking-jobs/search
Version: 3.15.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 Masking Job entity ID.
    Example: masking-job-1

  - `items.name` (string)
    The name of this Masking Job.
    Example: My favorite MaskingJob

  - `items.rule_set_id` (string)
    The ID of the Rule Set used by this Masking Job (Standard Job only). For hyperscale jobs, see dataset_id.
    Example: uuid

  - `items.rule_set_name` (string)
    The name of the Rule Set used by this Masking Job (Standard Job only). For hyperscale jobs, see dataset_id.
    Example: my rule set

  - `items.ruleset` (object)
    A masking ruleset.
    Example: {"type":"DATABASE","name":"The best Ruleset","refresh_drops_tables":true}

  - `items.ruleset.type` (string)
    The Ruleset type.
    Enum: "FILE", "DATABASE", "MAINFRAME_DATASET"

  - `items.ruleset.name` (string)
    The name of this Ruleset.

  - `items.ruleset.refresh_drops_tables` (boolean)
    Whether refresh drops tables. Only applicable to database ruleset type.

  - `items.ruleset.algorithms` (array)
    The list of algorithms for this Ruleset.

  - `items.connector_type` (string)
    The type of data being masked by this Job. If the Masking Job is masking a database this is the type of the database (Standard Job only).
    Example: MARIADB

  - `items.is_on_the_fly_masking` (boolean)
    Whether this is an on-the-fly masking job (Standard Job only).
    Example: true

  - `items.creation_date` (string)
    The date this MaskingJob was created (Standard Job only).
    Example: 2022-11-30T08:51:34.148000+00:00

  - `items.last_completed_execution_date` (string)
    The date this MaskingJob was last executed to completion.
    Example: 2022-11-30T09:51:34.148000+00:00

  - `items.last_execution_status` (string)
    The status of a masking or discovery job.
    Enum: "PENDING", "QUEUED", "RUNNING", "CANCELLED", "FAILED", "SUCCEEDED", "WARNING"

  - `items.last_execution_id` (string)
    The ID of this MaskingJob's last execution.
    Example: 00e38996-7da2-4827-8f3e-0503234de537

  - `items.connector_username` (string)
    The username of the Connector used by the MaskingJob (Standard Job only). For hyperscale jobs, see the connector of the dataset.
    Example: user123

  - `items.connector_password` (string)
    The password of the Connector used by the MaskingJob (Standard Job only). For hyperscale jobs, see the connector of the dataset.
    Example: *****

  - `items.on_the_fly_source_connector_username` (string)
    The username of the source Connector used by the on-the-fly MaskingJob (Standard Job only).
    Example: user123

  - `items.on_the_fly_source_connector_password` (string)
    The password of the source Connector used by the on-the-fly MaskingJob (Standard Job only).
    Example: *****

  - `items.job_type` (string)
    The type of this Job.
    Enum: "STANDARD", "HYPERSCALE"

  - `items.hyperscale_instance_id` (string)
    The ID of the Hyperscale instance of this Job (Hyperscale Job only).
    Example: abc

  - `items.description` (string)
    Description of the Job (Hyperscale Job only).
    Example: Job for app finance

  - `items.dataset_id` (string)
    Dataset of the Hyperscale Job (Hyperscale Job only).
    Example: dataset-123

  - `items.retain_execution_data` (string)
    Defines whether execution data will be stored after execution is complete (Hyperscale Job only).
    Enum: "NO", "ON_ERROR", "ALWAYS"

  - `items.max_memory` (integer)
    Maximum memory to be allocated for each Masking job (Hyperscale Job only).
    Example: 1024

  - `items.min_memory` (integer)
    Minimum memory to be allocated for each Masking job (Hyperscale Job only).
    Example: 1024

  - `items.feedback_size` (integer)
    Feedback Size for each Masking job (Hyperscale Job only).
    Example: 32

  - `items.stream_row_limit` (integer)
    Stream Row Limit for each Masking job (Hyperscale Job only).
    Example: 4

  - `items.num_input_streams` (integer)
    Number of input streams to be configured for Masking Job (Hyperscale Job only).
    Example: 4

  - `items.max_concurrent_source_connections` (integer)
    Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only).
    Example: 32

  - `items.max_concurrent_target_connections` (integer)
    Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only).
    Example: 32

  - `items.parallelism_degree` (integer)
    The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only).
    Example: 4

  - `items.source_masking_job_id` (string)
    The ID of the MaskingJob that was used as the source to create this job (Hyperscale Job only).
    Example: masking-job-0

  - `items.engine_ids` (array)
    List of engines that this job can run on (Hyperscale Job only).

  - `items.tags` (array)

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `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.

