profileJob

Get all profile jobs

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get profile jobs. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

environment_id
integer <int32>

The ID of the environment to get all profile jobs from

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/profile-jobs
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create profile job

Securityapi_key
Request
Request Body schema: application/json
required

The profile job to create

jobName
required
string <= 255 characters

The name of the profile job. Once the profile job is created, this field cannot be changed.

profileSetId
required
integer <int32>

The ID number of the profile set to be used during the profiling phase.

rulesetId
required
integer <int32>

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

email
string

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSize
integer <int32> >= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescription
string <= 255 characters

A description of the job.

maxMemory
integer <int32>

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemory
integer <int32>

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenant
boolean
Default: false

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

numInputStreams
integer <int32> >= 1
Default: 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

multipleProfilerCheck
boolean
Default: false

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

resetProfilingAssignments
boolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/profile-jobs
Request samples
application/json
{
  • "jobName": "minimal_profile_job",
  • "profileSetId": 2,
  • "rulesetId": 7,
  • "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}
Response samples
application/json
{
  • "jobName": "minimal_profile_job",
  • "profileSetId": 2,
  • "rulesetId": 7,
  • "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Get profile job by ID

Securityapi_key
Request
path Parameters
profileJobId
required
integer <int32>

The ID of the profile job to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/profile-jobs/{profileJobId}
Response samples
application/json
{
  • "jobName": "minimal_profile_job",
  • "profileSetId": 2,
  • "rulesetId": 7,
  • "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Update profile job by ID

Securityapi_key
Request
path Parameters
profileJobId
required
integer <int32>

The ID of the profile job to update

Request Body schema: application/json
required

The updated profile job

jobName
required
string <= 255 characters

The name of the profile job. Once the profile job is created, this field cannot be changed.

profileSetId
required
integer <int32>

The ID number of the profile set to be used during the profiling phase.

rulesetId
required
integer <int32>

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

email
string

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSize
integer <int32> >= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescription
string <= 255 characters

A description of the job.

maxMemory
integer <int32>

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemory
integer <int32>

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenant
boolean
Default: false

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

numInputStreams
integer <int32> >= 1
Default: 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

multipleProfilerCheck
boolean
Default: false

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

resetProfilingAssignments
boolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/profile-jobs/{profileJobId}
Request samples
application/json
{
  • "jobName": "minimal_profile_job",
  • "profileSetId": 2,
  • "rulesetId": 7,
  • "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}
Response samples
application/json
{
  • "jobName": "minimal_profile_job",
  • "profileSetId": 2,
  • "rulesetId": 7,
  • "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Delete profile job by ID

Securityapi_key
Request
path Parameters
profileJobId
required
integer <int32>

The ID of the profile job to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/profile-jobs/{profileJobId}
➔ Next to profileSet