MaskingJobs

Retrieve the list of masking jobs.Deprecated

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" "name" "-name" "is_on_the_fly_masking" "-is_on_the_fly_masking" "creation_date" "-creation_date" "last_completed_execution_date" "-last_completed_execution_date" "last_execution_status" "-last_execution_status" "last_execution_id" "-last_execution_id" "rule_set_id" "-rule_set_id" "rule_set_name" "-rule_set_name" "ruleset.name" "-ruleset.name" "connector_type" "-connector_type" "description" "-description" "dataset_id" "-dataset_id" "retain_execution_data" "-retain_execution_data" "parallelism_degree" "-parallelism_degree" "max_concurrent_target_connections" "-max_concurrent_target_connections" "max_concurrent_source_connections" "-max_concurrent_source_connections" "num_input_streams" "-num_input_streams" "stream_row_limit" "-stream_row_limit" "feedback_size" "-feedback_size" "min_memory" "-min_memory" "max_memory" "-max_memory"
Example: sort=id
Responses
200

OK

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

Create a Masking Job.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

Input params to create a masking job.

name
string

The name to give the Masking Job.

description
string

The description of the Job (Hyperscale Job only).

job_type
string

The type of Job.

Value: "HYPERSCALE"
hyperscale_instance_id
string

The ID of the HyperscaleInstance to create this Job on (Hyperscale Job only).

source_masking_job_id
string

The ID of the Masking Job to use as the source (Hyperscale Job only).

hyperscale_source_connector_username
string

The username to set for the Source Connector that will be imported (Hyperscale Job only).

hyperscale_source_connector_password
string

The password to set for the Source Connector that will be imported (Hyperscale Job only).

hyperscale_target_connector_username
string

The username to set for the Target Connector that will be imported (Hyperscale Job only).

hyperscale_target_connector_password
string

The password to set for the Target Connector that will be imported (Hyperscale Job only).

mount_point_id
string

The ID of the MountPoint to use for the resulting dataset (Hyperscale Job only).

unload_split
integer <int64>

The number of unloaded files to be generated from the source database (Hyperscale Job only).

stream_size
integer <int64>

The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server (Hyperscale Job only).

retain_execution_data
string

Defines whether execution data will be stored after execution is complete (Hyperscale Job only).

Enum: "NO" "ON_ERROR" "ALWAYS"
max_memory
integer <int32>

Maximum memory, in MB, to be allocated for each Masking job (Hyperscale Job only).

min_memory
integer <int32>

Minimum memory, in MB, to be allocated for each Masking job (Hyperscale Job only).

feedback_size
integer <int32>

The granularity with which the masking engine provides updates on the progress of the masking job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the masking phase (Hyperscale Job only).

stream_row_limit
integer <int32>

The stream row limit constrains the total number of rows that may enter the job for each masking stream. Setting this value to 0 allows unlimited rows into each stream, while leaving it blank will select a default limit based on job type (Hyperscale Job only).

num_input_streams
integer <int32>

Number of input streams to be configured for Masking Job (Hyperscale Job only).

max_concurrent_source_connections
integer <int32>

Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only).

max_concurrent_target_connections
integer <int32>

Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only).

parallelism_degree
integer <int32>

The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only).

Array of objects (Tag)
make_current_account_owner
boolean
Default: true

Whether the account creating this Masking job must be configured as owner of it (Hyperscale Job only).

Responses
200

OK

post/masking-jobs
Request samples
application/json
{
  • "name": "My favorite MaskingJob",
  • "description": "Job for app finance DB",
  • "job_type": "HYPERSCALE",
  • "hyperscale_instance_id": "hyperscale-123",
  • "source_masking_job_id": "masking-job-123",
  • "hyperscale_source_connector_username": "db-user-123",
  • "hyperscale_source_connector_password": "dp-pass-123",
  • "hyperscale_target_connector_username": "db-user-123",
  • "hyperscale_target_connector_password": "dp-pass-123",
  • "mount_point_id": "mount-point-123",
  • "unload_split": 4,
  • "stream_size": 65536,
  • "retain_execution_data": false,
  • "max_memory": 1024,
  • "min_memory": 1024,
  • "feedback_size": 10000,
  • "stream_row_limit": 0,
  • "num_input_streams": 4,
  • "max_concurrent_source_connections": 32,
  • "max_concurrent_target_connections": 32,
  • "parallelism_degree": 4,
  • "tags": [
    ],
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "id": "string",
  • "job": {
    }
}

Search masking jobs.Deprecated

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" "name" "-name" "is_on_the_fly_masking" "-is_on_the_fly_masking" "creation_date" "-creation_date" "last_completed_execution_date" "-last_completed_execution_date" "last_execution_status" "-last_execution_status" "last_execution_id" "-last_execution_id" "rule_set_id" "-rule_set_id" "rule_set_name" "-rule_set_name" "ruleset.name" "-ruleset.name" "connector_type" "-connector_type" "description" "-description" "dataset_id" "-dataset_id" "retain_execution_data" "-retain_execution_data" "parallelism_degree" "-parallelism_degree" "max_concurrent_target_connections" "-max_concurrent_target_connections" "max_concurrent_source_connections" "-max_concurrent_source_connections" "num_input_streams" "-num_input_streams" "stream_row_limit" "-stream_row_limit" "feedback_size" "-feedback_size" "min_memory" "-min_memory" "max_memory" "-max_memory"
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/masking-jobs/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 list of masking jobs along with their source engine.

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: "masking_job_id" "-masking_job_id" "source_engine_id" "-source_engine_id"
Example: sort=id
Responses
200

OK

get/masking-jobs/source-engines
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the list of masking jobs along with their source engine.

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: "masking_job_id" "-masking_job_id" "source_engine_id" "-source_engine_id"
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/masking-jobs/source-engines/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": {
    }
}

Delete a masking job.

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

query Parameters
force
boolean
Default: false

If true, ignores any failures to remove a masking job on an engine.

Example: force=true
Responses
200

Masking job delete initiated.

delete/masking-jobs/{maskingJobId}
Response samples
application/json
{
  • "job": {
    }
}

Retrieve a MaskingJob by ID.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Responses
200

OK

get/masking-jobs/{maskingJobId}
Response samples
application/json
{
  • "id": "masking-job-1",
  • "name": "My favorite MaskingJob",
  • "rule_set_id": "uuid",
  • "rule_set_name": "my rule set",
  • "ruleset": {
    },
  • "connector_type": "MARIADB",
  • "is_on_the_fly_masking": true,
  • "creation_date": "2022-11-30T08:51:34.148000+00:00",
  • "last_completed_execution_date": "2022-11-30T09:51:34.148000+00:00",
  • "last_execution_status": "RUNNING",
  • "last_execution_id": "00e38996-7da2-4827-8f3e-0503234de537",
  • "connector_username": "user123",
  • "connector_password": "*****",
  • "on_the_fly_source_connector_username": "user123",
  • "on_the_fly_source_connector_password": "*****",
  • "job_type": "STANDARD",
  • "hyperscale_instance_id": "abc",
  • "description": "Job for app finance",
  • "dataset_id": "dataset-123",
  • "retain_execution_data": false,
  • "max_memory": 1024,
  • "min_memory": 1024,
  • "feedback_size": 32,
  • "stream_row_limit": 4,
  • "num_input_streams": 4,
  • "max_concurrent_source_connections": 32,
  • "max_concurrent_target_connections": 32,
  • "parallelism_degree": 4,
  • "source_masking_job_id": "masking-job-0",
  • "engine_ids": [
    ],
  • "tags": [
    ]
}

Update values of a MaskingJob.

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json

The new data to update a Masking Job.

name
string [ 1 .. 1024 ] characters

The name of the MaskingJob.

connector_username
string [ 1 .. 256 ] characters

The username of the Connector used by the MaskingJob. (Standard Job only).

connector_password
string [ 1 .. 4096 ] characters

The password of the Connector used by the MaskingJob. (Standard Job only).

on_the_fly_source_connector_username
string [ 1 .. 256 ] characters

The username of the source Connector used by the on-the-fly MaskingJob. (Standard Job only).

on_the_fly_source_connector_password
string [ 1 .. 4096 ] characters

The password of the source Connector used by the on-the-fly MaskingJob. (Standard Job only).

description
string

Description of the Job (Hyperscale Job only).

dataset_id
string

Dataset of the Hyperscale Job (Hyperscale Job only).

retain_execution_data
string

Defines whether execution data will be stored after execution is complete (Hyperscale Job only).

Enum: "NO" "ON_ERROR" "ALWAYS"
max_memory
integer <int32>

Maximum memory to be allocated for each Masking job (Hyperscale Job only).

min_memory
integer <int32>

Minimum memory to be allocated for each Masking job (Hyperscale Job only).

feedback_size
integer <int32>

Feedback Size for each Masking job (Hyperscale Job only).

stream_row_limit
integer <int32>

Stream Row Limit for each Masking job (Hyperscale Job only).

num_input_streams
integer <int32>

Number of input streams to be configured for Masking Job (Hyperscale Job only).

max_concurrent_source_connections
integer <int32>

Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only).

max_concurrent_target_connections
integer <int32>

Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only).

parallelism_degree
integer <int32>

The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only).

Responses
200

OK

patch/masking-jobs/{maskingJobId}
Request samples
application/json
{
  • "name": "My favorite MaskingJob",
  • "connector_username": "user123",
  • "connector_password": "password123",
  • "on_the_fly_source_connector_username": "user123",
  • "on_the_fly_source_connector_password": "password123",
  • "description": "Job for app finance",
  • "dataset_id": "dataset-123",
  • "retain_execution_data": false,
  • "max_memory": 1024,
  • "min_memory": 1024,
  • "feedback_size": 32,
  • "stream_row_limit": 4,
  • "num_input_streams": 4,
  • "max_concurrent_source_connections": 32,
  • "max_concurrent_target_connections": 32,
  • "parallelism_degree": 4
}
Response samples
application/json
{
  • "id": "masking-job-1",
  • "name": "My favorite MaskingJob",
  • "rule_set_id": "uuid",
  • "rule_set_name": "my rule set",
  • "ruleset": {
    },
  • "connector_type": "MARIADB",
  • "is_on_the_fly_masking": true,
  • "creation_date": "2022-11-30T08:51:34.148000+00:00",
  • "last_completed_execution_date": "2022-11-30T09:51:34.148000+00:00",
  • "last_execution_status": "RUNNING",
  • "last_execution_id": "00e38996-7da2-4827-8f3e-0503234de537",
  • "connector_username": "user123",
  • "connector_password": "*****",
  • "on_the_fly_source_connector_username": "user123",
  • "on_the_fly_source_connector_password": "*****",
  • "job_type": "STANDARD",
  • "hyperscale_instance_id": "abc",
  • "description": "Job for app finance",
  • "dataset_id": "dataset-123",
  • "retain_execution_data": false,
  • "max_memory": 1024,
  • "min_memory": 1024,
  • "feedback_size": 32,
  • "stream_row_limit": 4,
  • "num_input_streams": 4,
  • "max_concurrent_source_connections": 32,
  • "max_concurrent_target_connections": 32,
  • "parallelism_degree": 4,
  • "source_masking_job_id": "masking-job-0",
  • "engine_ids": [
    ],
  • "tags": [
    ]
}

Copies the masking job to another engine.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
target_engine_id
required
string [ 1 .. 256 ] characters

The ID of the engine to copy the job to.

source_environment_id
string [ 1 .. 256 ] characters

The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs.

target_environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment on the target engine to copy the job into.

force_overwrite
boolean
Default: false

Whether to overwrite objects that already exist on the target engine.

Responses
200

Copy masking job initiated.

post/masking-jobs/{maskingJobId}/copy
Request samples
application/json
{
  • "target_engine_id": "1",
  • "source_environment_id": "test-on-the-fly-mask1",
  • "target_environment_id": "prod-in-place-mask1",
  • "force_overwrite": false
}
Response samples
application/json
{
  • "job": {
    },
  • "masking_job_id": "string"
}

Migrates the masking job from its current source engine to another engine.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
target_engine_id
required
string [ 1 .. 256 ] characters

The ID of the engine to migrate the job to.

source_environment_id
string [ 1 .. 256 ] characters

The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs.

target_environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment on the target engine to migrate the job into.

force_overwrite
boolean
Default: false

Whether to overwrite objects that already exist on the target engine.

Responses
200

Migrate masking job initiated.

post/masking-jobs/{maskingJobId}/migrate
Request samples
application/json
{
  • "target_engine_id": "1",
  • "source_environment_id": "test-on-the-fly-mask1",
  • "target_environment_id": "prod-in-place-mask1",
  • "force_overwrite": false
}
Response samples
application/json
{
  • "job": {
    }
}

Get connectors for a Masking Job by ID.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Responses
200

OK

get/masking-jobs/{maskingJobId}/connectors
Response samples
application/json
{
  • "connector": {
    },
  • "on_the_fly_connector": {
    }
}

Execute a MaskingJob.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
engine_id
string non-empty

The ID of the Engine to execute this MaskingJob on (Standard job only).

Responses
200

Masking job execute initiated.

post/masking-jobs/{maskingJobId}/execute
Request samples
application/json
{
  • "engine_id": "engine-123"
}
Response samples
application/json
{
  • "job": {
    }
}

Re-import the dataset from the source MaskingJob (Hyperscale Job only).

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Responses
200

Masking job re-import initiated.

post/masking-jobs/{maskingJobId}/re-import
Response samples
application/json
{
  • "job": {
    }
}

Create tags for a Masking Job.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
required

Tags information for Masking Job.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/masking-jobs/{maskingJobId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Get tags for a Masking Job.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Responses
200

Ok

get/masking-jobs/{maskingJobId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a Masking Job.Deprecated

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/masking-jobs/{maskingJobId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Add an engine to a Masking Job (Hyperscale Job only).

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
required

Body containing the ID of the registered engine.

engine_id
string non-empty
Responses
200

OK

post/masking-jobs/{maskingJobId}/add-engine
Request samples
application/json
{
  • "engine_id": "1"
}
Response samples
application/json
{
  • "job": {
    }
}

Remove an engine from a Masking Job (Hyperscale Job only).

SecurityApiKeyAuth
Request
path Parameters
maskingJobId
required
string non-empty

The ID of the Masking Job.

Request Body schema: application/json
required

Body containing the ID of the registered engine.

engine_id
string non-empty
Responses
200

OK

post/masking-jobs/{maskingJobId}/remove-engine
Request samples
application/json
{
  • "engine_id": "1"
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to Algorithms