Executions

Retrieve the list of masking executions.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "engine_id" "-engine_id" "engine_name" "-engine_name" "masking_job_id" "-masking_job_id" "masking_job_name" "-masking_job_name" "source_connector_id" "-source_connector_id" "target_connector_id" "-target_connector_id" "status" "-status" "rows_masked" "-rows_masked" "rows_total" "-rows_total" "bytes_processed" "-bytes_processed" "bytes_total" "-bytes_total" "start_time" "-start_time" "end_time" "-end_time" "submit_time" "-submit_time" "run_duration" "-run_duration" "queue_duration" "-queue_duration" "total_duration" "-total_duration" "account_id" "-account_id" "account_name" "-account_name"
Example: sort=id
Responses
200

OK

get/executions
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search masking executions.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "engine_id" "-engine_id" "engine_name" "-engine_name" "masking_job_id" "-masking_job_id" "masking_job_name" "-masking_job_name" "source_connector_id" "-source_connector_id" "target_connector_id" "-target_connector_id" "status" "-status" "rows_masked" "-rows_masked" "rows_total" "-rows_total" "bytes_processed" "-bytes_processed" "bytes_total" "-bytes_total" "start_time" "-start_time" "end_time" "-end_time" "submit_time" "-submit_time" "run_duration" "-run_duration" "queue_duration" "-queue_duration" "total_duration" "-total_duration" "account_id" "-account_id" "account_name" "-account_name"
Example: sort=id
Request Body schema: application/json

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 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.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/executions/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Retrieve an Execution by ID.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

Responses
200

OK

get/executions/{executionId}
Response samples
application/json
{
  • "id": "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
  • "engine_id": "1",
  • "hyperscale_instance_id": "string",
  • "engine_name": "prod01",
  • "masking_job_id": "2",
  • "masking_job_name": "finance-masking-job",
  • "source_connector_id": "1-DATABASE-2",
  • "target_connector_id": "1-DATABASE-3",
  • "status": "RUNNING",
  • "rows_masked": 1000,
  • "rows_total": 5000,
  • "bytes_processed": 500,
  • "bytes_total": 5000000,
  • "start_time": "2021-05-01T09:51:34.148000+00:00",
  • "submit_time": "2021-05-01T08:51:34.148000+00:00",
  • "end_time": "2021-05-01T11:51:34.148000+00:00",
  • "run_duration": 4000,
  • "queue_duration": 1000,
  • "total_duration": 5000,
  • "account_id": 3,
  • "account_name": "John Doe",
  • "task_events": [
    ],
  • "hyperscale_task_events": [
    ],
  • "progress": 0.34,
  • "execution_components_total": 5,
  • "execution_components_processed": 3
}

Cancel an Execution.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

Request Body schema: application/json
optional
expected_status
string

The expected status of the execution to cancel to prevent cancelling a queued job that has transitioned to a running state since the request was issued (Standard Job only).

Enum: "QUEUED" "RUNNING"
Responses
200

OK

post/executions/{executionId}/cancel
Request samples
application/json
{
  • "expected_status": "QUEUED"
}

Restart an Execution (Hyperscale only).

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

Responses
200

Masking job execution restarted.

post/executions/{executionId}/restart
Response samples
application/json
{
  • "job": {
    }
}

Cleanup an Execution (Hyperscale only).

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

Responses
200

Masking job execution cleaned up.

post/executions/{executionId}/cleanup
Response samples
application/json
{
  • "job": {
    }
}

Retrieve the list of events for a masking execution.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "execution_id" "-execution_id" "execution_component_id" "-execution_component_id" "event_type" "-event_type" "severity" "-severity" "cause" "-cause" "count" "-count" "timestamp" "-timestamp" "masked_object_name" "-masked_object_name" "algorithm_name" "-algorithm_name" "exception_type" "-exception_type" "exception_detail" "-exception_detail"
Example: sort=id
Responses
200

OK

get/executions/{executionId}/events
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search masking executions events.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "execution_id" "-execution_id" "execution_component_id" "-execution_component_id" "event_type" "-event_type" "severity" "-severity" "cause" "-cause" "count" "-count" "timestamp" "-timestamp" "masked_object_name" "-masked_object_name" "algorithm_name" "-algorithm_name" "exception_type" "-exception_type" "exception_detail" "-exception_detail"
Example: sort=id
Request Body schema: application/json

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 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.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/executions/{executionId}/events/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Retrieve the masking execution log.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

Responses
200

OK

get/executions/{executionId}/log
Response samples
application/json
{
  • "id": "1-LOG-1",
  • "execution_id": "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
  • "masking_job_id": "2",
  • "status": "RUNNING",
  • "log": "ORA-12505, TNS:listener does not currently know of SID given in connect descriptor"
}

Get execution components for an execution.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "name" "-name" "execution_id" "-execution_id" "status" "-status" "rows_masked" "-rows_masked" "rows_total" "-rows_total" "bytes_processed" "-bytes_processed" "bytes_total" "-bytes_total" "start_time" "-start_time" "end_time" "-end_time" "non_conforming_data_count" "-non_conforming_data_count"
Example: sort=id
Responses
200

OK

get/executions/{executionId}/execution-components
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search execution components for an execution.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "name" "-name" "execution_id" "-execution_id" "status" "-status" "rows_masked" "-rows_masked" "rows_total" "-rows_total" "bytes_processed" "-bytes_processed" "bytes_total" "-bytes_total" "start_time" "-start_time" "end_time" "-end_time" "non_conforming_data_count" "-non_conforming_data_count"
Example: sort=id
Request Body schema: application/json

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 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.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/executions/{executionId}/execution-components/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get an execution component by ID.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

executionComponentId
required
string

The ID of the Execution Component.

Responses
200

OK

get/executions/{executionId}/execution-components/{executionComponentId}
Response samples
application/json
{
  • "id": "123",
  • "name": "table_a",
  • "execution_id": "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
  • "status": "RUNNING",
  • "rows_masked": 1000,
  • "rows_total": 5000,
  • "bytes_processed": 500,
  • "bytes_total": 5000000,
  • "start_time": "2021-05-01T09:51:34.148000+00:00",
  • "end_time": "2021-05-01T11:51:34.148000+00:00",
  • "non_conforming_data_count": 10
}

Get an execution component log.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

executionComponentId
required
string

The ID of the Execution Component.

Responses
200

OK

get/executions/{executionId}/execution-components/{executionComponentId}/log
Response samples
application/json
{
  • "execution_component_id": "123",
  • "log": "2024/08/29 22:22:52 - newtable-6f323503-9911-3ca0-8843-f7d9f56374de - Loading transformation from XML file"
}

Retrieve the list of discovery results for a masking execution.

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "table_name" "-table_name" "file_name" "-file_name" "column_name" "-column_name" "field_name" "-field_name" "data_class_name" "-data_class_name" "algorithm_name" "-algorithm_name" "data_type" "-data_type" "confidence" "-confidence" "is_profiler_writable" "-is_profiler_writable"
Example: sort=column_name
Responses
200

OK

get/executions/{executionId}/discovery-results
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search discovery results associated with execution of a discovery job

SecurityApiKeyAuth
Request
path Parameters
executionId
required
string non-empty

The ID of the Execution.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

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 or null

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

Enum: "id" "-id" "table_name" "-table_name" "file_name" "-file_name" "column_name" "-column_name" "field_name" "-field_name" "data_class_name" "-data_class_name" "algorithm_name" "-algorithm_name" "data_type" "-data_type" "confidence" "-confidence" "is_profiler_writable" "-is_profiler_writable"
Example: sort=column_name
Request Body schema: application/json

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 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.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/executions/{executionId}/discovery-results/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}
➔ Next to MaskingFiles