Skip to content

Update values of a MaskingJob.

Request

Security
ApiKeyAuth
Path
maskingJobIdstring, non-emptyrequired

The ID of the Masking Job.

Bodyapplication/json

The new data to update a Masking Job.

namestring, [ 1 .. 1024 ] characters

The name of the MaskingJob.

Example:"My favorite MaskingJob"
connector_usernamestring, [ 1 .. 256 ] characters

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

Example:"user123"
connector_passwordstring, [ 1 .. 4096 ] characters

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

Example:"password123"
on_the_fly_source_connector_usernamestring, [ 1 .. 256 ] characters

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

Example:"user123"
on_the_fly_source_connector_passwordstring, [ 1 .. 4096 ] characters

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

Example:"password123"
descriptionstring

Description of the Job (Hyperscale Job only).

Example:"Job for app finance"
dataset_idstring

Dataset of the Hyperscale Job (Hyperscale Job only).

Example:"dataset-123"
retain_execution_datastring

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

Enum:"NO""ON_ERROR""ALWAYS"
Example:false
max_memoryinteger, (int32)

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

Example:1024
min_memoryinteger, (int32)

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

Example:1024
feedback_sizeinteger, (int32)

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

Example:32
stream_row_limitinteger, (int32)

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

Example:4
num_input_streamsinteger, (int32)

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

Example:4
max_concurrent_source_connectionsinteger, (int32)

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

Example:32
max_concurrent_target_connectionsinteger, (int32)

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

Example:32
parallelism_degreeinteger, (int32)

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

Example:4
curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/20.0.0/continuous-compliance-apis-dct-20.0.0/masking-jobs/{maskingJobId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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
  }'

Responses

OK

Bodyapplication/json
idstringread-only

The Masking Job entity ID.

Example:"masking-job-1"
namestring

The name of this Masking Job.

Example:"My favorite MaskingJob"
rule_set_idstring

The ID of the Rule Set used by this Masking Job (Standard Job only). For hyperscale jobs, see dataset_id.

Example:"uuid"
rule_set_namestring

The name of the Rule Set used by this Masking Job (Standard Job only). For hyperscale jobs, see dataset_id.

Example:"my rule set"
connector_typestring

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"
is_on_the_fly_maskingboolean

Whether this is an on-the-fly masking job (Standard Job only).

Example:true
creation_datestring, (date-time)

The date this MaskingJob was created (Standard Job only).

Example:"2022-11-30T08:51:34.148000+00:00"
last_completed_execution_datestring, (date-time)

The date this MaskingJob was last executed to completion.

Example:"2022-11-30T09:51:34.148000+00:00"
last_execution_statusstring(ExecutionStatus)

The status of a masking or discovery job.

Enum:"PENDING""QUEUED""RUNNING""CANCELLED""FAILED""SUCCEEDED""WARNING"
Example:"RUNNING"
last_execution_idstring

The ID of this MaskingJob's last execution.

Example:"00e38996-7da2-4827-8f3e-0503234de537"
connector_usernamestring or null

The username of the Connector used by the MaskingJob (Standard Job only). For hyperscale jobs, see the connector of the dataset.

Example:"user123"
connector_passwordstring or null

The password of the Connector used by the MaskingJob (Standard Job only). For hyperscale jobs, see the connector of the dataset.

Example:"*****"
on_the_fly_source_connector_usernamestring or null

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

Example:"user123"
on_the_fly_source_connector_passwordstring or null

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

Example:"*****"
job_typestring

The type of this Job.

Enum:"STANDARD""HYPERSCALE"
Example:"STANDARD"
hyperscale_instance_idstring

The ID of the Hyperscale instance of this Job (Hyperscale Job only).

Example:"abc"
descriptionstring

Description of the Job (Hyperscale Job only).

Example:"Job for app finance"
dataset_idstring

Dataset of the Hyperscale Job (Hyperscale Job only).

Example:"dataset-123"
retain_execution_datastring

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

Enum:"NO""ON_ERROR""ALWAYS"
Example:false
max_memoryinteger, (int32)

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

Example:1024
min_memoryinteger, (int32)

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

Example:1024
feedback_sizeinteger, (int32)

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

Example:32
stream_row_limitinteger, (int32)

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

Example:4
num_input_streamsinteger, (int32)

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

Example:4
max_concurrent_source_connectionsinteger, (int32)

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

Example:32
max_concurrent_target_connectionsinteger, (int32)

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

Example:32
parallelism_degreeinteger, (int32)

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

Example:4
source_masking_job_idstring

The ID of the MaskingJob that was used as the source to create this job (Hyperscale Job only).

Example:"masking-job-0"
engine_idsArray of strings

List of engines that this job can run on (Hyperscale Job only).

tagsArray of objects(Tag)
rulesetobject(MaskingRuleset)deprecated

The ruleset of this Masking job (Standard Job only). For hyperscale jobs, see dataset_id.

Example:
{ "type": "DATABASE", "name": "The best Ruleset", "refresh_drops_tables": true }
Response
{ "id": "masking-job-1", "name": "My favorite MaskingJob", "rule_set_id": "uuid", "rule_set_name": "my rule set", "ruleset": { "type": "DATABASE", "name": "The best Ruleset", "refresh_drops_tables": true }, "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": [ "string" ], "tags": [ { … } ] }