Jobs

Create a Hyperscale Compliance Job.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to create a Hyperscale Compliance Job.

name
required
string [ 1 .. 256 ] characters

Name of the Job. This should be unique.

masking_engine_ids
required
Array of integers <int64> [ 1 .. 1000 ] items

Array of Masking Engine IDs.

data_set_id
required
integer <int64>

ID of the registered Data Set model to be used for this job.

app_name_prefix
required
string [ 1 .. 85 ] characters ^[\S]+(\s+[\S]+)*$

Prefix of the name of the application to be created on masking engine. A new application with the name appNamePrefix_hyperscale will be created on masking engines.

env_name_prefix
required
string [ 1 .. 240 ] characters ^[\S]+(\s+[\S]+)*$

Prefix of the name of the environment to be created on masking engine. A new environment with the name envNamePrefix_hyperscale will be created on masking engines.

consider_continuous_compliance_warning_event_as
string
Default: "SUCCESS"

The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data.

Enum: "SUCCESS" "FAILURE"
retain_execution_data
string
Default: "NO"

Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS.

Enum: "NO" "ON_ERROR" "ALWAYS"
object or null

configuration properties for source datasource

object or null

configuration properties for source datasource

object (MaskingJobConfig)

Configuration details for the Masking Engine job. If not provided default ME job configuration will be used.

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/jobs
Request samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}
Response samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}

Returns a list of Hyperscale Compliance Jobs.

SecurityApiKeyAuth
Responses
200

OK

500

Internal Service Unavailable.

get/jobs
Response samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}

Returns a Job by ID.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/jobs/{id}
Response samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}

Update an existing Job.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job.

Request Body schema: application/json
required

The updated Hyperscale Compliance Job information.

name
required
string [ 1 .. 256 ] characters

Name of the Job. This should be unique.

masking_engine_ids
required
Array of integers <int64> [ 1 .. 1000 ] items

Array of Masking Engine IDs.

data_set_id
required
integer <int64>

ID of the registered Data Set model to be used for this job.

app_name_prefix
required
string [ 1 .. 85 ] characters ^[\S]+(\s+[\S]+)*$

Prefix of the name of the application to be created on masking engine. A new application with the name appNamePrefix_hyperscale will be created on masking engines.

env_name_prefix
required
string [ 1 .. 240 ] characters ^[\S]+(\s+[\S]+)*$

Prefix of the name of the environment to be created on masking engine. A new environment with the name envNamePrefix_hyperscale will be created on masking engines.

consider_continuous_compliance_warning_event_as
string
Default: "SUCCESS"

The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data.

Enum: "SUCCESS" "FAILURE"
retain_execution_data
string
Default: "NO"

Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS.

Enum: "NO" "ON_ERROR" "ALWAYS"
object or null

configuration properties for source datasource

object or null

configuration properties for source datasource

object (MaskingJobConfig)

Configuration details for the Masking Engine job. If not provided default ME job configuration will be used.

Responses
200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/jobs/{id}
Request samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}
Response samples
application/json
{
  • "name": "job_1",
  • "masking_engine_ids": [
    ],
  • "data_set_id": 1,
  • "app_name_prefix": "app",
  • "env_name_prefix": "env",
  • "consider_continuous_compliance_warning_event_as": "SUCCESS",
  • "retain_execution_data": "NO",
  • "source_configs": {
    },
  • "target_configs": {
    },
  • "masking_job_config": {
    }
}

Deletes the Job by Id

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/jobs/{id}
➔ Next to ApiKeys