# Search for synthetic data generation jobs

Endpoint: POST /synthetic/jobs/search
Version: 3.30.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 the synthetic data generation job
    Example: 5ff0dab4-368c-4d57-8b61-9a09b6e8faf3

  - `items.name` (string, required)
    The name of this job. This value must be unique among all synthetic data generation jobs.
    Example: Customer Data Generation Job

  - `items.description` (string)
    An optional description for this synthetic data generation job.
    Example: Job to generate synthetic customer data for testing

  - `items.dataset_id` (string, required)
    The ID of the dataset this job will use for generation
    Example: dataset-7bb1fab6-560e-6d79-cb82-9c4f73e5d0e4

  - `items.dataset_name` (string)
    The name of the dataset this job will use for generation
    Example: Customer Dataset

  - `items.application_id` (string)
    The ID of the application this job belongs to
    Example: app-5ff0dab4-368c-4d57-8b61-9a09b6e8faf2

  - `items.application_name` (string)
    The name of the application this job belongs to
    Example: Customer Data Application

  - `items.account_id` (integer)
    The ID of the account who created this job.
    Example: 1

  - `items.creation_date` (string)
    The date this job was created.
    Example: 2022-11-30T08:51:34.148Z

  - `items.updated_date` (string)
    The date this job was last updated.
    Example: 2022-11-30T09:15:20.000Z

  - `items.records_count_overrides` (object)
    Records count overrides for one or more structures. Used for dataset/job patch requests and estimate previews.
    Example: {"structures":[{"structure_id":"101","records_count":5000},{"structure_id":"202","records_count_multiplier":3.5}]}

  - `items.records_count_overrides.structures` (array)
    List of structure records count updates. Each item must set either records_count (for top-level structures) or records_count_multiplier (for child structures), not both.

  - `items.records_count_overrides.structures.structure_id` (string, required)
    The id of the structure to update.
    Example: 101

  - `items.records_count_overrides.structures.records_count` (integer)
    Absolute record count. Only valid for top-level structures (parent_structure_id IS NULL). Minimum value is 0.
    Example: 5000

  - `items.records_count_overrides.structures.records_count_multiplier` (number)
    Ratio of child records to parent records. Only valid for child structures (parent_structure_id IS NOT NULL). Minimum value is 0.
    Example: 3.5

  - `items.latest_execution_start_time` (string)
    The start time of the most recent execution of this job
    Example: 2022-11-30T10:30:00.000Z

  - `items.latest_execution_status` (string)
    The status of the most recent execution of this job
    Example: SUCCESS

  - `items.target_mappings` (array)
    List of target connector mappings for this job

  - `items.target_mappings.job_id` (string)
    The ID of the job this mapping belongs to

  - `items.target_mappings.reference_connector_id` (string)
    The ID of the reference connector

  - `items.target_mappings.target_connector_id` (string)
    The ID of the target connector (can be null)

  - `items.target_mappings.target_connector_name` (string)
    The name of the target connector

  - `items.target_mappings.target_connector_type` (string)
    The type of the target connector

  - `items.truncate_existing_data` (boolean)
    When true, existing data in the target schema is deleted before generation begins. When false (default), generated data is appended to existing rows. Can be changed at any time via PATCH.

  - `items.use_job_seed` (boolean)
    When true, the job uses a deterministic seed for data generation so that truncate-and-regenerate produces identical data. Defaults to false.

  - `items.job_seed` (string)
    Opaque seed value used for deterministic data generation when use_job_seed is true. Generated automatically at job creation and cannot be changed.

  - `items.tags` (array)
    Tags associated with this job.

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