Masking API
Schema for the Continuous Compliance Engine API
Version: 5.1.14
All rights reserved
Access
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Create algorithm (createAlgorithm)
Request body
Body Parameter — The algorithm to create
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /algorithms/{algorithmName}
Delete algorithm by name (deleteAlgorithm)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
post /algorithms/{algorithmName}/export-lookup-values
Export lookup values for secure lookup algorithm (exportValues)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
get /algorithms/{algorithmName}
Get algorithm by name (getAlgorithm)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm to get
Return type
Example data
Content-Type: application/json
{
"frameworkId" : 123456789,
"algorithmExtension" : "{}",
"algorithmType" : "aeiou",
"createdBy" : "aeiou",
"isTokenizationSupported" : true,
"pluginId" : 123456789,
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ],
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Algorithm
400
Bad request
401
Unauthorized access
404
Not found
Up
get /algorithm/frameworks/id/{frameworkId}
Get algorithm framework by frameworkId (getAlgorithmFramework)
Path parameters
frameworkId (required)
Path Parameter — The id of the framework format: int64
Query parameters
include_schema (optional)
Query Parameter — Whether to include each algorithm framework's JSON schema in the response. default: false
Return type
Example data
Content-Type: application/json
{
"frameworkId" : 123456789,
"frameworkName" : "aeiou",
"plugin" : {
"pluginType" : "aeiou",
"pluginName" : "aeiou",
"pluginId" : 123456789,
"pluginAuthor" : "aeiou"
},
"extensionSchema" : "{}",
"frameworkType" : "aeiou",
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmFramework
400
Bad request
401
Unauthorized access
Up
get /algorithms/{algorithmName}/usage
Generate a report listing all usage of an algorithm on the masking engine (getAlgorithmUsageReport)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm
Query parameters
includeAssignmentDetail (required)
Query Parameter — Whether to include extended, human-readable algorithm assignment detail in the report. File and mainframe format usages are expanded to show each usage across environments, rulesets and files. The content and ordering of these details are subject to change. default: false
environmentFilter (optional)
Query Parameter — Report only usage occurring within the specified environment(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any environment matching the filter. Filtering by environment excludes all domain and algorithm reference usage. format: int64
rulesetFilter (optional)
Query Parameter — Report only usage occurring within the specified ruleset(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any ruleset matching the filter. Filtering by ruleset excludes all domain and algorithm reference usage. format: int64
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetFieldMetadataIds" : [ 123456789 ],
"algorithmReferences" : [ "aeiou" ],
"assignmentDetails" : [ "" ],
"rulesetIds" : [ 123456789 ],
"environmentIds" : [ 123456789 ],
"columnMetadataIds" : [ 123456789 ],
"domainNames" : [ "aeiou" ],
"algorithmMaskingType" : "aeiou",
"fileFieldMetadataIds" : [ 123456789 ],
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmUsageReport
400
Bad request
401
Unauthorized access
404
Not found
Up
get /algorithm/frameworks/
Get all algorithm frameworks (getAllAlgorithmFrameworks)
Query parameters
mask_type (optional)
Query Parameter — Return only frameworks that mask the specified data type.
include_schema (optional)
Query Parameter — Whether to include each algorithm framework's JSON schema in the response. default: false
page_number (optional)
Query Parameter — The page number for which to get algorithm frameworks. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"frameworkId" : 123456789,
"frameworkName" : "aeiou",
"plugin" : {
"pluginType" : "aeiou",
"pluginName" : "aeiou",
"pluginId" : 123456789,
"pluginAuthor" : "aeiou"
},
"extensionSchema" : "{}",
"frameworkType" : "aeiou",
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmFrameworkList
400
Bad request
401
Unauthorized access
Get all algorithms (getAllAlgorithms)
Query parameters
mask_type (optional)
Query Parameter — The data type of value this algorithm can mask.
page_number (optional)
Query Parameter — The page number for which to get algorithms. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"frameworkId" : 123456789,
"algorithmExtension" : "{}",
"algorithmType" : "aeiou",
"createdBy" : "aeiou",
"isTokenizationSupported" : true,
"pluginId" : 123456789,
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ],
"algorithmName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmList
400
Bad request
401
Unauthorized access
Up
get /algorithms/migration
Get a list of all algorithms that support migration to a new framework (getAvailableMigrations)
Return type
Example data
Content-Type: application/json
{
"availableMigrations" : [ {
"frameworkId" : 123456789,
"algorithmName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmMigrationList
400
Bad request
401
Unauthorized access
404
Not found
Up
post /algorithms/{algorithmName}/migration
Create a migrated copy of an existing legacy algorithm (migrateAlgorithm)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm to be migrated.
Query parameters
newAlgorithmName (required)
Query Parameter — The name of the new algorithm to be created by the migration process.
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /algorithms/{algorithmName}/randomize-key
Randomize algorithm key by name (randomizeAlgorithmKey)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm who's key should be randomized
Return type
Example data
Content-Type: application/json
{
"frameworkId" : 123456789,
"algorithmExtension" : "{}",
"algorithmType" : "aeiou",
"createdBy" : "aeiou",
"isTokenizationSupported" : true,
"pluginId" : 123456789,
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ],
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Algorithm
400
Bad request
401
Unauthorized access
404
Not found
Up
put /algorithms/{algorithmName}
Update algorithm by name (updateAlgorithm)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm to update
Request body
Body Parameter — The updated algorithm
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /algorithms/{algorithmName}/usage
Update ALL usage on the engine of the chosen algorithm to the replacement algorithm (updateAlgorithmUsage)
Path parameters
algorithmName (required)
Path Parameter — The name of the algorithm
Query parameters
replacementAlgorithmName (required)
Query Parameter — The name of the replacement algorithm
ignoreIncompatibleTypes (required)
Query Parameter — Update usage even when the original and new algorithms have incompatible masking types. default: false
environmentFilter (optional)
Query Parameter — Only update usage occurring within the specified environment(s). When an environment filter is applied, domain and algorithm reference usage is not updated. This operation will fail if any file format referencing the algorithm is used from environments that don't match the filter. format: int64
rulesetFilter (optional)
Query Parameter — Only update usage occurring within the specified ruleset(s). When a ruleset filter is applied, domain and algorithm reference usage is not updated. This operation will fail if any file format referencing the algorithm is used from rulesets that don't match the filter. format: int64
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetFieldMetadataIds" : [ 123456789 ],
"algorithmReferences" : [ "aeiou" ],
"assignmentDetails" : [ "" ],
"rulesetIds" : [ 123456789 ],
"environmentIds" : [ 123456789 ],
"columnMetadataIds" : [ 123456789 ],
"domainNames" : [ "aeiou" ],
"algorithmMaskingType" : "aeiou",
"fileFieldMetadataIds" : [ 123456789 ],
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmUsageReport
400
Bad request
401
Unauthorized access
404
Not found
Up
post /algorithms/validate
Validate algorithm (validateAlgorithm)
Request body
Body Parameter — The algorithm to validate
Return type
Example data
Content-Type: application/json
{
"validationSucceeded" : true,
"message" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AlgorithmValidation
400
Bad request
401
Unauthorized access
404
Not found
Up
put /analytics/{analyticId}/cancel
Cancel analytic by ID (cancelAnalytic)
Path parameters
analyticId (required)
Path Parameter — The ID of the analytic to cancel format: int32
Return type
Example data
Content-Type: application/json
{
"analyticId" : 123,
"analyticType" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Analytics
400
Bad request
401
Unauthorized access
404
Not found
Run analytic job on the application (createAnalytic)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
analyticType (required)
Form Parameter — The type of the analytic to run
Return type
Example data
Content-Type: application/json
{
"analyticId" : 123,
"analyticType" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Analytics
401
Unauthorized access
404
Not found
Get all analytics which are currently running (getAllAnalytics)
Return type
Example data
Content-Type: application/json
[ {
"analyticId" : 123,
"analyticType" : "aeiou",
"status" : "aeiou"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
Up
get /analytics/{analyticId}
Get analytic by ID (getAnalytic)
Path parameters
analyticId (required)
Path Parameter — The ID number of the analytics job. This field is auto-generated by the Masking Engine. format: int32
Return type
Example data
Content-Type: application/json
{
"analyticId" : 123,
"analyticType" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Analytics
401
Unauthorized access
404
Not found
Create application (createApplication)
Request body
Body Parameter — The application to create
Return type
Example data
Content-Type: application/json
{
"applicationId" : 123,
"applicationName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Application
400
Bad request
409
Conflict
Up
delete /applications/{applicationId}
Delete application by ID (deleteApplication)
Path parameters
applicationId (required)
Path Parameter — The ID of the application to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all applications (getAllApplications)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get applications. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"applicationId" : 123,
"applicationName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ApplicationList
400
Bad request
Up
get /applications/{applicationId}
Get application by ID (getApplicationById)
Path parameters
applicationId (required)
Path Parameter — The ID of the application to get format: int32
Return type
Example data
Content-Type: application/json
{
"applicationId" : 123,
"applicationName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Application
401
Unauthorized access
404
Not found
Up
get /application-settings
Get all application settings (getAllApplicationSettings)
Query parameters
setting_group (optional)
Query Parameter — The group of the setting
page_number (optional)
Query Parameter — The page number for which to get application settings. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"settingGroup" : "aeiou",
"settingValue" : "aeiou",
"settingId" : 123,
"settingName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ApplicationSettingsList
401
Unauthorized access
Up
get /application-settings/{settingId}
Get application setting by ID (getApplicationSettingById)
Path parameters
settingId (required)
Path Parameter — The ID of the setting format: int32
Return type
Example data
Content-Type: application/json
{
"settingGroup" : "aeiou",
"settingValue" : "aeiou",
"settingId" : 123,
"settingName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ApplicationSettings
401
Unauthorized access
404
Not found
Up
put /application-settings/{settingId}
Update application setting by ID (updateApplicationSetting)
Path parameters
settingId (required)
Path Parameter — The ID of the setting format: int32
Request body
Body Parameter — The updated application setting
Return type
Example data
Content-Type: application/json
{
"settingGroup" : "aeiou",
"settingValue" : "aeiou",
"settingId" : 123,
"settingName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ApplicationSettings
400
Bad request
401
Unauthorized access
404
Not found
Up
put /async-tasks/{asyncTaskId}/cancel
Cancel asyncTask by ID (cancelAsyncTask)
Path parameters
asyncTaskId (required)
Path Parameter — The ID of the asyncTask to cancel format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Get all asyncTasks (getAllAsyncTasks)
Query parameters
operation (optional)
Query Parameter — The operation type for which to get async tasks.
status (optional)
Query Parameter — The status type for which to get async tasks.
page_number (optional)
Query Parameter — The page number for which to get asyncTasks. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTaskList
400
Bad request
401
Unauthorized access
Up
get /async-tasks/{asyncTaskId}
Get asyncTask by ID (getAsyncTask)
Path parameters
asyncTaskId (required)
Path Parameter — The ID of the asyncTask to get format: int32
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
401
Unauthorized access
404
Not found
Get all column metadata (getAllColumnMetadata)
Query parameters
table_metadata_id (optional)
Query Parameter — The ID of the table metadata to get all column metadata from format: int32
is_masked (optional)
Query Parameter — Get only masked column metadata when this is true and only unmasked column metadata when this is false
page_number (optional)
Query Parameter — The page number for which to get column metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"columnLength" : 123,
"notes" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"dataType" : "aeiou",
"isPrimaryKey" : true,
"isIndex" : true,
"isMasked" : true,
"algorithmName" : "aeiou",
"tableMetadataId" : 123,
"isProfilerWritable" : true,
"columnMetadataId" : 123456789,
"isForeignKey" : true,
"domainName" : "aeiou",
"columnName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ColumnMetadataList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /column-metadata/{columnMetadataId}
Get column metadata by ID (getColumnMetadataById)
Path parameters
columnMetadataId (required)
Path Parameter — The ID of the column metadata to get format: int64
Return type
Example data
Content-Type: application/json
{
"columnLength" : 123,
"notes" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"dataType" : "aeiou",
"isPrimaryKey" : true,
"isIndex" : true,
"isMasked" : true,
"algorithmName" : "aeiou",
"tableMetadataId" : 123,
"isProfilerWritable" : true,
"columnMetadataId" : 123456789,
"isForeignKey" : true,
"domainName" : "aeiou",
"columnName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ColumnMetadata
401
Unauthorized access
404
Not found
Up
put /column-metadata/{columnMetadataId}
Update column metadata by ID (updateColumnMetadata)
Path parameters
columnMetadataId (required)
Path Parameter — The ID of the column metadata to update format: int64
Request body
Body Parameter — The updated column metadata
Return type
Example data
Content-Type: application/json
{
"columnLength" : 123,
"notes" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"dataType" : "aeiou",
"isPrimaryKey" : true,
"isIndex" : true,
"isMasked" : true,
"algorithmName" : "aeiou",
"tableMetadataId" : 123,
"isProfilerWritable" : true,
"columnMetadataId" : 123456789,
"isForeignKey" : true,
"domainName" : "aeiou",
"columnName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ColumnMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
post /database-connectors/{databaseConnectorId}/copy
Copy database connector by ID (copyDatabaseConnector)
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to copy format: int32
Request body
Body Parameter — The database connector to create
Return type
Example data
Content-Type: application/json
{
"servicePrincipal" : "aeiou",
"enableLogger" : true,
"databaseName" : "aeiou",
"instanceName" : "aeiou",
"databaseConnectorId" : 123,
"jdbc" : "aeiou",
"schemaName" : "aeiou",
"sid" : "aeiou",
"databaseType" : "aeiou",
"password" : "aeiou",
"environmentId" : 123,
"jdbcDriverId" : 123,
"port" : 123,
"customDriverName" : "aeiou",
"host" : "aeiou",
"connectorName" : "aeiou",
"fileReferenceId" : "aeiou",
"username" : "aeiou",
"kerberosAuth" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseConnector
400
Bad request
401
Unauthorized access
404
Not found
Up
post /database-connectors
Create database connector (createDatabaseConnector)
Request body
Body Parameter — The database connector to create
Return type
Example data
Content-Type: application/json
{
"servicePrincipal" : "aeiou",
"enableLogger" : true,
"databaseName" : "aeiou",
"instanceName" : "aeiou",
"databaseConnectorId" : 123,
"jdbc" : "aeiou",
"schemaName" : "aeiou",
"sid" : "aeiou",
"databaseType" : "aeiou",
"password" : "aeiou",
"environmentId" : 123,
"jdbcDriverId" : 123,
"port" : 123,
"customDriverName" : "aeiou",
"host" : "aeiou",
"connectorName" : "aeiou",
"fileReferenceId" : "aeiou",
"username" : "aeiou",
"kerberosAuth" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
DatabaseConnector
400
Bad request
401
Unauthorized access
404
Not found
Up
delete /database-connectors/{databaseConnectorId}
Delete database connector by ID (deleteDatabaseConnector)
Deletes database connector with given ID. This will also delete all rule sets and jobs which are using this connector.
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /database-connectors/{databaseConnectorId}/fetch
Fetch all accessible table names (fetchTableMetadata)
Note that only the names of tables that are accessible by the database user will be returned
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to fetch the tables for format: int32
Return type
array[String]
Example data
Content-Type: application/json
[ "aeiou" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /database-connectors
Get all database connectors (getAllDatabaseConnectors)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get database connectors. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all database connectors from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"servicePrincipal" : "aeiou",
"enableLogger" : true,
"databaseName" : "aeiou",
"instanceName" : "aeiou",
"databaseConnectorId" : 123,
"jdbc" : "aeiou",
"schemaName" : "aeiou",
"sid" : "aeiou",
"databaseType" : "aeiou",
"password" : "aeiou",
"environmentId" : 123,
"jdbcDriverId" : 123,
"port" : 123,
"customDriverName" : "aeiou",
"host" : "aeiou",
"connectorName" : "aeiou",
"fileReferenceId" : "aeiou",
"username" : "aeiou",
"kerberosAuth" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseConnectorList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /database-connectors/{databaseConnectorId}/properties
Get connection properties for database connector by ID (getConnectionProperties)
A list of properties provided through the connection properties file.
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to retrieve connection properties format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"edited" : true,
"name" : "aeiou",
"description" : "aeiou",
"value" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ConnectionPropertiesList
400
Bad request
404
Not found
Up
get /database-connectors/{databaseConnectorId}
Get database connector by ID (getDatabaseConnectorById)
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to get format: int32
Return type
Example data
Content-Type: application/json
{
"servicePrincipal" : "aeiou",
"enableLogger" : true,
"databaseName" : "aeiou",
"instanceName" : "aeiou",
"databaseConnectorId" : 123,
"jdbc" : "aeiou",
"schemaName" : "aeiou",
"sid" : "aeiou",
"databaseType" : "aeiou",
"password" : "aeiou",
"environmentId" : 123,
"jdbcDriverId" : 123,
"port" : 123,
"customDriverName" : "aeiou",
"host" : "aeiou",
"connectorName" : "aeiou",
"fileReferenceId" : "aeiou",
"username" : "aeiou",
"kerberosAuth" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseConnector
400
Bad request
404
Not found
Up
post /database-connectors/{databaseConnectorId}/test
Test database connector by ID (testDatabaseConnector)
WARNING: There is a known bug in the API Client where it is impossible to submit a request with an 'empty' body. As such, only the 'full' body variant of this endpoint can be used through the API Client. To use the 'empty' body variant of this endpoint, please do not use the API Client, but instead use curl or some other method of issuing HTTP requests.
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to test format: int32
Request body
Body Parameter — The database connector to test. This field is optional and if no password is supplied with the connector then the password associated with the databaseConnectorId will be used.
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TestConnectorResponse
400
Bad request
401
Unauthorized access
404
Not found
Up
post /database-connectors/test
Test an unsaved database connector (testUnsavedDatabaseConnector)
Request body
Body Parameter — The database connector to test
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TestConnectorResponse
400
Bad request
401
Unauthorized access
404
Not found
Up
put /database-connectors/{databaseConnectorId}
Update database connector by ID (updateDatabaseConnector)
Path parameters
databaseConnectorId (required)
Path Parameter — The ID of the database connector to update format: int32
Request body
Body Parameter — The updated database connector
Return type
Example data
Content-Type: application/json
{
"servicePrincipal" : "aeiou",
"enableLogger" : true,
"databaseName" : "aeiou",
"instanceName" : "aeiou",
"databaseConnectorId" : 123,
"jdbc" : "aeiou",
"schemaName" : "aeiou",
"sid" : "aeiou",
"databaseType" : "aeiou",
"password" : "aeiou",
"environmentId" : 123,
"jdbcDriverId" : 123,
"port" : 123,
"customDriverName" : "aeiou",
"host" : "aeiou",
"connectorName" : "aeiou",
"fileReferenceId" : "aeiou",
"username" : "aeiou",
"kerberosAuth" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseConnector
400
Bad request
401
Unauthorized access
404
Not found
Up
put /database-rulesets/{databaseRulesetId}/bulk-table-update
Update the set of tables and their attributes associated with a database ruleset in bulk (bulkTableUpdate)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to update the tables for format: int32
Request body
Body Parameter — The exact list of tables to put in the ruleset. Note that existing tables for this ruleset not in this list will be deleted
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /database-rulesets/{databaseRulesetId}/copy
Copy database ruleset by ID (copyDatabaseRuleset)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to copy format: int32
Request body
Body Parameter — The name of the ruleset. This must be unique within an environment.
Return type
Example data
Content-Type: application/json
{
"databaseRulesetId" : 123,
"databaseConnectorId" : 123,
"rulesetName" : "aeiou",
"refreshDropsTables" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseRuleset
400
Bad request
401
Unauthorized access
404
Not found
Up
post /database-rulesets
Create database ruleset (createDatabaseRuleset)
Request body
Body Parameter — The database ruleset to create
Return type
Example data
Content-Type: application/json
{
"databaseRulesetId" : 123,
"databaseConnectorId" : 123,
"rulesetName" : "aeiou",
"refreshDropsTables" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
DatabaseRuleset
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /database-rulesets/{databaseRulesetId}
Delete database ruleset by ID (deleteDatabaseRuleset)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /database-rulesets
Get all database rulesets (getAllDatabaseRulesets)
Query parameters
environment_id (optional)
Query Parameter — The ID of the environment to get all database rulesets from format: int32
page_number (optional)
Query Parameter — The page number for which to get database rulesets. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"databaseRulesetId" : 123,
"databaseConnectorId" : 123,
"rulesetName" : "aeiou",
"refreshDropsTables" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseRulesetList
400
Bad request
404
Not found
Up
get /database-rulesets/{databaseRulesetId}
Get database ruleset by ID (getDatabaseRulesetById)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to get format: int32
Return type
Example data
Content-Type: application/json
{
"databaseRulesetId" : 123,
"databaseConnectorId" : 123,
"rulesetName" : "aeiou",
"refreshDropsTables" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DatabaseRuleset
400
Bad request
401
Unauthorized access
404
Not found
Up
put /database-rulesets/{databaseRulesetId}/refresh
Refresh database ruleset by ID (refreshDatabaseRuleset)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to refresh format: int32
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /database-rulesets/{databaseRulesetId}
Update database ruleset (updateDatabaseRuleset)
Path parameters
databaseRulesetId (required)
Path Parameter — The ID of the database ruleset to update format: int32
Request body
Body Parameter — The updated form of the database ruleset
Return type
Example data
Content-Type: application/json
{
"databaseRulesetId" : 123,
"databaseConnectorId" : 123,
"rulesetName" : "aeiou",
"refreshDropsTables" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
DatabaseRuleset
400
Bad request
401
Unauthorized access
404
Not found
Create domain (createDomain)
Request body
Body Parameter — The domain to create
Return type
Example data
Content-Type: application/json
{
"defaultAlgorithmCode" : "aeiou",
"defaultTokenizationCode" : "aeiou",
"createdBy" : "aeiou",
"domainName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Domain
400
Bad request
404
Not found
409
Conflict
Up
delete /domains/{domainName}
Delete domain by name (deleteDomain)
Path parameters
domainName (required)
Path Parameter — The name of the domain to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
404
Not found
Get all domains (getAllDomains)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get domains. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"defaultAlgorithmCode" : "aeiou",
"defaultTokenizationCode" : "aeiou",
"createdBy" : "aeiou",
"domainName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
DomainList
400
Bad request
Up
get /domains/{domainName}
Get domain by name (getDomain)
Path parameters
domainName (required)
Path Parameter — The name of the domain to get
Return type
Example data
Content-Type: application/json
{
"defaultAlgorithmCode" : "aeiou",
"defaultTokenizationCode" : "aeiou",
"createdBy" : "aeiou",
"domainName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Success
Domain
400
Bad request
404
Not found
409
Conflict
Up
put /domains/{domainName}
Update domain by name (updateDomain)
Path parameters
domainName (required)
Path Parameter — The name of the domain to update
Request body
Body Parameter — The updated domain
Return type
Example data
Content-Type: application/json
{
"defaultAlgorithmCode" : "aeiou",
"defaultTokenizationCode" : "aeiou",
"createdBy" : "aeiou",
"domainName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Domain
400
Bad request
404
Not found
Generate a new encryption key for the masking engine (generateEncryptionKey)
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
AsyncTask
401
Unauthorized access
Up
post /environments/{environmentId}/copy
Copy environment by ID (copyEnvironment)
Path parameters
environmentId (required)
Path Parameter — The ID of the environment to copy format: int32
Request body
Body Parameter — The environment to create
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"purpose" : "aeiou",
"environmentName" : "aeiou",
"isWorkflowEnabled" : true,
"applicationId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Environment
400
Bad request
401
Unauthorized access
404
Not found
Create environment (createEnvironment)
Request body
Body Parameter — The environment to create
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"purpose" : "aeiou",
"environmentName" : "aeiou",
"isWorkflowEnabled" : true,
"applicationId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Environment
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /environments/{environmentId}
Delete environment by ID (deleteEnvironment)
Path parameters
environmentId (required)
Path Parameter — The ID of the environment to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Get all environments (getAllEnvironments)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get environments. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
application_id (optional)
Query Parameter — The ID of the application to get all environments from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"environmentId" : 123,
"purpose" : "aeiou",
"environmentName" : "aeiou",
"isWorkflowEnabled" : true,
"applicationId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
EnvironmentList
400
Bad request
401
Unauthorized access
Up
get /environments/{environmentId}
Get environment by ID (getEnvironmentById)
Path parameters
environmentId (required)
Path Parameter — The ID of the environment to get format: int32
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"purpose" : "aeiou",
"environmentName" : "aeiou",
"isWorkflowEnabled" : true,
"applicationId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Environment
401
Unauthorized access
404
Not found
Up
put /environments/{environmentId}
Update environment by ID (updateEnvironment)
Path parameters
environmentId (required)
Path Parameter — The ID of the environment to update format: int32
Request body
Body Parameter — The updated environment
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"purpose" : "aeiou",
"environmentName" : "aeiou",
"isWorkflowEnabled" : true,
"applicationId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Environment
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
post /executions/{executionId}/cancel
Cancel execution by ID (cancelExecution)
Path parameters
executionId (required)
Path Parameter — The ID of the execution to cancel format: int32
Query parameters
expectedStatus (optional)
Query Parameter — 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.
Return type
Example data
Content-Type: application/json
{
"targetConnectorId" : 123,
"executionId" : 123,
"jobId" : 123,
"connectorType" : "aeiou",
"submitTime" : "2000-01-23T04:56:07.000+00:00",
"rowsTotal" : 123456789,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"rowsMasked" : 123456789,
"sourceConnectorId" : 123,
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Execution
400
Bad request
401
Unauthorized access
404
Not found
Create execution (createExecution)
Request body
Body Parameter — The execution to create
Return type
Example data
Content-Type: application/json
{
"targetConnectorId" : 123,
"executionId" : 123,
"jobId" : 123,
"connectorType" : "aeiou",
"submitTime" : "2000-01-23T04:56:07.000+00:00",
"rowsTotal" : 123456789,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"rowsMasked" : 123456789,
"sourceConnectorId" : 123,
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Execution
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Get all executions (getAllExecutions)
Query parameters
job_id (optional)
Query Parameter — The ID of the job to get all executions for format: int32
page_number (optional)
Query Parameter — The page number for which to get executions. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
execution_status (optional)
Query Parameter — The status of the job execution. Note that, if this parameter is excluded, then all executions will be returned..
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"targetConnectorId" : 123,
"executionId" : 123,
"jobId" : 123,
"connectorType" : "aeiou",
"submitTime" : "2000-01-23T04:56:07.000+00:00",
"rowsTotal" : 123456789,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"rowsMasked" : 123456789,
"sourceConnectorId" : 123,
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionList
400
Bad request
401
Unauthorized access
Up
get /executions/{executionId}
Get execution by ID (getExecutionById)
Path parameters
executionId (required)
Path Parameter — The ID of the execution to get format: int32
Return type
Example data
Content-Type: application/json
{
"targetConnectorId" : 123,
"executionId" : 123,
"jobId" : 123,
"connectorType" : "aeiou",
"submitTime" : "2000-01-23T04:56:07.000+00:00",
"rowsTotal" : 123456789,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"rowsMasked" : 123456789,
"sourceConnectorId" : 123,
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Execution
400
Bad request
401
Unauthorized access
404
Not found
Up
get /execution-components
Get all execution components (getAllExecutionComponents)
Query parameters
execution_id (optional)
Query Parameter — The ID of the execution to get all components for format: int32
page_number (optional)
Query Parameter — The page number for which to get executions. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"executionId" : 123,
"rowsTotal" : 123456789,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"componentName" : "aeiou",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"rowsMasked" : 123456789,
"executionComponentId" : 123,
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionComponentList
400
Bad request
401
Unauthorized access
404
Not found
Get all execution events (getAllExecutionEvents)
Get events, such as warnings or errors, associated with job executions.
Query parameters
execution_id (optional)
Query Parameter — The ID of the execution to get all events for format: int32
page_number (optional)
Query Parameter — The page number for which to get execution events. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"executionEventId" : 123456789,
"severity" : "aeiou",
"timeStamp" : "2000-01-23T04:56:07.000+00:00",
"maskedObjectName" : "aeiou",
"exceptionType" : "aeiou",
"executionId" : 123,
"count" : 123456789,
"cause" : "aeiou",
"eventType" : "aeiou",
"algorithmName" : "aeiou",
"executionComponentId" : 123,
"exceptionDetail" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionEventList
400
Bad request
401
Unauthorized access
404
Not found
Create file connector (createFileConnector)
Request body
Body Parameter — The file connector to create
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"fileConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
},
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileConnector
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /file-connectors/{fileConnectorId}
Delete file connector by ID (deleteFileConnector)
Deletes file connector with given ID. This will also delete all rule sets and jobs which are using this connector.
Path parameters
fileConnectorId (required)
Path Parameter — The ID of the file connector to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /file-connectors/{fileConnectorId}/fetch
Fetch all accessible file names (fetchFileMetadata)
Note that even the names of files in the directory path that are not readable or writable will be returned
Path parameters
fileConnectorId (required)
Path Parameter — The ID of the file connector to fetch the files for format: int32
Return type
array[String]
Example data
Content-Type: application/json
[ "aeiou" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all file connectors (getAllFileConnectors)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get file connectors. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all file connectors from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"environmentId" : 123,
"fileConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
},
"fileType" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileConnectorList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /file-connectors/{fileConnectorId}
Get file connector by ID (getFileConnectorById)
Path parameters
fileConnectorId (required)
Path Parameter — The ID of the file connector to get format: int32
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"fileConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
},
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileConnector
400
Bad request
401
Unauthorized access
404
Not found
Up
post /file-connectors/{fileConnectorId}/test
Test file connector by ID (testFileConnector)
WARNING: There is a known bug in the API Client where it is impossible to submit a request with an 'empty' body. As such, only the 'full' body variant of this endpoint can be used through the API Client. To use the 'empty' body variant of this endpoint, please do not use the API Client, but instead use curl or some other method of issuing HTTP requests.
Path parameters
fileConnectorId (required)
Path Parameter — The ID of the file connector to test format: int32
Request body
Body Parameter — The file connector to test. This field is optional and if no password or sshkey is supplied with the connector then the password associated with the fileConnectorId will be used.
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TestConnectorResponse
400
Bad request
401
Unauthorized access
404
Not found
Up
post /file-connectors/test
Test an unsaved file connector (testUnsavedFileConnector)
Request body
Body Parameter — The file connector to test
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TestConnectorResponse
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-connectors/{fileConnectorId}
Update file connector by ID (updateFileConnector)
Path parameters
fileConnectorId (required)
Path Parameter — The ID of the file connector to update format: int32
Request body
Body Parameter — The updated file connector
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"fileConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
},
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileConnector
400
Bad request
401
Unauthorized access
404
Not found
Up
get /file-downloads/{fileDownloadId}
Download file (downloadFile)
Path parameters
fileDownloadId (required)
Path Parameter — The file identifier returned from the GET call of the object
Return type
File
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
201
Success
File
400
Bad request
401
Unauthorized access
404
Not found
Up
post /file-field-metadata
Create file field metadata (createFileFieldMetadata)
Request body
Body Parameter — The file filed metadata to create
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"fieldName" : "aeiou",
"notes" : "aeiou",
"fileFieldMetadataId" : 123,
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"isMasked" : true,
"algorithmName" : "aeiou",
"fieldPositionNumber" : 123,
"isProfilerWritable" : true,
"recordTypeId" : 123,
"domainName" : "aeiou",
"fieldLength" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFieldMetadata
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
get /file-field-metadata
Get all file field metadata (getAllFileFieldMetadata)
Query parameters
file_format_id (optional)
Query Parameter — The ID of the file format to get all file field metadata from format: int32
record_type_id (optional)
Query Parameter — The ID of the record type to get all file field metadata from format: int32
is_masked (optional)
Query Parameter — Get only masked file field metadata when this is true and only unmasked file field metadata when this is false
page_number (optional)
Query Parameter — The page number for which to get file field metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"fileFormatId" : 123,
"fieldName" : "aeiou",
"notes" : "aeiou",
"fileFieldMetadataId" : 123,
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"isMasked" : true,
"algorithmName" : "aeiou",
"fieldPositionNumber" : 123,
"isProfilerWritable" : true,
"recordTypeId" : 123,
"domainName" : "aeiou",
"fieldLength" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFieldMetadataList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /file-field-metadata/{fileFieldMetadataId}
Get file field metadata by ID (getFileFieldMetadataById)
Path parameters
fileFieldMetadataId (required)
Path Parameter — The ID of the file field metadata to get format: int32
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"fieldName" : "aeiou",
"notes" : "aeiou",
"fileFieldMetadataId" : 123,
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"isMasked" : true,
"algorithmName" : "aeiou",
"fieldPositionNumber" : 123,
"isProfilerWritable" : true,
"recordTypeId" : 123,
"domainName" : "aeiou",
"fieldLength" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFieldMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-field-metadata/{fileFieldMetadataId}
Update file field metadata by ID (updateFileFieldMetadata)
Path parameters
fileFieldMetadataId (required)
Path Parameter — The ID of the file field metadata to update format: int32
Request body
Body Parameter — The updated file field metadata
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"fieldName" : "aeiou",
"notes" : "aeiou",
"fileFieldMetadataId" : 123,
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"isMasked" : true,
"algorithmName" : "aeiou",
"fieldPositionNumber" : 123,
"isProfilerWritable" : true,
"recordTypeId" : 123,
"domainName" : "aeiou",
"fieldLength" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFieldMetadata
400
Bad request
401
Unauthorized access
404
Not found
Create file format (createFileFormat)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
fileFormat (required)
Form Parameter — The file format to be uploaded. The logical name of the file format will be exactly the name of this uploaded file
fileFormatType (required)
Form Parameter — The type of the file format being uploaded
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"footer" : 123,
"header" : 123,
"fileFormatName" : "aeiou",
"fileFormatType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileFormat
401
Unauthorized access
409
Conflict
Up
delete /file-formats/{fileFormatId}
Delete file format by ID (deleteFileFormat)
Path parameters
fileFormatId (required)
Path Parameter — The ID of the file format to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all file formats (getAllFileFormats)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get file formats. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"fileFormatId" : 123,
"footer" : 123,
"header" : 123,
"fileFormatName" : "aeiou",
"fileFormatType" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFormatList
401
Unauthorized access
Up
get /file-formats/{fileFormatId}
Get file format by ID (getFileFormatById)
Path parameters
fileFormatId (required)
Path Parameter — The ID of the file format to get format: int32
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"footer" : 123,
"header" : 123,
"fileFormatName" : "aeiou",
"fileFormatType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileFormat
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-formats/{fileFormatId}
Update file format (updateFileFormat)
Path parameters
fileFormatId (required)
Path Parameter — The ID of the file format to update format: int32
Request body
Body Parameter — The updated file format
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"footer" : 123,
"header" : 123,
"fileFormatName" : "aeiou",
"fileFormatType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileFormat
400
Bad request
401
Unauthorized access
404
Not found
Create file metadata (createFileMetadata)
Request body
Body Parameter — The file metadata to create
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"escapeEnclosureEscapeCharacter" : true,
"wholeFileMasking" : true,
"fileName" : "aeiou",
"fileFormatId" : 123,
"fileMetadataId" : 123,
"enclosureEscapeCharacter" : "aeiou",
"enclosure" : "aeiou",
"nameIsRegularExpression" : true,
"delimiter" : "aeiou",
"endOfRecord" : "aeiou",
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileMetadata
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /file-metadata/{fileMetadataId}
Delete file metadata by ID (deleteFileMetadata)
Path parameters
fileMetadataId (required)
Path Parameter — The ID of the file metadata to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all file metadata (getAllFileMetadata)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get file metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
ruleset_id (optional)
Query Parameter — The ID of the ruleset to get all file metadata from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"rulesetId" : 123,
"escapeEnclosureEscapeCharacter" : true,
"wholeFileMasking" : true,
"fileName" : "aeiou",
"fileFormatId" : 123,
"fileMetadataId" : 123,
"enclosureEscapeCharacter" : "aeiou",
"enclosure" : "aeiou",
"nameIsRegularExpression" : true,
"delimiter" : "aeiou",
"endOfRecord" : "aeiou",
"fileType" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileMetadataList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /file-metadata/{fileMetadataId}
Get file metadata by ID (getFileMetadataById)
Path parameters
fileMetadataId (required)
Path Parameter — The ID of the file metadata to get format: int32
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"escapeEnclosureEscapeCharacter" : true,
"wholeFileMasking" : true,
"fileName" : "aeiou",
"fileFormatId" : 123,
"fileMetadataId" : 123,
"enclosureEscapeCharacter" : "aeiou",
"enclosure" : "aeiou",
"nameIsRegularExpression" : true,
"delimiter" : "aeiou",
"endOfRecord" : "aeiou",
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-metadata/{fileMetadataId}
Update file metadata by ID (updateFileMetadata)
Path parameters
fileMetadataId (required)
Path Parameter — The ID of the file metadata to update format: int32
Request body
Body Parameter — Updated fileMetadata object
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"escapeEnclosureEscapeCharacter" : true,
"wholeFileMasking" : true,
"fileName" : "aeiou",
"fileFormatId" : 123,
"fileMetadataId" : 123,
"enclosureEscapeCharacter" : "aeiou",
"enclosure" : "aeiou",
"nameIsRegularExpression" : true,
"delimiter" : "aeiou",
"endOfRecord" : "aeiou",
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-rulesets/{fileRulesetId}/bulk-file-update
Update the set of files and their attributes associated with a file ruleset in bulk (bulkFileUpdate)
Path parameters
fileRulesetId (required)
Path Parameter — The ID of the file ruleset to update the file for format: int32
Request body
Body Parameter — The exact list of files to put in the ruleset. Note that existing files for this ruleset not in this list will be deleted
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-rulesets/{fileRulesetId}/copy
Copy file ruleset by ID (copyFileRuleset)
Path parameters
fileRulesetId (required)
Path Parameter — The ID of the file ruleset to copy format: int32
Request body
Body Parameter — The name of the ruleset. This must be unique within an environment.
Return type
Example data
Content-Type: application/json
{
"fileConnectorId" : 123,
"rulesetName" : "aeiou",
"fileRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileRuleset
400
Bad request
401
Unauthorized access
404
Not found
Create file ruleset (createFileRuleset)
Request body
Body Parameter — The file ruleset to create
Return type
Example data
Content-Type: application/json
{
"fileConnectorId" : 123,
"rulesetName" : "aeiou",
"fileRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileRuleset
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /file-rulesets/{fileRulesetId}
Delete file ruleset by ID (deleteFileRuleset)
Path parameters
fileRulesetId (required)
Path Parameter — The ID of the file ruleset to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Get all file rulesets (getAllFileRulesets)
Query parameters
environment_id (optional)
Query Parameter — The ID of the environment to get all file rulesets from format: int32
page_number (optional)
Query Parameter — The page number for which to get file rulesets. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"fileConnectorId" : 123,
"rulesetName" : "aeiou",
"fileRulesetId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileRulesetList
401
Unauthorized access
404
Not found
Up
get /file-rulesets/{fileRulesetId}
Get file ruleset by ID (getFileRulesetById)
Path parameters
fileRulesetId (required)
Path Parameter — The ID of the file ruleset to get format: int32
Return type
Example data
Content-Type: application/json
{
"fileConnectorId" : 123,
"rulesetName" : "aeiou",
"fileRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileRuleset
401
Unauthorized access
404
Not found
Delete all files (deleteAllFileUploads)
Query parameters
permanent (optional)
Query Parameter — This indicates whether all of the files that should be deleted are in the permanent upload directory. This defaults to false so all of the files that are deleted are in the temporary upload directory. default: false
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
Up
delete /file-uploads/{fileUuid}
Delete permanent file upload by ID (deleteFileByUuid)
Path parameters
fileUuid (required)
Path Parameter — The unique identifier of the permanently uploaded file to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
Get all files (getAllFiles)
Query parameters
permanent (optional)
Query Parameter — This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file. default: false
page_number (optional)
Query Parameter — The page number for which to get algorithms. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"filename" : "aeiou",
"persistenceType" : "aeiou",
"fileSize" : 1.3579000000000001069366817318950779736042022705078125,
"fileReferenceId" : "aeiou",
"fileUuid" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileUploadList
400
Bad request
401
Unauthorized access
Up
get /file-uploads/{fileUuid}
Get file upload by ID (getFileByUuid)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Path parameters
fileUuid (required)
Path Parameter — The unique identifier of the permanently uploaded file to get
Return type
Example data
Content-Type: application/json
{
"filename" : "aeiou",
"persistenceType" : "aeiou",
"fileSize" : 1.3579000000000001069366817318950779736042022705078125,
"fileReferenceId" : "aeiou",
"fileUuid" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
FileUpload
400
Bad request
401
Unauthorized access
404
Not found
Up
put /file-uploads/{fileUuid}
Update permanent file upload by ID (updateFileByUuid)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Path parameters
fileUuid (required)
Path Parameter — The unique identifier of the permanently uploaded file to update
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
file (required)
Form Parameter — The file to be uploaded.
Return type
Example data
Content-Type: application/json
{
"filename" : "aeiou",
"persistenceType" : "aeiou",
"fileSize" : 1.3579000000000001069366817318950779736042022705078125,
"fileReferenceId" : "aeiou",
"fileUuid" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileUpload
401
Unauthorized access
409
Conflict
Upload file (uploadFile)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
permanent (optional)
Query Parameter — This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file. default: false
Form parameters
file (required)
Form Parameter — The file to be uploaded.
Return type
Example data
Content-Type: application/json
{
"filename" : "aeiou",
"persistenceType" : "aeiou",
"fileSize" : 1.3579000000000001069366817318950779736042022705078125,
"fileReferenceId" : "aeiou",
"fileUuid" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
FileUpload
401
Unauthorized access
409
Conflict
Up
get /algorithms/frameworks/{frameworkId}/defaultExtension
Get algorithm framework default extension by frameworkId (getAlgorithmDefaultExtension)
Path parameters
frameworkId (required)
Path Parameter — The id of the framework format: int64
Return type
Example data
Content-Type: application/json
{
"frameworkId" : 123456789,
"algorithmExtension" : "{}",
"algorithmType" : "aeiou",
"createdBy" : "aeiou",
"isTokenizationSupported" : true,
"pluginId" : 123456789,
"description" : "aeiou",
"fields" : [ {
"isReadOnly" : true,
"name" : "aeiou",
"description" : "aeiou",
"isOptional" : true,
"type" : "aeiou",
"fieldId" : 123456789
} ],
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Algorithm
400
Bad request
401
Unauthorized access
404
Not found
Up
post /application-logs
Create log statement (createLogStatement)
Request body
Body Parameter — The log statement to create
Return type
Example data
Content-Type: application/json
{
"logLevel" : "aeiou",
"logStatement" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
LogStatement
401
Unauthorized access
Create installation (createInstallation)
Request body
Body Parameter — The installation to create
Return type
Example data
Content-Type: application/json
{
"fileReferenceId" : "aeiou",
"requiresRestart" : true,
"fileType" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Installation
400
Bad request
401
Unauthorized access
409
Conflict
Up
delete /installations/{fileType}
Delete installation by file type (deleteInstallation)
Path parameters
fileType (required)
Path Parameter — The file type of the installation to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Create Jdbc Driver (createJdbcDriver)
Request body
Body Parameter — The jdbc driver details.
Return type
Example data
Content-Type: application/json
{
"loggerInstalled" : true,
"jdbcDriverId" : 123,
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"builtIn" : true,
"driverClassName" : "aeiou",
"checksum" : "aeiou",
"description" : "aeiou",
"fileReferenceId" : "aeiou",
"driverName" : "aeiou",
"version" : "aeiou",
"uploadedBy" : "aeiou",
"driverSupportId" : 123456789
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
JdbcDriver
401
Unauthorized access
409
Conflict
Up
delete /jdbc-drivers/{jdbcDriverId}
Delete JDBC driver by ID (deleteJdbcDriver)
Path parameters
jdbcDriverId (required)
Path Parameter — The ID of the JDBC driver to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all JDBC drivers (getAllJdbcDrivers)
Query parameters
is_built_in (optional)
Query Parameter — Get only drivers that are built in to the engine when this is true and only user uploaded drivers when this is false
page_number (optional)
Query Parameter — The page number for which to get JDBC drivers. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"loggerInstalled" : true,
"jdbcDriverId" : 123,
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"builtIn" : true,
"driverClassName" : "aeiou",
"checksum" : "aeiou",
"description" : "aeiou",
"fileReferenceId" : "aeiou",
"driverName" : "aeiou",
"version" : "aeiou",
"uploadedBy" : "aeiou",
"driverSupportId" : 123456789
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
JdbcDriversList
401
Unauthorized access
Up
get /jdbc-drivers/{jdbcDriverId}
Get JDBC driver by ID (getJdbcDriverById)
Path parameters
jdbcDriverId (required)
Path Parameter — The ID of the JDBC driver to get format: int32
Return type
Example data
Content-Type: application/json
{
"loggerInstalled" : true,
"jdbcDriverId" : 123,
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"builtIn" : true,
"driverClassName" : "aeiou",
"checksum" : "aeiou",
"description" : "aeiou",
"fileReferenceId" : "aeiou",
"driverName" : "aeiou",
"version" : "aeiou",
"uploadedBy" : "aeiou",
"driverSupportId" : 123456789
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
JdbcDriver
400
Bad request
401
Unauthorized access
404
Not found
Up
put /jdbc-drivers/{jdbcDriverId}
Update jdbc driver (updateJdbcDriver)
Path parameters
jdbcDriverId (required)
Path Parameter — The ID of the JDBC driver to update format: int32
Request body
Body Parameter — The jdbc driver details.
Return type
Example data
Content-Type: application/json
{
"loggerInstalled" : true,
"jdbcDriverId" : 123,
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"builtIn" : true,
"driverClassName" : "aeiou",
"checksum" : "aeiou",
"description" : "aeiou",
"fileReferenceId" : "aeiou",
"driverName" : "aeiou",
"version" : "aeiou",
"uploadedBy" : "aeiou",
"driverSupportId" : 123456789
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
JdbcDriver
400
Bad request
401
Unauthorized access
404
Not found
Up
get /knowledge-base-info
Get all knowledge base info (getAllKnowledgeBaseInfo)
Query parameters
execution_event_id (optional)
Query Parameter — The ID of the execution event for which to get knowledge base info format: int64
page_number (optional)
Query Parameter — The page number for which to get knowledge baee info. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"knowledgeBaseInfoId" : 123456789,
"link" : "aeiou",
"tag" : "aeiou",
"title" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
KnowledgeBaseInfoList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /execution-component-log
Get all execution components logs (getAllExecutionComponents)
Query parameters
execution_id (required)
Query Parameter — The ID of the Execution to get all component logs format: int32
page_number (optional)
Query Parameter — The page number for which to get executions component. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"executionId" : 123,
"componentId" : 123,
"componentName" : "aeiou",
"fileDownloadId" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionComponentLogsList
400
Bad request
401
Unauthorized access
Get all execution logs (getAllExecutionLogs)
Query parameters
job_id (optional)
Query Parameter — The ID of the job to get all executions for format: int32
page_number (optional)
Query Parameter — The page number for which to get executions. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
execution_status (optional)
Query Parameter — The status of the job execution. Note that, if this parameter is excluded, then all executions will be returned.
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"executionId" : 123,
"jobId" : 123,
"fileDownloadId" : "aeiou",
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionLogsList
400
Bad request
401
Unauthorized access
Get all logs. Note that the logs will be returned in order from most recent to least recent. (getAllLogs)
Query parameters
log_level (optional)
Query Parameter — The log level of the log file. Note that, if this parameter is excluded, the log files will be returned in alphabetical order with respect to their log level.
page_number (optional)
Query Parameter — The page number for which to get logs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"logLevel" : "aeiou",
"fileDownloadId" : "aeiou",
"file-number" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
LogFileInfoList
401
Unauthorized access
Get all audit logs (getAuditLogs)
Query parameters
user_name (optional)
Query Parameter — The name of the user that took the action for this entry.
action_type (optional)
Query Parameter — The type of action that occurred for this Audit Log entry.
target (optional)
Query Parameter — The type object or operation that the action occurred on for this Audit Log entry.
status (optional)
Query Parameter — The status of the action that occurred for this Audit Log entry. This can change over time as ATTEMPTED actions are completed.
start_time (optional)
Query Parameter — The date after which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.
end_time (optional)
Query Parameter — The date before which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.
page_number (optional)
Query Parameter — The page number for which to get logs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"auditId" : 123,
"actionType" : "aeiou",
"ipAddress" : "aeiou",
"activityTime" : "2000-01-23T04:56:07.000+00:00",
"activityDescription" : "aeiou",
"userName" : "aeiou",
"target" : "aeiou",
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
AuditLogList
401
Unauthorized access
Up
get /execution-component-log/{componentId}
Get execution component log by component ID (getExecutionComponentById)
Path parameters
componentId (required)
Path Parameter — The ID of the execution to get format: int32
Return type
Example data
Content-Type: application/json
{
"executionId" : 123,
"componentId" : 123,
"componentName" : "aeiou",
"fileDownloadId" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionComponentLog
400
Bad request
401
Unauthorized access
Up
get /execution-logs/{executionId}
Get all execution log by ID (getExecutionLogsById)
Path parameters
executionId (required)
Path Parameter — The ID of the execution to get format: int32
Return type
Example data
Content-Type: application/json
{
"executionId" : 123,
"jobId" : 123,
"fileDownloadId" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExecutionLog
400
Bad request
401
Unauthorized access
Log in to the Masking Engine (login)
Request body
Body Parameter — The login object
Return type
Example data
Content-Type: application/json
{
"Authorization" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
LoginResponse
401
Unauthorized access
Log out of the Masking Engine (logout)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Success
401
Unauthorized access
Log in to the Masking Engine with an OAuth2 access token from a customer's Authorization Server. (oauth2Login)
Return type
Example data
Content-Type: application/json
{
"Authorization" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
LoginResponse
401
Unauthorized access
Log in to the Masking Engine with an OAuth2 access token from Data Control Tower. (ssoLogin)
Return type
Example data
Content-Type: application/json
{
"Authorization" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
LoginResponse
401
Unauthorized access
Up
post /mainframe-dataset-connectors
Create Mainframe Dataset connector (createMainframeDatasetConnector)
Request body
Body Parameter — The Mainframe Dataset connector to create
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"mainframeDatasetConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetConnector
Up
delete /mainframe-dataset-connectors/{mainframeDatasetConnectorId}
Delete Mainframe Dataset connector by ID (deleteMainframeDatasetConnector)
Path parameters
mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Invalid mainframeDatasetConnectorId supplied
404
Mainframe Dataset Connector not found
Up
get /mainframe-dataset-connectors/{mainframeDatasetConnectorId}/fetch
Fetch all accessible file names (fetchMainframeDatasetMetadata)
Note that even the names of files in the directory path that are not readable or writable will be returned
Path parameters
mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to fetch the files for format: int32
Return type
array[String]
Example data
Content-Type: application/json
[ "aeiou" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Invalid mainframeDatasetConnectorId supplied
404
Mainframe Dataset Connector not found
Up
get /mainframe-dataset-connectors
Get all Mainframe Dataset connectors (getAllMainframeDatasetConnectors)
Query parameters
environment_id (optional)
Query Parameter — The ID of the environment to get all Mainframe Dataset connectors from format: int32
page_number (optional)
Query Parameter — The page number for which to get Mainframe Dataset connectors. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"environmentId" : 123,
"mainframeDatasetConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetConnectorList
Up
get /mainframe-dataset-connectors/{mainframeDatasetConnectorId}
Get Mainframe Dataset connector by ID (getMainframeDatasetConnectorById)
Path parameters
mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to get format: int32
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"mainframeDatasetConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
MainframeDatasetConnector
400
Invalid mainframeDatasetConnectorId supplied
404
Mainframe Dataset Connector not found
Up
post /mainframe-dataset-connectors/{mainframeDatasetConnectorId}/test
Test Mainframe Dataset connector by ID (testMainframeDatasetConnector)
WARNING: There is a known bug in the API Client where it is impossible to submit a request with an 'empty' body. As such, only the 'full' body variant of this endpoint can be used through the API Client. To use the 'empty' body variant of this endpoint, please do not use the API Client, but instead use curl or some other method of issuing HTTP requests.
Path parameters
mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to test format: int32
Request body
Body Parameter — The Mainframe Dataset connector to test. This field is optional and if no password or sshkey is supplied with the connector then the password associated with the fileConnectorId will be used.
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
TestConnectorResponse
400
Invalid mainframeDatasetConnectorId supplied
404
Mainframe Dataset Connector not found
Up
post /mainframe-dataset-connectors/test
Test an unsaved Mainframe Dataset connector (testUnsavedMainframeDatasetConnector)
Request body
Body Parameter — The Mainframe Dataset connector to test
Return type
Example data
Content-Type: application/json
{
"response" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TestConnectorResponse
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mainframe-dataset-connectors/{mainframeDatasetConnectorId}
Update Mainframe Dataset connector by ID (updateMainframeDatasetConnector)
Path parameters
mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to update format: int32
Request body
Body Parameter — The updated Mainframe Dataset connector
Return type
Example data
Content-Type: application/json
{
"environmentId" : 123,
"mainframeDatasetConnectorId" : 123,
"connectorName" : "aeiou",
"connectionInfo" : {
"path" : "aeiou",
"mountId" : 123,
"password" : "aeiou",
"connectionMode" : "aeiou",
"userDirIsRoot" : true,
"port" : 123,
"sshKey" : "aeiou",
"loginName" : "aeiou",
"host" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
MainframeDatasetConnector
400
Invalid mainframeDatasetConnectorId supplied
404
Mainframe Dataset Connector not found
Up
get /mainframe-dataset-field-metadata
Get all Mainframe Dataset field metadata (getAllMainframeDatasetFieldMetadata)
Query parameters
mainframe_dataset_format_id (optional)
Query Parameter — The ID of the Mainframe Dataset format to get all Mainframe Dataset field metadata from format: int32
is_masked (optional)
Query Parameter — Get only masked Mainframe Dataset field metadata when this is true and only unmasked Mainframe Dataset field metadata when this is false
page_number (optional)
Query Parameter — The page number for which to get Mainframe Dataset field metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"isProfilerWritable" : true,
"fieldName" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"domainName" : "aeiou",
"mainframeDatasetFormatId" : 123,
"isMasked" : true,
"algorithmName" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"parentId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetFieldMetadataList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}
Get Mainframe Dataset field metadata by ID (getMainframeDatasetFieldMetadataById)
Path parameters
mainframeDatasetFieldMetadataId (required)
Path Parameter — The ID of the Mainframe Dataset field metadata to get format: int32
Return type
Example data
Content-Type: application/json
{
"isProfilerWritable" : true,
"fieldName" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"domainName" : "aeiou",
"mainframeDatasetFormatId" : 123,
"isMasked" : true,
"algorithmName" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"parentId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetFieldMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}
Update Mainframe Dataset field metadata by ID (updateMainframeDatasetFieldMetadata)
Path parameters
mainframeDatasetFieldMetadataId (required)
Path Parameter — The ID of the Mainframe Dataset field metadata to update format: int32
Request body
Body Parameter — The updated Mainframe Dataset field metadata
Return type
Example data
Content-Type: application/json
{
"isProfilerWritable" : true,
"fieldName" : "aeiou",
"algorithmFieldId" : 123456789,
"algorithmGroupNo" : 123456789,
"dateFormat" : "aeiou",
"domainName" : "aeiou",
"mainframeDatasetFormatId" : 123,
"isMasked" : true,
"algorithmName" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"parentId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetFieldMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mainframe-dataset-formats
Create Mainframe Dataset format (createMainframeDatasetFormat)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload Mainframe Dataset files through the API
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
mainframeDatasetFormat (required)
Form Parameter — The Mainframe Dataset format to be uploaded. The logical name of the Mainframe Dataset format will be exactly the name of this uploaded Mainframe Dataset file
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetFormatName" : "aeiou",
"mainframeDatasetFormatId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
MainframeDatasetFormat
401
Unauthorized access
409
Conflict
Up
delete /mainframe-dataset-formats/{mainframeDatasetFormatId}
Delete Mainframe Dataset format by ID (deleteMainframeDatasetFormat)
Path parameters
mainframeDatasetFormatId (required)
Path Parameter — The ID of the Mainframe Dataset format to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /mainframe-dataset-formats
Get all Mainframe Dataset formats (getAllMainframeDatasetFormats)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get Mainframe Dataset formats. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"mainframeDatasetFormatName" : "aeiou",
"mainframeDatasetFormatId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetFormatList
401
Unauthorized access
Up
get /mainframe-dataset-formats/{mainframeDatasetFormatId}
Get Mainframe Dataset format by ID (getMainframeDatasetFormatById)
Path parameters
mainframeDatasetFormatId (required)
Path Parameter — The ID of the Mainframe Dataset format to get format: int32
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetFormatName" : "aeiou",
"mainframeDatasetFormatId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetFormat
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mainframe-dataset-metadata
Create Mainframe Dataset metadata (createMainframeDatasetMetadata)
Request body
Body Parameter — The Mainframe Dataset metadata to create
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"fileName" : "aeiou",
"nameIsRegularExpression" : true,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetMetadataId" : 123,
"recordFormat" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetMetadata
Up
delete /mainframe-dataset-metadata/{mainframeDatasetMetadataId}
Delete Mainframe Dataset metadata by ID (deleteMainframeDatasetMetadata)
Path parameters
mainframeDatasetMetadataId (required)
Path Parameter — The ID of the Mainframe Dataset metadata to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Invalid mainframeDatasetMetadataId supplied
404
MainframeDatasetMetadata not found
Up
get /mainframe-dataset-metadata
Get all Mainframe Dataset metadata (getAllMainframeDatasetMetadata)
Query parameters
ruleset_id (optional)
Query Parameter — The ID of the ruleset to get all Mainframe Dataset metadata from format: int32
page_number (optional)
Query Parameter — The page number for which to get Mainframe Dataset metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"rulesetId" : 123,
"fileName" : "aeiou",
"nameIsRegularExpression" : true,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetMetadataId" : 123,
"recordFormat" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetMetadataList
Up
get /mainframe-dataset-metadata/{mainframeDatasetMetadataId}
Get Mainframe Dataset metadata by ID (getMainframeDatasetMetadataById)
Path parameters
mainframeDatasetMetadataId (required)
Path Parameter — The ID of the Mainframe Dataset metadata to get format: int32
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"fileName" : "aeiou",
"nameIsRegularExpression" : true,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetMetadataId" : 123,
"recordFormat" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
MainframeDatasetMetadata
400
Invalid mainframeDatasetMetadataId supplied
404
MainframeDatasetMetadata not found
Up
put /mainframe-dataset-metadata/{mainframeDatasetMetadataId}
Update Mainframe Dataset metadata by ID (updateMainframeDatasetMetadata)
Path parameters
mainframeDatasetMetadataId (required)
Path Parameter — The ID of the Mainframe Dataset metadata to update format: int32
Request body
Body Parameter — The updated Mainframe Dataset metadata
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"fileName" : "aeiou",
"nameIsRegularExpression" : true,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetMetadataId" : 123,
"recordFormat" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
MainframeDatasetMetadata
400
Invalid mainframeDatasetMetadataId supplied
404
MainframeDatasetMetadata not found
Up
get /mainframe-dataset-record-types
Get all Mainframe Dataset record type (getAllMainframeDatasetRecordTypes)
Query parameters
mainframe_dataset_format_id (optional)
Query Parameter — The ID of the Mainframe Dataset format to get all Mainframe Dataset record types from format: int32
page_number (optional)
Query Parameter — The page number for which to get mainframe dataset record types. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"mainframeDatasetRecordTypeId" : 123,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetRecordTypeName" : "aeiou",
"type" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"redefineCondition" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetRecordTypeList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /mainframe-dataset-record-types/{mainframeDatasetRecordTypeId}
Get Mainframe Dataset record type by ID (getMainframeDatasetRecordTypeById)
Path parameters
mainframeDatasetRecordTypeId (required)
Path Parameter — The ID of the Mainframe Dataset record type to get format: int32
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetRecordTypeId" : 123,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetRecordTypeName" : "aeiou",
"type" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"redefineCondition" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetRecordType
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mainframe-dataset-record-types/{mainframeDatasetRecordTypeId}
Update Mainframe Dataset record type by ID (updateMainframeDatasetRecordType)
Path parameters
mainframeDatasetRecordTypeId (required)
Path Parameter — The ID of the Mainframe Dataset record type to update format: int32
Request body
Body Parameter — The updated Mainframe Dataset record type
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetRecordTypeId" : 123,
"mainframeDatasetFormatId" : 123,
"mainframeDatasetRecordTypeName" : "aeiou",
"type" : "aeiou",
"mainframeDatasetFieldMetadataId" : 123,
"redefineCondition" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetRecordType
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/bulk-mainframe-dataset-update
Update the set of mainframe datasets and their attributes associated with a mainframe dataset ruleset in bulk (bulkMainframeDatasetUpdate)
Path parameters
mainframeDatasetRulesetId (required)
Path Parameter — The ID of the mainframe dataset ruleset to update the mainframe dataset for format: int32
Request body
Body Parameter — The exact list of mainframe datasets to put in the ruleset. Note that existing datasets for this ruleset not in this list will be deleted
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/copy
Copy mainframe dataset ruleset by ID (copyMainframeDatasetRuleset)
Path parameters
mainframeDatasetRulesetId (required)
Path Parameter — The ID of the mainframe dataset ruleset to copy format: int32
Request body
Body Parameter — The name of the ruleset. This must be unique within an environment.
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetConnectorId" : 123,
"rulesetName" : "aeiou",
"mainframeDatasetRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MainframeDatasetRuleset
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mainframe-dataset-rulesets
Create Mainframe Dataset ruleset (createMainframeDatasetRuleset)
Request body
Body Parameter — The Mainframe Dataset ruleset to create
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetConnectorId" : 123,
"rulesetName" : "aeiou",
"mainframeDatasetRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetRuleset
Up
delete /mainframe-dataset-rulesets/{mainframeDatasetRulesetId}
Delete Mainframe Dataset ruleset by ID (deleteMainframeDatasetRuleset)
Path parameters
mainframeDatasetRulesetId (required)
Path Parameter — The ID of the Mainframe Dataset ruleset to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Invalid mainframeDatasetRulesetId supplied
404
MainframeDatasetRuleset not found
Up
get /mainframe-dataset-rulesets
Get all Mainframe Dataset rulesets (getAllMainframeDatasetRulesets)
Query parameters
environment_id (optional)
Query Parameter — The ID of the environment to get all Mainframe Dataset rulesets from format: int32
page_number (optional)
Query Parameter — The page number for which to get Mainframe Dataset rulesets. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"mainframeDatasetConnectorId" : 123,
"rulesetName" : "aeiou",
"mainframeDatasetRulesetId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
0
Successful operation
MainframeDatasetRulesetList
Up
get /mainframe-dataset-rulesets/{mainframeDatasetRulesetId}
Get Mainframe Dataset ruleset by ID (getMainframeDatasetRulesetById)
Path parameters
mainframeDatasetRulesetId (required)
Path Parameter — The ID of the Mainframe Dataset ruleset to get format: int32
Return type
Example data
Content-Type: application/json
{
"mainframeDatasetConnectorId" : 123,
"rulesetName" : "aeiou",
"mainframeDatasetRulesetId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
MainframeDatasetRuleset
400
Invalid mainframeDatasetRulesetId supplied
404
MainframeDatasetRuleset not found
Up
post /mapping-algorithms/{algorithmName}/add-mappings
Add mappings for mapping algorithm (addMappingAlgorithmMappings)
Path parameters
algorithmName (required)
Path Parameter — The name of the mapping algorithm.
Query parameters
fileReferenceId (required)
Query Parameter — The reference URI of the uploaded file to be installed. This file should have been uploaded via the /fileUpload endpoint.
passphrase (optional)
Query Parameter — The passphrase that an exported CSV mapping file was encrypted with. This is only needed if adding mappings that were previously exported.
mappingFileType (optional)
Query Parameter — The type of the file provided. If PLAINTEXT is chosen, the file is expected to contain newline delimited outputs. If CSV is chosen, the file is expected to conform to RFC4180. Additionally, 2 columns are expected - input and output. The first row of the CSV must be a header.
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
delete /mapping-algorithms/{algorithmName}/delete-mappings
Irreversibly delete all saved mappings for mapping algorithm. (deleteMappingAlgorithmMappings)
Path parameters
algorithmName (required)
Path Parameter — The name of the mapping algorithm.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mapping-algorithms/{algorithmName}/export-mappings
Export mappings for mapping algorithm (exportMappings)
Path parameters
algorithmName (required)
Path Parameter — The name of the mapping algorithm.
Query parameters
passphrase (required)
Query Parameter — The passphrase to use to encrypt the mappings in the export file.
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
Up
get /mapping-algorithms/{algorithmName}/stats
Get stats for mapping algorithm (getMappingAlgorithmStats)
Path parameters
algorithmName (required)
Path Parameter — The name of the mapping algorithm.
Return type
Example data
Content-Type: application/json
{
"totalMappings" : 123,
"unusedMappings" : 123,
"algorithmName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MappingAlgorithmStats
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mapping-algorithms/{algorithmName}/reset
Reset mappings for mapping algorithm. (resetMappingAlgorithm)
Path parameters
algorithmName (required)
Path Parameter — The name of the mapping algorithm.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Create masking job (createMaskingJob)
Request body
Body Parameter — The masking job to create
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"maskingJobId" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
MaskingJob
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /masking-jobs/{maskingJobId}
Delete masking job by ID (deleteMaskingJob)
Path parameters
maskingJobId (required)
Path Parameter — The ID of the masking job to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all masking jobs (getAllMaskingJobs)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get masking jobs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all masking jobs from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"maskingJobId" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MaskingJobList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /masking-jobs/{maskingJobId}
Get masking job by ID (getMaskingJobById)
Path parameters
maskingJobId (required)
Path Parameter — The ID of the masking job to get format: int32
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"maskingJobId" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MaskingJob
400
Bad request
401
Unauthorized access
404
Not found
Up
put /masking-jobs/{maskingJobId}
Update masking job by ID (updateMaskingJob)
Path parameters
maskingJobId (required)
Path Parameter — The ID of the masking job to update format: int32
Request body
Body Parameter — The updated masking job
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"maskingJobId" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MaskingJob
400
Bad request
401
Unauthorized access
404
Not found
Get status of Executions and async tasks (getAllTaskStatus)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get tasks for monitor. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
state (optional)
Query Parameter — The state of task to get the status. Default is to return running tasks default: RUNNING
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"taskType" : "aeiou",
"progression" : [ {
"event" : "aeiou",
"order" : 123,
"status" : "aeiou"
} ],
"taskId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MonitorTaskList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /monitor-task/{taskId}
Get status of Executions or async tasks by id (getTaskStatusByTypeAndId)
Path parameters
taskId (required)
Path Parameter — The ID of the monitorable task to get format: int32
Query parameters
monitorable_task (optional)
Query Parameter — The type of monitorable task to check progress default: EXECUTIONS
Return type
Example data
Content-Type: application/json
{
"taskType" : "aeiou",
"progression" : [ {
"event" : "aeiou",
"order" : 123,
"status" : "aeiou"
} ],
"taskId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MonitorTask
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mount-filesystem/{mountID}/connect
Connect filesystem mount (connectMountFilesystem)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to connect format: int32
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
Up
post /mount-filesystem
Create filesystem mount (createMountFilesystem)
Request body
Body Parameter — The filesystem to mount
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /mount-filesystem/{mountID}
Delete filesystem mount (deleteMountFilesystem)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mount-filesystem/{mountID}/disconnect
Disconnect filesystem mount (disconnectMountFilesystem)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to disconnect format: int32
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
Get all mounts (getAllMounts)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get mount information. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformationList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /mount-filesystem/{mountID}
Get mount by ID (getMountByID)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to get format: int32
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mount-filesystem/{mountID}/remount
Remount filesystem mount (remountMountFilesystem)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to update format: int32
Request body
Body Parameter — The updated filesystem
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
Up
put /mount-filesystem/{mountID}
Update filesystem mount (updateMountFilesystem)
Path parameters
mountID (required)
Path Parameter — The ID of the mount to update format: int32
Request body
Body Parameter — The updated filesystem
Return type
Example data
Content-Type: application/json
{
"mountId" : 123,
"mountPath" : "aeiou",
"connectOnStartup" : true,
"options" : "aeiou",
"hostAddress" : "aeiou",
"type" : "aeiou",
"mountName" : "aeiou",
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
MountInformation
400
Bad request
401
Unauthorized access
404
Not found
Up
get /non-conformant-data-sample
Get all non-conformant data samples (getAllNonConformantDataSamples)
Get redacted data samples associated with non-conforming data execution events.
Query parameters
execution_event_id (optional)
Query Parameter — The ID(s) of the execution event(s) for which to get all non-conformant data samples format: int64
page_number (optional)
Query Parameter — The page number for which to get non-conformant data samples. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"executionEventId" : 123456789,
"dataSampleId" : 123456789,
"count" : 123456789,
"dataSample" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
NonConformantDataSampleList
400
Bad request
401
Unauthorized access
404
Not found
Install plugin (createPlugin)
Install an uploaded plugin file onto the system
Query parameters
fileReferenceId (required)
Query Parameter — The file references ID of the uploaded plugin JAR file to install
pluginName (optional)
Query Parameter — Override the default name of the plugin. Plugin names must be unique across plugins of the same type on the engine.
pluginType (optional)
Query Parameter — The type of plugin to retrieve. default: EXTENDED_ALGORITHM
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Plugin
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /plugin/{pluginId}
Delete plugin (deletePlugin)
Delete an installed plugin.
Path parameters
pluginId (required)
Path Parameter — The ID of the plugin to delete format: int64
Query parameters
force (optional)
Query Parameter — Force deletion of all dependent usage associated with the plugin, such as inventory and domain assignments of algorithms default: false
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all plugins (getAllPlugins)
Get a detailed list of all installed plugins
Query parameters
page_number (optional)
Query Parameter — The page number for which to get algorithm plugins. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
pluginType (optional)
Query Parameter — The type of plugin to retrieve. default: EXTENDED_ALGORITHM
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
PluginList
400
Bad request
401
Unauthorized access
Up
get /plugin/{pluginId}
Get plugin detail by pluginId (getPlugin)
Get detailed information about an installed plugin by pluginId
Path parameters
pluginId (required)
Path Parameter — The ID of the plugin to get format: int64
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Plugin
400
Bad request
401
Unauthorized access
404
Not found
Up
put /plugin/{pluginId}
Update plugin (updatePlugin)
Update an installed plugin to use the uploaded JAR file. The new plugin must contain all components delivered by the previous version.
Path parameters
pluginId (required)
Path Parameter — The ID of the plugin to update format: int64
Query parameters
fileReferenceId (required)
Query Parameter — The file references ID of the new uploaded plugin JAR file
pluginName (optional)
Query Parameter — The name of the plugin
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Plugin
400
Bad request
401
Unauthorized access
404
Not found
Up
post /profile-expressions
Create profile expression (createProfileExpression)
Request body
Body Parameter — The profile expression to create
Return type
Example data
Content-Type: application/json
{
"dataLevelProfiling" : true,
"regularExpression" : "aeiou",
"createdBy" : "aeiou",
"expressionName" : "aeiou",
"domainName" : "aeiou",
"profileExpressionId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ProfileExpression
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /profile-expressions/{profileExpressionId}
Delete profile expression by ID (deleteProfileExpression)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile expression to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Up
get /profile-expressions
Get all profile expressions (getAllProfileExpressions)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get profile expressions. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"dataLevelProfiling" : true,
"regularExpression" : "aeiou",
"createdBy" : "aeiou",
"expressionName" : "aeiou",
"domainName" : "aeiou",
"profileExpressionId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileExpressionList
400
Bad request
401
Unauthorized access
Up
get /profile-expressions/{profileExpressionId}
Get profile expression by ID (getProfileExpressionById)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile expression to get format: int32
Return type
Example data
Content-Type: application/json
{
"dataLevelProfiling" : true,
"regularExpression" : "aeiou",
"createdBy" : "aeiou",
"expressionName" : "aeiou",
"domainName" : "aeiou",
"profileExpressionId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileExpression
401
Unauthorized access
404
Not found
Up
put /profile-expressions/{profileExpressionId}
Update profile expression by ID (updateProfileExpression)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile expression to update format: int32
Request body
Body Parameter — The updated profile expression
Return type
Example data
Content-Type: application/json
{
"dataLevelProfiling" : true,
"regularExpression" : "aeiou",
"createdBy" : "aeiou",
"expressionName" : "aeiou",
"domainName" : "aeiou",
"profileExpressionId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileExpression
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Create profile job (createProfileJob)
Request body
Body Parameter — The profile job to create
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"multiTenant" : true,
"multipleProfilerCheck" : true,
"profileJobId" : 123,
"feedbackSize" : 123,
"maxMemory" : 123,
"rulesetType" : "aeiou",
"createdBy" : "aeiou",
"numInputStreams" : 123,
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ProfileJob
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /profile-jobs/{profileJobId}
Delete profile job by ID (deleteProfileJob)
Path parameters
profileJobId (required)
Path Parameter — The ID of the profile job to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all profile jobs (getAllProfileJobs)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get profile jobs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all profile jobs from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"multiTenant" : true,
"multipleProfilerCheck" : true,
"profileJobId" : 123,
"feedbackSize" : 123,
"maxMemory" : 123,
"rulesetType" : "aeiou",
"createdBy" : "aeiou",
"numInputStreams" : 123,
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileJobList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /profile-jobs/{profileJobId}
Get profile job by ID (getProfileJobById)
Path parameters
profileJobId (required)
Path Parameter — The ID of the profile job to get format: int32
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"multiTenant" : true,
"multipleProfilerCheck" : true,
"profileJobId" : 123,
"feedbackSize" : 123,
"maxMemory" : 123,
"rulesetType" : "aeiou",
"createdBy" : "aeiou",
"numInputStreams" : 123,
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileJob
400
Bad request
401
Unauthorized access
404
Not found
Up
put /profile-jobs/{profileJobId}
Update profile job by ID (updateProfileJob)
Path parameters
profileJobId (required)
Path Parameter — The ID of the profile job to update format: int32
Request body
Body Parameter — The updated profile job
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"multiTenant" : true,
"multipleProfilerCheck" : true,
"profileJobId" : 123,
"feedbackSize" : 123,
"maxMemory" : 123,
"rulesetType" : "aeiou",
"createdBy" : "aeiou",
"numInputStreams" : 123,
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileJob
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Create profile set (createProfileSet)
Request body
Body Parameter — The profile set to create
Return type
Example data
Content-Type: application/json
{
"profileTypeExpressionIds" : [ 123 ],
"createdBy" : "aeiou",
"profileSetName" : "aeiou",
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"description" : "aeiou",
"profileExpressionIds" : [ 123 ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ProfileSet
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /profile-sets/{profileSetId}
Delete profile set by ID (deleteProfileSet)
Path parameters
profileSetId (required)
Path Parameter — The ID of the profile set to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Get all profile sets (getAllProfileSets)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get profile sets. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"profileTypeExpressionIds" : [ 123 ],
"createdBy" : "aeiou",
"profileSetName" : "aeiou",
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"description" : "aeiou",
"profileExpressionIds" : [ 123 ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileSetList
400
Bad request
401
Unauthorized access
Up
get /profile-sets/{profileSetId}
Get profile set by ID (getProfileSetById)
Path parameters
profileSetId (required)
Path Parameter — The ID of the profile set to get format: int32
Return type
Example data
Content-Type: application/json
{
"profileTypeExpressionIds" : [ 123 ],
"createdBy" : "aeiou",
"profileSetName" : "aeiou",
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"description" : "aeiou",
"profileExpressionIds" : [ 123 ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileSet
401
Unauthorized access
404
Not found
Up
put /profile-sets/{profileSetId}
Update profile set by ID (updateProfileSet)
Path parameters
profileSetId (required)
Path Parameter — The ID of the profile set to update format: int32
Request body
Body Parameter — The updated profile set
Return type
Example data
Content-Type: application/json
{
"profileTypeExpressionIds" : [ 123 ],
"createdBy" : "aeiou",
"profileSetName" : "aeiou",
"profileSetId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"description" : "aeiou",
"profileExpressionIds" : [ 123 ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileSet
400
Bad request
401
Unauthorized access
404
Not found
Up
post /profile-type-expressions
Create profile type expression (createProfileTypeExpression)
Request body
Body Parameter — The profile type expression to create
Return type
Example data
Content-Type: application/json
{
"minDataLength" : 123,
"createdBy" : "aeiou",
"domainName" : "aeiou",
"dataType" : "aeiou",
"profileExpressionId" : 123,
"typeExpressionName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ProfileTypeExpression
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /profile-type-expressions/{profileExpressionId}
Delete profile type expression by ID (deleteProfileTypeExpression)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile type expression to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Up
get /profile-type-expressions
Get all profile expressions (getAllProfileTypeExpressions)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get profile type expressions. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"minDataLength" : 123,
"createdBy" : "aeiou",
"domainName" : "aeiou",
"dataType" : "aeiou",
"profileExpressionId" : 123,
"typeExpressionName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileTypeExpressionList
400
Bad request
401
Unauthorized access
Up
get /profile-type-expressions/{profileExpressionId}
Get profile expression by ID (getProfileTypeExpressionById)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile type expression to get format: int32
Return type
Example data
Content-Type: application/json
{
"minDataLength" : 123,
"createdBy" : "aeiou",
"domainName" : "aeiou",
"dataType" : "aeiou",
"profileExpressionId" : 123,
"typeExpressionName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileTypeExpression
401
Unauthorized access
404
Not found
Up
put /profile-type-expressions/{profileExpressionId}
Update profile type expression by ID (updateProfileTypeExpression)
Path parameters
profileExpressionId (required)
Path Parameter — The ID of the profile type expression to update format: int32
Request body
Body Parameter — The updated profile type expression
Return type
Example data
Content-Type: application/json
{
"minDataLength" : 123,
"createdBy" : "aeiou",
"domainName" : "aeiou",
"dataType" : "aeiou",
"profileExpressionId" : 123,
"typeExpressionName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ProfileTypeExpression
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Create record type (createRecordType)
Request body
Body Parameter — The record type to create
Query parameters
file_reference_id (required)
Query Parameter — The reference URI of the uploaded file to be installed. This file should have been uploaded via the /fileUpload endpoint.
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"recordTypeId" : 123,
"recordTypeName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
RecordType
401
Unauthorized access
409
Conflict
Up
delete /record-types/{recordTypeId}
Delete record type by ID (deleteRecordType)
Path parameters
recordTypeId (required)
Path Parameter — The ID of the record type to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all record type (getAllRecordTypes)
Query parameters
file_format_id (optional)
Query Parameter — The ID of the file format whose record types to get. format: int32
page_number (optional)
Query Parameter — The page number for which to get record type. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"fileFormatId" : 123,
"recordTypeId" : 123,
"recordTypeName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordTypeList
401
Unauthorized access
Up
get /record-types/{recordTypeId}
Get record type by ID (getRecordTypeById)
Path parameters
recordTypeId (required)
Path Parameter — The ID of the record type to get format: int32
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"recordTypeId" : 123,
"recordTypeName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordType
400
Bad request
401
Unauthorized access
404
Not found
Up
put /record-types/{recordTypeId}
Update record type (updateRecordType)
Path parameters
recordTypeId (required)
Path Parameter — The ID of the record type format: int32
Request body
Body Parameter — The record type to update
Return type
Example data
Content-Type: application/json
{
"fileFormatId" : 123,
"recordTypeId" : 123,
"recordTypeName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordType
401
Unauthorized access
Up
post /record-type-qualifiers
Create record type qualifier (createRecordTypeQualifier)
Request body
Body Parameter — The record type qualifier to create
Return type
Example data
Content-Type: application/json
{
"recordTypeId" : 123,
"fileFieldMetadataId" : 123,
"pattern" : "aeiou",
"recordTypeQualifierId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
RecordTypeQualifier
401
Unauthorized access
409
Conflict
Up
delete /record-type-qualifiers/{recordTypeQualifierId}
Delete record type qualifier by ID (deleteRecordTypeQualifier)
Path parameters
recordTypeQualifierId (required)
Path Parameter — The ID of the record type qualifier to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /record-type-qualifiers
Get all record type qualifiers (getAllRecordTypeQualifiers)
Query parameters
record_type_id (optional)
Query Parameter — The ID of the record type whose record type qualifiers to get. format: int32
page_number (optional)
Query Parameter — The page number for which to get record type qualifiers. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"recordTypeId" : 123,
"fileFieldMetadataId" : 123,
"pattern" : "aeiou",
"recordTypeQualifierId" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordTypeQualifierList
401
Unauthorized access
Up
get /record-type-qualifiers/{recordTypeQualifierId}
Get record type qualifier by ID (getRecordTypeQualifierById)
Path parameters
recordTypeQualifierId (required)
Path Parameter — The ID of the record type qualifier to get format: int32
Return type
Example data
Content-Type: application/json
{
"recordTypeId" : 123,
"fileFieldMetadataId" : 123,
"pattern" : "aeiou",
"recordTypeQualifierId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordTypeQualifier
400
Bad request
401
Unauthorized access
404
Not found
Up
put /record-type-qualifiers/{recordTypeQualifierId}
Update record type qualifier by ID (updateRecordTypeQualifier)
Path parameters
recordTypeQualifierId (required)
Path Parameter — The ID of the record type qualifier to update format: int32
Request body
Body Parameter — The record type qualifier body to update
Return type
Example data
Content-Type: application/json
{
"recordTypeId" : 123,
"fileFieldMetadataId" : 123,
"pattern" : "aeiou",
"recordTypeQualifierId" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RecordTypeQualifier
400
Bad request
401
Unauthorized access
404
Not found
Up
post /reidentification-jobs
Create re-identification job (createReidentificationJob)
Request body
Body Parameter — The re-identification job to create
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"reidentificationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ReidentificationJob
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /reidentification-jobs/{reidentificationJobId}
Delete re-identification job by ID (deleteReidentificationJob)
Path parameters
reidentificationJobId (required)
Path Parameter — The ID of the re-identification job to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /reidentification-jobs
Get all re-identification jobs (getAllReidentificationJobs)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get re-identification jobs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all re-identification jobs from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"reidentificationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ReidentificationJobList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /reidentification-jobs/{reidentificationJobId}
Get re-identification job by ID (getReidentificationJobById)
Path parameters
reidentificationJobId (required)
Path Parameter — The ID of the re-identification job to get format: int32
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"reidentificationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ReidentificationJob
400
Bad request
401
Unauthorized access
404
Not found
Up
put /reidentification-jobs/{reidentificationJobId}
Update re-identification job by ID (updateReidentificationJob)
Path parameters
reidentificationJobId (required)
Path Parameter — The ID of the re-identification job to update format: int32
Request body
Body Parameter — The updated re-identification job
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"reidentificationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ReidentificationJob
400
Bad request
401
Unauthorized access
404
Not found
Create role (createRole)
Request body
Body Parameter — The role to create
Return type
Example data
Content-Type: application/json
{
"jdbcDriver" : "",
"roleId" : 123,
"maskingJob" : "",
"ruleset" : "",
"tokenizeJob" : "",
"inventory" : "",
"approveInventories" : "",
"environment" : {
"view" : true,
"import" : true,
"create" : true,
"update" : true,
"run" : true,
"copy" : true,
"delete" : true,
"export" : true
},
"profileJob" : "",
"connector" : "",
"plugin" : "",
"domain" : "",
"inventoryReport" : "",
"roleName" : "aeiou",
"diagnostic" : "",
"reidentifyJob" : "",
"user" : "",
"customAlgorithm" : "",
"fileFormat" : "",
"algorithm" : "",
"profileExpression" : "",
"profileSet" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
Role
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /roles/{roleId}
Delete role by ID (deleteRole)
Path parameters
roleId (required)
Path Parameter — The ID of the role to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Get all roles (getAllRoles)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get roles. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"jdbcDriver" : "",
"roleId" : 123,
"maskingJob" : "",
"ruleset" : "",
"tokenizeJob" : "",
"inventory" : "",
"approveInventories" : "",
"environment" : {
"view" : true,
"import" : true,
"create" : true,
"update" : true,
"run" : true,
"copy" : true,
"delete" : true,
"export" : true
},
"profileJob" : "",
"connector" : "",
"plugin" : "",
"domain" : "",
"inventoryReport" : "",
"roleName" : "aeiou",
"diagnostic" : "",
"reidentifyJob" : "",
"user" : "",
"customAlgorithm" : "",
"fileFormat" : "",
"algorithm" : "",
"profileExpression" : "",
"profileSet" : ""
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
RoleList
400
Bad request
401
Unauthorized access
Get role by ID (getRoleById)
Path parameters
roleId (required)
Path Parameter — The ID of the role to get format: int32
Return type
Example data
Content-Type: application/json
{
"jdbcDriver" : "",
"roleId" : 123,
"maskingJob" : "",
"ruleset" : "",
"tokenizeJob" : "",
"inventory" : "",
"approveInventories" : "",
"environment" : {
"view" : true,
"import" : true,
"create" : true,
"update" : true,
"run" : true,
"copy" : true,
"delete" : true,
"export" : true
},
"profileJob" : "",
"connector" : "",
"plugin" : "",
"domain" : "",
"inventoryReport" : "",
"roleName" : "aeiou",
"diagnostic" : "",
"reidentifyJob" : "",
"user" : "",
"customAlgorithm" : "",
"fileFormat" : "",
"algorithm" : "",
"profileExpression" : "",
"profileSet" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Role
401
Unauthorized access
404
Not found
Update role by ID (updateRole)
Path parameters
roleId (required)
Path Parameter — The ID of the role to update format: int32
Request body
Body Parameter — The updated role
Return type
Example data
Content-Type: application/json
{
"jdbcDriver" : "",
"roleId" : 123,
"maskingJob" : "",
"ruleset" : "",
"tokenizeJob" : "",
"inventory" : "",
"approveInventories" : "",
"environment" : {
"view" : true,
"import" : true,
"create" : true,
"update" : true,
"run" : true,
"copy" : true,
"delete" : true,
"export" : true
},
"profileJob" : "",
"connector" : "",
"plugin" : "",
"domain" : "",
"inventoryReport" : "",
"roleName" : "aeiou",
"diagnostic" : "",
"reidentifyJob" : "",
"user" : "",
"customAlgorithm" : "",
"fileFormat" : "",
"algorithm" : "",
"profileExpression" : "",
"profileSet" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Role
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Create SSH key (createSshKey)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
sshKey (required)
Form Parameter — The SSH key to be uploaded. The logical name of the SSH key will be exactly the name of this uploaded file
Return type
Example data
Content-Type: application/json
{
"sshKeyName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
SshKey
401
Unauthorized access
409
Conflict
Up
delete /ssh-keys/{sshKeyName}
Delete SSH key by name (deleteSshKey)
Path parameters
sshKeyName (required)
Path Parameter — The name of the SSH key to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
401
Unauthorized access
404
Not found
Get all SSH keys (getAllSshKeys)
Return type
Example data
Content-Type: application/json
[ {
"sshKeyName" : "aeiou"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
Up
get /oauth2/is-oauth2-ready
Check to see if the engine is ready to enable OAuth2. (isOAuth2Ready)
Return type
Example data
Content-Type: application/json
{
"isOAuth2ReadyWithNameMatching" : true,
"isOAuth2ReadyWithEmailAddressMatching" : true,
"isOAuth2ReadyWithPrincipalMatching" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
OAuth2Ready
Check to see if the engine is ready to enable SSO. (isSsoReady)
Return type
Example data
Content-Type: application/json
{
"isSsoReady" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
SsoReady
Export masking object (asyncExport)
Export masking objects
Request body
Body Parameter — The identifier for the masking object to export
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Import masking objects (asyncImportObject)
WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
force_overwrite (required)
Query Parameter — Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.
environment_id (optional)
Query Parameter — The ID of the environment to import objects into format: int32
source_environment_id (optional)
Query Parameter — The ID of the source environment to import on-the-fly connectors into format: int32
Form parameters
file (required)
Form Parameter — The identifier for the masking object to import
Return type
Example data
Content-Type: application/json
{
"asyncTaskId" : 123,
"reference" : "aeiou",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"operation" : "aeiou",
"cancellable" : true,
"status" : "aeiou",
"exceptionDetail" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
AsyncTask
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Export masking object (export)
Export masking objects
Request body
Body Parameter — The identifier for the masking object to export
Return type
Example data
Content-Type: application/json
{
"blob" : "aeiou",
"signature" : "aeiou",
"exportResponseMetadata" : "{}",
"publicKey" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
ExportObject
400
Bad request
401
Unauthorized access
404
Not found
Get all syncable objects (getAllSyncableObjects)
Get all syncable objects
Query parameters
page_number (optional)
Query Parameter — The page number for which to get syncable objects. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
object_type (optional)
Query Parameter — The type of syncable object to filter for
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"revisionHash" : "aeiou",
"objectIdentifier" : "{}",
"objectType" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExportObjectMetadataList
400
Bad request
401
Unauthorized access
Up
get /syncable-objects/environments/{environmentId}
Get syncable object for environment (getSyncableObjectByEnvironmentId)
Get syncable object for environment
Path parameters
environmentId (required)
Path Parameter — The ID of the environment to retrieve syncable object of format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"revisionHash" : "aeiou",
"objectIdentifier" : "{}",
"objectType" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
ExportObjectMetadataList
400
Bad request
401
Unauthorized access
Import masking objects (importObject)
Import masking objects
Request body
Body Parameter — The identifier for the masking object to import
Query parameters
force_overwrite (required)
Query Parameter — Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.
environment_id (optional)
Query Parameter — The ID of the environment to import objects into format: int32
source_environment_id (optional)
Query Parameter — The ID of the source environment to import on-the-fly connectors into format: int32
Return type
Example data
Content-Type: application/json
[ {
"importedObjectIdentifier" : "{}",
"importStatus" : "aeiou",
"objectIdentifier" : "{}",
"failureMessage" : "aeiou",
"objectType" : "aeiou"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
400
Bad request
401
Unauthorized access
404
Not found
Delete all export documents from /async-export tasks (purgeExportDirectory)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
Delete all import documents from /async-import tasks (purgeImportDirectory)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
Up
get /system-information
Get system information (getSystemInformation)
Return type
Example data
Content-Type: application/json
{
"totalAllocatedMemoryForJobs" : 1.3579000000000001069366817318950779736042022705078125,
"totalPermFileSpace" : 1.3579000000000001069366817318950779736042022705078125,
"totalTempFileSpace" : 1.3579000000000001069366817318950779736042022705078125,
"build" : "aeiou",
"patentNumbers" : [ "aeiou" ],
"version" : "aeiou",
"totalAvailableCores" : 123,
"latestApiVersion" : "aeiou",
"latestGlobalKeyResetTime" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
SystemInformation
Create table metadata (createTableMetadata)
Request body
Body Parameter — The table metadata to create
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"whereClause" : "aeiou",
"havingClause" : "aeiou",
"customSql" : "aeiou",
"keyColumn" : "aeiou",
"isMasked" : true,
"tableMetadataId" : 123,
"tableName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
TableMetadata
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /table-metadata/{tableMetadataId}
Delete table metadata by ID (deleteTableMetadata)
Path parameters
tableMetadataId (required)
Path Parameter — The ID of the table metadata to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /table-metadata/{tableMetadataId}/generateCustomSQL
Generate customSQL for table (generateCustomSQL)
Path parameters
tableMetadataId (required)
Path Parameter — The ID of the table for which customSQL has to be generated format: int32
Return type
Example data
Content-Type: application/json
{
"customSql" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TableMetadataCustomSQL
400
Bad request
401
Unauthorized access
404
Not found
Get all table metadata (getAllTableMetadata)
Query parameters
ruleset_id (optional)
Query Parameter — The ID of the ruleset to get all table metadata from format: int32
page_number (optional)
Query Parameter — The page number for which to get table metadata. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
is_masked (optional)
Query Parameter — Get only masked table metadata when this is true, only unmasked column metadata when this is false and leaving this blank will get all tables
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"rulesetId" : 123,
"whereClause" : "aeiou",
"havingClause" : "aeiou",
"customSql" : "aeiou",
"keyColumn" : "aeiou",
"isMasked" : true,
"tableMetadataId" : 123,
"tableName" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TableMetadataList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /table-metadata/{tableMetadataId}
Get table metadata by ID (getTableMetadataById)
Path parameters
tableMetadataId (required)
Path Parameter — The ID of the table metadata to get format: int32
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"whereClause" : "aeiou",
"havingClause" : "aeiou",
"customSql" : "aeiou",
"keyColumn" : "aeiou",
"isMasked" : true,
"tableMetadataId" : 123,
"tableName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TableMetadata
400
Bad request
404
Not found
Up
put /table-metadata/{tableMetadataId}
Update table metadata by ID (updateTableMetadata)
Path parameters
tableMetadataId (required)
Path Parameter — The ID of the table metadata to update format: int32
Request body
Body Parameter — The updated table metadata
Return type
Example data
Content-Type: application/json
{
"rulesetId" : 123,
"whereClause" : "aeiou",
"havingClause" : "aeiou",
"customSql" : "aeiou",
"keyColumn" : "aeiou",
"isMasked" : true,
"tableMetadataId" : 123,
"tableName" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TableMetadata
400
Bad request
401
Unauthorized access
404
Not found
Up
post /tokenization-jobs
Create tokenization job (createTokenizationJob)
Request body
Body Parameter — The tokenization job to create
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"tokenizationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
TokenizationJob
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /tokenization-jobs/{tokenizationJobId}
Delete tokenization job by ID (deleteTokenizationJob)
Path parameters
tokenizationJobId (required)
Path Parameter — The ID of the tokenization job to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
get /tokenization-jobs
Get all tokenization jobs (getAllTokenizationJobs)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get tokenization jobs. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
environment_id (optional)
Query Parameter — The ID of the environment to get all tokenization jobs from format: int32
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"tokenizationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TokenizationJobList
400
Bad request
401
Unauthorized access
404
Not found
Up
get /tokenization-jobs/{tokenizationJobId}
Get tokenization job by ID (getTokenizationJobById)
Path parameters
tokenizationJobId (required)
Path Parameter — The ID of the tokenization job to get format: int32
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"tokenizationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TokenizationJob
400
Bad request
401
Unauthorized access
404
Not found
Up
put /tokenization-jobs/{tokenizationJobId}
Update tokenization job by ID (updateTokenizationJob)
Path parameters
tokenizationJobId (required)
Path Parameter — The ID of the tokenization job to update format: int32
Request body
Body Parameter — The updated tokenization job
Return type
Example data
Content-Type: application/json
{
"jobName" : "aeiou",
"rulesetId" : 123,
"minMemory" : 123,
"databaseMaskingOptions" : {
"disableTriggers" : true,
"numOutputThreadsPerStream" : 123,
"disableConstraints" : true,
"postscript" : "",
"batchUpdate" : true,
"dropIndexes" : true,
"truncateTables" : true,
"commitSize" : 123,
"prescript" : {
"contents" : "aeiou",
"name" : "aeiou"
}
},
"multiTenant" : true,
"failImmediately" : true,
"feedbackSize" : 123,
"enabledTasks" : [ {
"taskId" : 123
} ],
"maxMemory" : 123,
"rulesetType" : "aeiou",
"streamRowLimit" : 123,
"createdBy" : "aeiou",
"numInputStreams" : 123,
"onTheFlyMaskingSource" : {
"connectorType" : "aeiou",
"connectorId" : 123
},
"onTheFlyMasking" : true,
"tokenizationJobId" : 123,
"createdTime" : "2000-01-23T04:56:07.000+00:00",
"jobDescription" : "aeiou",
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
TokenizationJob
400
Bad request
401
Unauthorized access
404
Not found
Create user (createUser)
Request body
Body Parameter — The user to create
Return type
Example data
Content-Type: application/json
{
"disableReason" : "aeiou",
"lastName" : "aeiou",
"userStatus" : "aeiou",
"showWelcome" : true,
"isAdmin" : true,
"userName" : "aeiou",
"userId" : 123,
"principal" : "aeiou",
"firstName" : "aeiou",
"password" : "aeiou",
"nonAdminProperties" : {
"roleId" : 123,
"environmentIds" : [ 123 ]
},
"apiAccess" : true,
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Success
User
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
Up
delete /users/{userId}
Delete user by ID (deleteUserById)
Path parameters
userId (required)
Path Parameter — The ID of the user to delete format: int32
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Bad request
401
Unauthorized access
404
Not found
Up
post /users/forgot-password
Send Reset password mail to the user (forgottenPasswordRequest)
Request body
Body Parameter — The username for which password has to be reset
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Password reset email sent!
400
Bad request
Get all users (getAllUsers)
Query parameters
page_number (optional)
Query Parameter — The page number for which to get users. This will default to the first page if excluded default: 1 format: int64
page_size (optional)
Query Parameter — The maximum number of objects to return. This will default to the DEFAULT_API_PAGE_SIZE property if not provided format: int64
Return type
Example data
Content-Type: application/json
{
"_pageInfo" : {
"total" : 123456789,
"numberOnPage" : 123456789
},
"responseList" : [ {
"disableReason" : "aeiou",
"lastName" : "aeiou",
"userStatus" : "aeiou",
"showWelcome" : true,
"isAdmin" : true,
"userName" : "aeiou",
"userId" : 123,
"principal" : "aeiou",
"firstName" : "aeiou",
"password" : "aeiou",
"nonAdminProperties" : {
"roleId" : 123,
"environmentIds" : [ 123 ]
},
"apiAccess" : true,
"email" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
UserList
400
Bad request
401
Unauthorized access
Get user by ID (getUserById)
Path parameters
userId (required)
Path Parameter — The ID of the user to get format: int32
Return type
Example data
Content-Type: application/json
{
"disableReason" : "aeiou",
"lastName" : "aeiou",
"userStatus" : "aeiou",
"showWelcome" : true,
"isAdmin" : true,
"userName" : "aeiou",
"userId" : 123,
"principal" : "aeiou",
"firstName" : "aeiou",
"password" : "aeiou",
"nonAdminProperties" : {
"roleId" : 123,
"environmentIds" : [ 123 ]
},
"apiAccess" : true,
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
User
401
Unauthorized access
404
Not found
Up
post /users/reset-password
Reset new password for the user (resetPasswordRequest)
Request body
Body Parameter — Reset password for user using token received on e-mail
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Password successfully updated!
400
Bad request
Update user by ID (updateUserById)
Path parameters
userId (required)
Path Parameter — The ID of the user to update format: int32
Request body
Body Parameter — The updated user
Return type
Example data
Content-Type: application/json
{
"disableReason" : "aeiou",
"lastName" : "aeiou",
"userStatus" : "aeiou",
"showWelcome" : true,
"isAdmin" : true,
"userName" : "aeiou",
"userId" : 123,
"principal" : "aeiou",
"firstName" : "aeiou",
"password" : "aeiou",
"nonAdminProperties" : {
"roleId" : 123,
"environmentIds" : [ 123 ]
},
"apiAccess" : true,
"email" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
User
400
Bad request
401
Unauthorized access
404
Not found
409
Conflict
[ Jump to Methods ]
Table of Contents
AlgorithmAlgorithmAssignmentDetailAlgorithmExtensionAlgorithmFieldAlgorithmFrameworkAlgorithmFrameworkListAlgorithmIdentifierAlgorithmListAlgorithmMigrationAlgorithmMigrationListAlgorithmUsageReportAlgorithmValidationApplicationApplicationListApplicationSettingsApplicationSettingsListAsyncTaskAsyncTaskListAuditLogAuditLogListBinaryLookupExtensionColumnMetadataColumnMetadataListConnectionInfoConnectionPropertiesConnectionPropertiesListDataCleansingExtensionDatabaseConnectorDatabaseConnectorListDatabaseMaskingOptionsDatabaseRulesetDatabaseRulesetCopyDatabaseRulesetListDomainDomainListEnvironmentEnvironmentListErrorMessageExecutionExecutionComponentExecutionComponentListExecutionComponentLogExecutionComponentLogByComponentIdExecutionComponentLogsListExecutionEventExecutionEventListExecutionListExecutionLogExecutionLogByIdExecutionLogsListExportObjectExportObjectMetadataExportObjectMetadataListExportResponseMetadataFileConnectorFileConnectorListFileFieldMetadataFileFieldMetadataListFileFormatFileFormatListFileMetadataFileMetadataBulkInputFileMetadataListFileRulesetFileRulesetCopyFileRulesetListFileUploadFileUploadListForgotPasswordFreeTextRedactionExtensionImportObjectMetadataInstallationIntegerIdentifierJdbcDriverJdbcDriversListJobTaskKeyIdentifierKnowledgeBaseInfoKnowledgeBaseInfoListLogFileInfoLogFileInfoListLogStatementLoginLoginResponseMainframeDatasetConnectorMainframeDatasetConnectorListMainframeDatasetFieldMetadataMainframeDatasetFieldMetadataListMainframeDatasetFormatMainframeDatasetFormatListMainframeDatasetMetadataMainframeDatasetMetadataBulkInputMainframeDatasetMetadataListMainframeDatasetRecordTypeMainframeDatasetRecordTypeListMainframeDatasetRulesetMainframeDatasetRulesetCopyMainframeDatasetRulesetListMappingAlgorithmStatsMappingExtensionMappletExtensionMaskingJobMaskingJobListMaskingJobScriptMinMaxExtensionMonitorTaskMonitorTaskListMountInformationMountInformationListNonAdminPropertiesNonConformantDataSampleNonConformantDataSampleListNonConformantDataSamplesOAuth2ReadyObjectIdentifierOnTheFlyMaskingSourcePageInfoPluginPluginBasePluginListPluginObjectPrivilegeProfileExpressionProfileExpressionListProfileJobProfileJobListProfileSetProfileSetListProfileTypeExpressionProfileTypeExpressionListRecordTypeRecordTypeListRecordTypeQualifierRecordTypeQualifierListReidentificationJobReidentificationJobListResetPasswordRoleRoleListSecureLookupExtensionSegmentMappingExtensionSegmentMappingPreservedRangeSegmentMappingSegmentSshKeySsoReadyStringIdentifierSystemInformationTableMetadataTableMetadataBulkInputTableMetadataCustomSQLTableMetadataListTaskEventsTestConnectorResponseTokenizationExtensionTokenizationJobTokenizationJobListUserUserList
algorithmName
String Equivalent to the algorithm name saved by the user through the GUI. For out of the box algorithms, this will be a similar name as that in the GUI, but presented in a more user-friendly format.
algorithmType
BINARY_LOOKUP
CLEANSING
COMPONENT
CUSTOM_ALGORITHM
DATE
LOOKUP
MAPPING
MINMAX
MISC
REDACTION
SEGMENT
TOKENIZATION
createdBy (optional)
String The name of the user that created the algorithm
description (optional)
String The description of the algorithm
isTokenizationSupported (optional)
Boolean Whether or not the algorithm can be used with tokenization and reidentification job
frameworkId (optional)
Long The algorithm framework id format: int64
pluginId (optional)
Long The id, if applicable, of the plugin that supplies this algorithm or the framework this algorithm is built on format: int64
fields (optional)
algorithmExtension (optional)
assignmentType
String The type of algorithm usage.
DATABASE_COLUMN
FILE_FIELD
MAINFRAME_DATASET_FIELD
environmentName (optional)
String The environment where the algorithm usage occurs, if any. For file and dataset usage, this will return only one of potentially many environments where the file format referencing the algorithm is applied.
databaseRulesetName (optional)
String The database ruleset where the algorithm usage occurs, if applicable.
databaseTableName (optional)
String The database table where the algorithm usage occurs, if applicable.
databaseColumnName (optional)
String The database column where the algorithm usage occurs, if applicable.
fileRulesetName (optional)
String The name of the file ruleset where the algorithm usage occurs, if applicable.
fileName (optional)
String The name of the file where the algorithm usage occurs, if applicable.
fileFormatName (optional)
String The name of the file format where the algorithm usage occurs, if applicable.
fileRecordTypeName (optional)
String The name of the file record type where the algorithm usage occurs, if applicable.
fileFieldName (optional)
String The name of the file field where the algorithm usage occurs, if applicable
mainframeDatasetRulesetName (optional)
String The name of the mainframe dataset ruleset where the algorithm usage occurs, if applicable.
mainframeDatasetFileName (optional)
String The name of the mainframe dataset file where the algorithm usage occurs, if applicable.
mainframeDatasetFormatName (optional)
String The name of the mainframe dataset format where the algorithm usage occurs, if applicable.
mainframeDatasetRecordTypeName (optional)
String The name of the mainframe dataset record type where the algorithm usage occurs, if applicable.
mainframeDatasetFieldName (optional)
String The name of t(he mainframe dataset field where the algorithm usage occurs, if applicable.
fieldId (optional)
Long The id of the algorithm field. format: int64
name (optional)
String The name of the algorithm field.
type (optional)
String The type of value this algorithm field.
BIG_DECIMAL
LOCAL_DATE_TIME
STRING
BYTE_BUFFER
isReadOnly (optional)
Boolean Indicates whether the field is read-only. Read-only fields are taken as input by the masking algorithm but not masked.
isOptional (optional)
Boolean Indicates whether the field is optional. Optional fields do not have to be assigned to a real data field or column in order for a masking assignment to be considered valid.
description (optional)
String The description of the algorithm field.
frameworkId (optional)
Long The id of the algorithm framework installed using Plugin API. format: int64
frameworkName (optional)
String The name of the algorithm framework installed using Plugin API.
frameworkType (optional)
String The type of value this algorithm framework masks.
BIG_DECIMAL
LOCAL_DATE_TIME
STRING
BYTE_BUFFER
GENERIC_DATA_ROW
ADVANCED_OBJECT
description (optional)
String The description of the algorithm framework
plugin (optional)
fields (optional)
extensionSchema (optional)
Object The JSON schema of algorithmExtension used by this framework
_pageInfo (optional)
responseList (optional)
_pageInfo (optional)
responseList (optional)
algorithmName
String The name of the algorithm that supports migration
frameworkId
Long The frameworkId of the framework to which this algorithm can be migrated format: int64
availableMigrations (optional)
algorithmName
String The name of the algorithm to which this usage report applies.
algorithmMaskingType (optional)
String The type of value this algorithm masks. This value is only available for algorithms based on the Algorithm Extensibility Framework.
BIG_DECIMAL
LOCAL_DATE_TIME
STRING
BYTE_BUFFER
GENERIC_DATA_ROW
ADVANCED_OBJECT
columnMetadataIds (optional)
array[Long] A list of the IDs of all columnMetadata objects that reference the algorithm. format: int64
fileFieldMetadataIds (optional)
array[Long] A list of the IDs of all fileFieldMetadata objects that reference the algorithm. format: int64
mainframeDatasetFieldMetadataIds (optional)
array[Long] A list of the IDs of all mainframeDatasetFieldMetadata objects that reference the algorithm. format: int64
environmentIds (optional)
array[Long] A list of the IDs of all environments where the algorithm is used. format: int64
rulesetIds (optional)
array[Long] A list of the IDs of all rulesets where the algorithm is used. format: int64
domainNames (optional)
array[String] A list of the names of all domains that reference the algorithm.
algorithmReferences (optional)
array[String] A list of the names of all other algorithms contain references to this algorithm.
assignmentDetails (optional)
validationSucceeded
Boolean Whether or not the validation was successful
message
String The message providing more details about the validation
applicationId (optional)
Integer The ID of the application. This will be generated by the Masking Engine. format: int32
applicationName
String The name of this Application. Note that it must be unique.
_pageInfo (optional)
responseList (optional)
settingId (optional)
Integer The ID of the application setting format: int32
settingGroup (optional)
String Application setting group
settingName (optional)
String Application setting available per group
settingValue
String Value for an application setting
_pageInfo (optional)
responseList (optional)
asyncTaskId (optional)
Integer The ID of the AsyncTask. This field will be generated by the Masking Engine. format: int32
operation (optional)
String The type of operation that the AsyncTask is performing.
ADD_MAPPINGS
ALGORITHM_CREATE
ALGORITHM_MIGRATE
ALGORITHM_UPDATE
DATAFILE_BULK_UPDATE
ENCRYPTION_KEY_CREATE
EXPORT
EXPORT_MAPPINGS
EXPORT_SL_VALUES
IMPORT
RULESET_REFRESH
TABLE_BULK_UPDATE
MAINFRAME_DATASET_BULK_UPDATE
reference (optional)
String The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.
status (optional)
String The status of the AsyncTask in regard to its completion.
CANCELLED
FAILED
RUNNING
SUCCEEDED
WAITING
startTime (optional)
Date The date and time that this AsyncTask was started. format: date-time
endTime (optional)
Date The date and time that this AsyncTask completed. format: date-time
cancellable (optional)
Boolean True if the AsyncTask can be cancelled, false otherwise.
exceptionDetail (optional)
String The details associated with the Java exception that caused this async task to fail, if applicable.
_pageInfo (optional)
responseList (optional)
auditId (optional)
Integer The ID of the Audit Log. This field will be generated by the Masking Engine. format: int32
userName (optional)
String The name for the user that took the action for this entry.
activityDescription (optional)
String A description of the action that occurred for this Audit Log entry. This will usually include the user friendly names of the involved objects.
activityTime (optional)
Date The date and time that the action for this Audit Log entry occurred. format: date-time
actionType (optional)
String The type of action that occurred for this Audit Log entry.
CANCEL
CREATE
CONNECT
DELETE
DISCONNECT
EDIT
EXPORT
FORGOT_PASSWORD
GET
GET_ALL
IMPORT
LOCK
DISABLE
LOGIN
LOGOUT
RESET_PASSWORD
RUN
TEST
UNLOCK
target (optional)
String The type object or operation that the action occurred on for this Audit Log entry.
ALGORITHM
ANALYTIC
APPLICATION
APPLICATION_LOG
APPLICATION_SETTING
ASYNC_TASK
AUDIT_LOG
COLUMN_METADATA
DATABASE_CONNECTOR
DATABASE_RULESET
DEBUG_BREAKPOINT
DOMAIN
ENCRYPTION_KEY
ENVIRONMENT
EXECUTION
EXECUTION_COMPONENT_LOG
EXECUTION_EVENT
EXECUTION_LOG
FILE_CONNECTOR
FILE_DOWNLOAD
FILE_FIELD_METADATA
FILE_FORMAT
FILE_METADATA
FILE_RULESET
FILE_UPLOAD
INSTALLATION
JDBC_DRIVER
JOB_TASK
KNOWLEDGE_BASE_INFO
LDAP
MAINFRAME_DATASET_CONNECTOR
MAINFRAME_DATASET_FIELD_METADATA
MAINFRAME_DATASET_FORMAT
MAINFRAME_DATASET_METADATA
MAINFRAME_DATASET_RECORD_TYPE
MAINFRAME_DATASET_RULESET
MASKING_JOB
MONITOR_TASK
MOUNT_FILESYSTEM
NON_CONFORMING_DATA_SAMPLE
OAUTH2
PLUGIN
PROFILE_EXPRESSION
PROFILE_TYPE_EXPRESSION
PROFILE_JOB
PROFILE_SET
RECORD_TYPE
RECORD_TYPE_QUALIFIER
REIDENTIFICATION_JOB
ROLE
SSH_KEY
SSO
SYNCABLE_OBJECT
SYSTEM_INFORMATION
TABLE_METADATA
TASK
TOKENIZATION_JOB
UNIFIED_AUTH
USER
status (optional)
String The status of the action that occurred for this Audit Log entry. This can change over time as ATTEMPTED actions are completed.
ATTEMPTED
FAILED
SUCCEEDED
ipAddress (optional)
String The IP address of the user who performed the action for this Audit Log entry.
_pageInfo (optional)
responseList (optional)
fileReferenceIds (optional)
array[String] A list of file reference URI values returned from the endpoint for uploading files to the Masking Engine.
latestKeyResetTime (optional)
Date The last time the algorithm's key was randomized. This changes the masked results of the algorithm. format: date-time
uuid (optional)
String The ID of the BreakpointInstance. This field will be generated by the Masking Engine.
breakpointType (optional)
String The breakpoint type for which to get breakpoints.
EXECUTION_MASK_END
EXECUTION_MASK_PRE_KETTLE
EXECUTION_PROFILE_COLUMN_PRE
EXECUTION_PROFILE_DATA_PRE_KETTLE
EXECUTION_PROFILE_END
PROGRESS_REPORTER_POST_UPDATE
PROGRESS_REPORTER_REMOVE_POST_LOCK
PROGRESS_REPORTER_REMOVE_PRE_LOCK
PROGRESS_REPORTER_UPDATE_POST_LOCK
PROGRESS_REPORTER_UPDATE_PRE_LOCK
RULESET_BULK_UPDATE_POST_TABLE_SAVE
RULESET_BULK_UPDATE_POST_TABLE_UPDATE
RULESET_BULK_UPDATE_START
reference (optional)
String The reference for the BreakpointInstance. An example of a reference is the async task ID for a RULESET_REFRESH operation.
timeout (optional)
Long The number of seconds to wait at the breakpoint before timing out. format: int64
remainingSkipCount (optional)
Integer The number of times to pass this breakpoint before waiting on it. format: int32
breakpointType (optional)
String The breakpoint type that identifies this breakpoint start data.
EXECUTION_MASK_END
EXECUTION_MASK_PRE_KETTLE
EXECUTION_PROFILE_COLUMN_PRE
EXECUTION_PROFILE_DATA_PRE_KETTLE
EXECUTION_PROFILE_END
PROGRESS_REPORTER_POST_UPDATE
PROGRESS_REPORTER_REMOVE_POST_LOCK
PROGRESS_REPORTER_REMOVE_PRE_LOCK
PROGRESS_REPORTER_UPDATE_POST_LOCK
PROGRESS_REPORTER_UPDATE_PRE_LOCK
RULESET_BULK_UPDATE_POST_TABLE_SAVE
RULESET_BULK_UPDATE_POST_TABLE_UPDATE
RULESET_BULK_UPDATE_START
enabled (optional)
Boolean True if the breakpoint is enabled, false otherwise.
timeout (optional)
Long The number of seconds to wait at the breakpoint before timing out. format: int64
initialSkipCount (optional)
Integer The number of times to pass this breakpoint before waiting on it. format: int32
timeout
Long The time, in seconds, to wait for the task before timing out. format: int64
columnMetadataId (optional)
Long The ID number of the column metadata. This field is auto-generated by the Masking Engine. format: int64
columnName (optional)
String The name of the column, as determined by the underlying table.
tableMetadataId (optional)
Integer The ID number of the table metadata that this column is a part of. This field is auto-generated by the Masking Engine. format: int32
algorithmName (optional)
String The name of the algorithm assigned to this column. Columns that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.
algorithmFieldId (optional)
Long The ID number of the algorithm field that is associated with this column. format: int64
algorithmGroupNo (optional)
Long The group number of algorithm to identify a set of columns associated with one instance of algorithm. format: int64
domainName (optional)
String The name of the domain assigned to this column. Columns that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.
dataType (optional)
String The data type of this column.
dateFormat (optional)
String The date format of the date assigned to this column.
columnLength (optional)
Integer The length of the column, in number of characters, as determined by the underlying table. format: int32
isMasked (optional)
Boolean This field indicates whether or not a column is being masked. This field is assigned by the Masking Engine to true or false based on whether the column is assigned an algorithm and domain.
isProfilerWritable
Boolean This field indicates whether or not a column's fields (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.
isPrimaryKey (optional)
Boolean This field indicates whether or not a column is a primary key. This field is determined by the Masking Engine.
isIndex (optional)
Boolean This field indicates whether or not a column is an index. This field is determined by the Masking Engine.
isForeignKey (optional)
Boolean This field indicates whether or not a column is a foreign key. This field is determined by the Masking Engine.
notes (optional)
String This field is used to store additional information about the column.
_pageInfo (optional)
responseList (optional)
connectionMode
String This field denotes which connection mode the connector will use to connect to the underlying files.
FTP
MOUNT
SFTP
path (optional)
String This field applies to all connection modes, and it is the file system path to the desired files.
mountId (optional)
Integer This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files. format: int32
host (optional)
String This field is the host address belonging to the FTP/SFTP server.
loginName (optional)
String This field is the login name to be used to authenticate with the FTP/SFTP server.
password (optional)
String This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.
port (optional)
Integer This field is the port number on the host address that the FTP/SFTP server is listening to. format: int32
sshKey (optional)
String This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.
userDirIsRoot (optional)
Boolean This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.
name (optional)
String The name of the property.
value (optional)
String The value of the property.
description (optional)
String The description of the property.
edited (optional)
Boolean Whether this property was set through a connection properties file.
_pageInfo (optional)
responseList (optional)
fileReferenceId (optional)
String The reference URI value returned from the endpoint for uploading files to the Masking Engine. The file should contain a newline separated list of {value, replacement} pairs separated by the delimiter. No extraneous whitespace should be present.
delimiter (optional)
String The delimiter string used to separate {value, replacement} pairs in the uploaded file
databaseConnectorId (optional)
Integer The ID number of the connector. This field is auto-generated by the Masking Engine. format: int32
connectorName
String The name of the connector.
databaseType
String The type of database the connector will connect to.
AURORA_POSTGRES
DB2
DB2_ISERIES
DB2_MAINFRAME
EXTENDED
GENERIC
MARIADB
MSSQL
MYSQL
ORACLE
POSTGRES
RDS_POSTGRES
SYBASE
environmentId
Integer The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed. format: int32
customDriverName (optional)
String The name of the custom driver to use. Only used for database type 'GENERIC'.
databaseName (optional)
String The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.
host (optional)
String The host name or IP address where the database is located.
instanceName (optional)
String The name of the database instance. Only used for database type 'MSSQL'.
jdbc (optional)
String The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.
password (optional)
String The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.
port (optional)
Integer The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.
schemaName (optional)
String The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.
sid (optional)
String The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.
username (optional)
String The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.
kerberosAuth (optional)
Boolean Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance
servicePrincipal (optional)
String The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.
jdbcDriverId (optional)
Integer The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors. format: int32
enableLogger (optional)
Boolean Whether to enable the logger. This is exclusively used for extended connectors.
fileReferenceId (optional)
String The reference to the uploaded connection property file.
_pageInfo (optional)
responseList (optional)
batchUpdate (optional)
Boolean This field determines whether the database load phase to output the masked data will be performed in batches. The size of the batches is determined by the field 'commitSize'. This option is recommended because it typically improves the performance of the masking job.
commitSize (optional)
Integer This field corresponds to the size of the database commits when performing batch updates. format: int32
disableConstraints (optional)
Boolean This field determines whether the database constraints on the tables to-be-masked will be temporarily disabled/dropped prior to when the masking phase starts, and then reenabled/recreated after the masking phase finishes. Due to the large amount of data mutation that is inherent to the masking phase, this option can improve performance by preventing the need to constantly reevaluate constraints while performing the data masking. Further, this option is often necessary for masking columns that are part of foreign key constraints because those constraints can be temporarily violated during the masking phase.
dropIndexes (optional)
Boolean This field determines whether the database indexes on the tables to-be-masked will be temporarily disabled/dropped prior to when the masking phase starts, and then reenabled/recreated after the masking phase finishes. Due to the large amount of data mutation that is inherent to the masking phase, this option can improve performance by preventing the need to constantly re-index the tables while performing the data masking.
disableTriggers (optional)
Boolean This field determines whether the database triggers on the tables to-be-masked will be temporarily disabled/dropped prior to when the masking phase starts, and then reenabled/recreated after the masking phase finishes. Due to the large amount of data mutation that is inherent to the masking phase, this option can improve performance by preventing the constant execution of triggers while performing the data masking.
numOutputThreadsPerStream (optional)
Integer This field controls the amount of parallelism, per input stream, that the masking job uses to load back the masked data. For instance, specifying 4 output threads per stream with 5 input streams results in a total of 20 output threads for the whole job. The higher the value of this field, the more potential parallelism there will be in the job, but the masking job will consume more memory. WARNING: when masking a database and specifying more than 1 output thread per stream, there is the potential for a deadlock that could stall the masking job indefinitely. format: int32
truncateTables (optional)
Boolean This field only applies when masking a database OnTheFly, and it determines whether the target database tables are truncated prior to loading the masked data into the target database (after the masking phase is done).
prescript (optional)
postscript (optional)
databaseRulesetId (optional)
Integer The ID of the database ruleset. This field is set by the Masking Engine. format: int32
rulesetName
String The name of the ruleset. This must be unique within an environment.
databaseConnectorId
Integer The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector. format: int32
refreshDropsTables (optional)
Boolean This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.
newRulesetName
String The name of the ruleset. This must be unique within an environment.
_pageInfo (optional)
responseList (optional)
domainName
createdBy (optional)
String Backend generated field
defaultAlgorithmCode
String Must be one of the algorithm codes
defaultTokenizationCode (optional)
String This input is optional. If used, must be one of the tokenization algorithm codes
_pageInfo (optional)
responseList (optional)
environmentId (optional)
Integer The ID of the Environment. This field will be generated by the Masking Engine. format: int32
environmentName
String The name for this Environment. Note that it must be unique among Environments.
applicationId
Integer The ID of the associated application. format: int32
purpose
String The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.
MASK
TOKENIZE
isWorkflowEnabled (optional)
Boolean True to have workflow enabled, false to leave the workflow disabled.
_pageInfo (optional)
responseList (optional)
executionId (optional)
Integer The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run. format: int32
jobId
Integer The ID of the job that is being executed. format: int32
connectorType (optional)
String The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.
DATABASE
FILE
VSAM
sourceConnectorId (optional)
Integer The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly. format: int32
targetConnectorId (optional)
Integer The ID of the target connector. This field is only used for multi-tenant jobs. format: int32
status (optional)
String The status of the execution regarding its completion.
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
rowsMasked (optional)
Long The number of rows masked so far by this execution. format: int64
rowsTotal (optional)
Long The total number of rows that this execution should mask. This value is set to -1 while the total row count is being calculated. format: int64
startTime (optional)
Date The date and time that this execution was started. format: date-time
endTime (optional)
Date The date and time that this execution completed. format: date-time
submitTime (optional)
Date The date and time that this execution was submitted. format: date-time
executionComponentId (optional)
Integer The ID of the execution component. format: int32
componentName (optional)
String The name of the component source e.g. the name of the file, table, or Mainframe Dataset file.
executionId (optional)
Integer The ID of the execution. format: int32
status (optional)
String The status of the execution of a component.
CANCELLED
FAILED
RUNNING
SUCCEEDED
WAITING
rowsMasked (optional)
Long The number of rows masked so far in the component. format: int64
rowsTotal (optional)
Long The total number of rows that should be masked in the component. This value is set to -1 while the total row count is being calculated. format: int64
startTime (optional)
Date The date and time that the masking engine starts operating on the component. This will be null for column level profiling and for components that the engine has not started masking. format: date-time
endTime (optional)
Date The date and time that the component is placed in a final state i.e. FAILED or SUCCEEDED. format: date-time
_pageInfo (optional)
responseList (optional)
executionId (optional)
Integer The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run. format: int32
componentId (optional)
Integer The ID of the execution component. format: int32
componentName (optional)
String Name of the execution component
fileDownloadId (optional)
String This value is returned on GET. It can be fed into the file-downloads endpoint.
executionId (optional)
Integer The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run. format: int32
componentId (optional)
Integer The ID of the execution component. format: int32
componentName (optional)
String Name of the execution component
fileDownloadId (optional)
String This value is returned on GET. It can be fed into the file-downloads endpoint.
_pageInfo (optional)
responseList (optional)
executionEventId (optional)
Long The ID of the execution event. format: int64
executionId (optional)
Integer The ID of the execution. format: int32
eventType (optional)
String The type of execution event.
JOB_ABORTED
UNMASKED_DATA
MASKING_FALLBACK
severity (optional)
String The severity of the execution event.
INFO
WARNING
CRITICAL
cause (optional)
String The cause of the execution event.
UNHANDLED_EXCEPTION
IGNORED_EXCEPTION
PATTERN_MATCH_FAILURE
PREMASK_TYPE_CONVERSION_FAILURE
POSTMASK_TYPE_CONVERSION_FAILURE
EXTENDED_ALGORITHM_FAILURE
DRIVER_SUPPORT_TASK_FAILURE
DATA_NOT_FOUND_FAILURE
count (optional)
Long The number of times the execution event occurred. format: int64
timeStamp (optional)
Date The date and time that this execution event first occurred. format: date-time
executionComponentId (optional)
Integer The ID of the execution component with which this execution event is associated format: int32
maskedObjectName (optional)
String The name of the column, field, or other object being masked when this event occurred, if applicable.
algorithmName (optional)
String The name of the masking algorithm running when this event occurred, if applicable.
exceptionType (optional)
String The Java class of the exception that triggered this event, if applicable.
exceptionDetail (optional)
String The details associated with the Java exception that triggered this event, if applicable.
_pageInfo (optional)
responseList (optional)
_pageInfo (optional)
responseList (optional)
executionId (optional)
Integer The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run. format: int32
jobId (optional)
Integer The ID of the job that is being executed. format: int32
fileDownloadId (optional)
String This value is returned on GET. It can be fed into the file-downloads endpoint.
status (optional)
String The status of the execution regarding its completion.
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
executionId (optional)
Integer The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run. format: int32
jobId (optional)
Integer The ID of the job that is being executed. format: int32
fileDownloadId (optional)
String This value is returned on GET. It can be fed into the file-downloads endpoint.
status (optional)
String The status of the execution regarding its completion.
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
_pageInfo (optional)
responseList (optional)
exportResponseMetadata
blob
String Export package containing data representing masking object
signature
String Cryptographic signature of the blob
publicKey
String Public version of the key used to generate the signature
objectIdentifier
objectType
String Type of object to export
ALGORITHM_PLUGIN
ALGORITHM_REFERENCE
APPLICATION_SETTINGS
BINARYLOOKUP
CLEANSING
DATABASE_CONNECTOR
DATABASE_RULESET
DATASET_CONNECTOR
DATASET_RULESET
DATASET_FORMAT
DATE_SHIFT
DOMAIN
DOMAIN_REFERENCE
DRIVER_SUPPORT_PLUGIN
ENVIRONMENT
FILE_CONNECTOR
FILE_FORMAT
FILE_RULESET
GLOBAL_OBJECT
JDBC_DRIVER
KEY
LOOKUP
MAPPLET
MASKING_JOB
MIN_MAX
MOUNT_INFORMATION
PROFILE_EXPRESSION
PROFILE_TYPE_EXPRESSION
PROFILE_TYPE_EXPRESSION_REFERENCE
PROFILE_EXPRESSION_REFERENCE
PROFILE_JOB
PROFILE_SET
PROFILE_SET_REFERENCE
REDACTION
REIDENTIFICATION_JOB
SEGMENT
SOURCE_DATABASE_CONNECTOR
SOURCE_DATASET_CONNECTOR
SOURCE_FILE_CONNECTOR
TOKENIZATION
TOKENIZATION_JOB
USER_ALGORITHM
revisionHash (optional)
String Global comparison value for syncable object
_pageInfo (optional)
responseList (optional)
exportHost (optional)
exportDate (optional)
requestedObjectList (optional)
exportedObjectList (optional)
fileConnectorId (optional)
Integer The ID number of the file connector. This field is auto-generated by the Masking Engine. format: int32
connectorName
String The name of the file connector.
environmentId
Integer The ID number of the environment that the file connector is in. Once the file connector is created, this field cannot be changed. format: int32
fileType
String This field denotes which file type, of the several types supported, the file connector will target.
DELIMITED
FIXED_WIDTH
XML
connectionInfo
ConnectionInfo This field object contains the information needed to connect to the underlying files.
_pageInfo (optional)
responseList (optional)
fileFieldMetadataId (optional)
Integer The ID number of the file field metadata. This field is auto-generated by the Masking Engine. format: int32
fileFormatId (optional)
Integer The ID number of the file format that defines this file field. format: int32
recordTypeId (optional)
Integer The ID number of the record type that defines this file field. Required in case of Create API format: int32
fieldLength (optional)
Integer The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API format: int32
fieldName (optional)
String The name of the file field, as determined by the associated file format. Required in case of Create API
fieldPositionNumber (optional)
Integer The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API format: int32
algorithmName (optional)
String The name of the algorithm assigned to this file field. File fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.
algorithmFieldId (optional)
Long The ID number of the algorithm field that is associated with this column. format: int64
algorithmGroupNo (optional)
Long The group number of algorithm to identify a set of columns associated with one instance of algorithm. format: int64
domainName (optional)
String The name of the domain assigned to this file field. File fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.
dateFormat (optional)
String The date format of the date assigned to this column.
isMasked (optional)
Boolean This field indicates whether or not a file field is being masked. This field is assigned by the Masking Engine to true or false based on whether the file field is assigned an algorithm and domain.
isProfilerWritable
Boolean This field indicates whether or not a file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.
notes (optional)
String This field is used to store additional information about the file field.
_pageInfo (optional)
responseList (optional)
fileFormatId (optional)
Integer The ID number of the file format. This field is auto-generated by the Masking Engine. format: int32
fileFormatName (optional)
String The name of the file format, as inferred from the uploaded file.
fileFormatType (optional)
String The type of file that this file format describes.
DELIMITED
FIXED_WIDTH
XML
header (optional)
Integer The number of lines at the beginning of the file to skip. format: int32
footer (optional)
Integer The number of lines at the end of the file to skip. format: int32
_pageInfo (optional)
responseList (optional)
fileMetadataId (optional)
Integer The ID of the file metadata. This field is set by the Masking Engine. format: int32
fileName
String The name of the file metadata. This name must match the name of a file in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same file cannot be added to a ruleset more than once.
rulesetId
Integer The ID of the ruleset to create the file metadata on. format: int32
fileFormatId (optional)
Integer The ID of the file format corresponding to this file. It is used to determine the fields for this file. This field is required. format: int32
fileType (optional)
String The type of file this is. This field will match the file connector file type.
DELIMITED
FIXED_WIDTH
XML
delimiter (optional)
String The delimiter for a delimited file. This field should be left blank for other file types.
enclosure (optional)
String The text enclosure for the file.
enclosureEscapeCharacter (optional)
String The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.
escapeEnclosureEscapeCharacter (optional)
Boolean This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.
endOfRecord (optional)
String The string of characters that delineates the end-of-record for a file. Note that, for linux this is '\n', and for windows it is '\r\n'.
nameIsRegularExpression (optional)
Boolean Whether or not this file name represents a regular expression.
wholeFileMasking (optional)
Boolean This flag indicates whether the file is to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.
_pageInfo (optional)
responseList (optional)
fileRulesetId (optional)
Integer The ID of the file ruleset. This field is set by the Masking Engine. format: int32
rulesetName
String The name of the ruleset. This must be unique within an environment.
fileConnectorId
Integer The ID of the file connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector. format: int32
newRulesetName
String The name of the ruleset. This must be unique within an environment.
_pageInfo (optional)
responseList (optional)
fileUuid (optional)
String The unique identifier of the uploaded file. This field is auto-generated by the Masking Engine. This field applies to permanently uploaded files only and can be used to update and delete a permanent file by its ID.
fileReferenceId (optional)
String The reference URI of the uploaded file.
filename (optional)
fileSize (optional)
BigDecimal The size in B (bytes) of the uploaded file.
persistenceType (optional)
String The type of persistence of the uploaded file. Temporary/object indicates that the file was either uploaded as a temporary file or as a file associated with a masking object, like a JDBC driver or algorithm plugin.
PERMANENT
OBJECT/TEMPORARY
_pageInfo (optional)
responseList (optional)
userName
String The username for logging into the Masking Engine.
denyListRedaction (optional)
Boolean Deny list redaction if true, allow list redaction if false.
lookupFileReferenceId (optional)
String The reference URI value returned from the endpoint for uploading the lookup file to the Masking Engine.
lookupRedactionValue (optional)
String The value to use to redact items matching entries specified in the lookup file.
profileSetId (optional)
Integer The ID number of the profile set for defining the pattern matching to use for identifying values for redaction. format: int32
profileSetRedactionValue (optional)
String The value to use to redact items matching patterns defined by the profile set.
objectIdentifier
Object Identifier of the imported object on the engine where it was exported from.
importedObjectIdentifier (optional)
Object Identifier of the imported object on this engine.
objectType
String Type of object to export
ALGORITHM_PLUGIN
ALGORITHM_REFERENCE
APPLICATION_SETTINGS
BINARYLOOKUP
CLEANSING
DATABASE_CONNECTOR
DATABASE_RULESET
DATASET_CONNECTOR
DATASET_RULESET
DATASET_FORMAT
DATE_SHIFT
DOMAIN
DOMAIN_REFERENCE
DRIVER_SUPPORT_PLUGIN
ENVIRONMENT
FILE_CONNECTOR
FILE_FORMAT
FILE_RULESET
GLOBAL_OBJECT
JDBC_DRIVER
KEY
LOOKUP
MAPPLET
MASKING_JOB
MIN_MAX
MOUNT_INFORMATION
PROFILE_EXPRESSION
PROFILE_TYPE_EXPRESSION
PROFILE_TYPE_EXPRESSION_REFERENCE
PROFILE_EXPRESSION_REFERENCE
PROFILE_JOB
PROFILE_SET
PROFILE_SET_REFERENCE
REDACTION
REIDENTIFICATION_JOB
SEGMENT
SOURCE_DATABASE_CONNECTOR
SOURCE_DATASET_CONNECTOR
SOURCE_FILE_CONNECTOR
TOKENIZATION
TOKENIZATION_JOB
USER_ALGORITHM
importStatus (optional)
SUCCESS
FAILED
SKIPPED
failureMessage (optional)
fileType
String The type of file that is being installed.
LICENSE_DB2_ISERIES
LICENSE_DB2_MAINFRAME
fileReferenceId
String The reference URI of the uploaded file to be installed. This file should have been uploaded via the /fileUpload endpoint.
requiresRestart (optional)
Boolean True if the Masking Engine must be restarted for the installation to take effect, false otherwise.
jdbcDriverId (optional)
Integer The ID number of the driver. This field is auto-generated by the Masking Engine. format: int32
driverName
String The name of the driver.
driverClassName
String The name of the class to use.
description (optional)
String A description of the driver.
version (optional)
String The version of the driver.
uploadedBy (optional)
String The name of the user that uploaded the driver
uploadDate (optional)
Date The date the driver was updated. format: date-time
checksum (optional)
String The md5 checksum of the uploaded driver.
builtIn (optional)
Boolean Whether this is a JDBC driver that is supported natively by the engine.
loggerInstalled (optional)
Boolean Whether a logger is successfully installed.
fileReferenceId (optional)
String The file references ID of the uploaded zip file
driverSupportId (optional)
Long The ID of the Driver Support plugin to use for this JDBC Driver. format: int64
_pageInfo (optional)
responseList (optional)
taskId
Integer The object identifier of the DRIVER_SUPPORT_TASK plugin object type found in the response of the plugin API. format: int32
knowledgeBaseInfoId (optional)
Long The ID of the knowledge base entry. format: int64
title (optional)
String The title for the knowledge base entry.
link (optional)
String The link to the information in the knowledge base.
tag (optional)
String The lookup tag associated with the information in the knowledge base.
_pageInfo (optional)
responseList (optional)
fileDownloadId (optional)
String The identifier to use when downloading the file via the /file-downloads endpoint.
file-number (optional)
Integer The number of the file ordered from most recent to least recent. The 0th file represents the one that is currently being written to. format: int32
logLevel (optional)
String The log level of the log file.
DEBUG
ERROR
INFO
WARN
_pageInfo (optional)
responseList (optional)
logStatement
String The statement to inject into the Masking Engine logs.
logLevel
String The log level at which to inject the log statement.
DEBUG
ERROR
INFO
WARN
username
String The username for logging into the Masking Engine.
password
String The password for logging into the Masking Engine.
Authorization (optional)
String The Authorization token to be provided in the headers of subsequent endpoint calls. Note that the timeout for the Authorization token is controlled by the 'API_AUTHORIZATION_TIMEOUT' property.
mainframeDatasetConnectorId (optional)
Integer The ID number of the Mainframe Dataset connector. This field is auto-generated by the Masking Engine. format: int32
connectorName
String The name of the Mainframe Dataset connector.
environmentId
Integer The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed. format: int32
connectionInfo
ConnectionInfo This field object contains the information needed to connect to the underlying files.
_pageInfo (optional)
responseList (optional)
mainframeDatasetFieldMetadataId (optional)
Integer The ID number of the Mainframe Dataset field metadata. This field is auto-generated by the Masking Engine. format: int32
mainframeDatasetFormatId (optional)
Integer The ID number of the Mainframe Dataset format that defines this Mainframe Dataset field. format: int32
fieldName (optional)
String The name of the Mainframe Dataset field, as determined by the associated Mainframe Dataset format.
algorithmName (optional)
String The name of the algorithm assigned to this Mainframe Dataset field. Mainframe Dataset fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.
algorithmFieldId (optional)
Long The ID number of the algorithm field that is associated with this column. format: int64
algorithmGroupNo (optional)
Long The group number of algorithm to identify a set of columns associated with one instance of algorithm. format: int64
domainName (optional)
String The name of the domain assigned to this Mainframe Dataset field. Mainframe Dataset fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.
dateFormat (optional)
String The date format of the date assigned to this Mainframe Dataset field.
isMasked (optional)
Boolean This field indicates whether or not a Mainframe Dataset field is being masked. This field is assigned by the Masking Engine to true or false based on whether the Mainframe Dataset field is assigned an algorithm and domain.
isProfilerWritable (optional)
Boolean This field indicates whether or not a Mainframe Dataset field (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.
parentId (optional)
Integer The ID number of the parent field of Mainframe Dataset field. format: int32
_pageInfo (optional)
responseList (optional)
mainframeDatasetFormatId (optional)
Integer The ID number of the Mainframe Dataset format. This field is auto-generated by the Masking Engine. format: int32
mainframeDatasetFormatName (optional)
String The name of the Mainframe Dataset format, as inferred from the uploaded file.
_pageInfo (optional)
responseList (optional)
mainframeDatasetMetadataId (optional)
Integer The ID of the Mainframe Dataset metadata. This field is set by the Masking Engine. format: int32
fileName
String The name of the Mainframe Dataset metadata. This name must match the name of a file in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same file cannot be added to a ruleset more than once.
rulesetId
Integer The ID of the ruleset to create the Mainframe Dataset metadata on. format: int32
mainframeDatasetFormatId (optional)
Integer The ID of the Mainframe Dataset format corresponding to this Mainframe Dataset metadata. It is used to determine the fields for this file. This field is required. format: int32
recordFormat (optional)
String The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.
FIXED_BLOCKED
VARIABLE_BLOCKED
nameIsRegularExpression (optional)
Boolean Whether or not this file name represents a regular expression.
_pageInfo (optional)
responseList (optional)
mainframeDatasetRecordTypeId (optional)
Integer The ID number of the mainframe dataset record type. This field is auto-generated by the Masking Engine. format: int32
mainframeDatasetFormatId (optional)
Integer The ID number of the mainframe dataset format this mainframe dataset record type refers to. format: int32
mainframeDatasetRecordTypeName (optional)
String The Name of the mainframe dataset record type.
redefineCondition (optional)
String The 'redefine condition' for the record type.
type (optional)
String The type of the field identified with mainframeDatasetFieldMetadataId.
REDEFINED
REDEFINES
mainframeDatasetFieldMetadataId (optional)
Integer The ID number of the redefined or redefines mainframe dataset field metadata id to which this mainframe record type is associated. format: int32
_pageInfo (optional)
responseList (optional)
mainframeDatasetRulesetId (optional)
Integer The ID of the Mainframe Dataset ruleset. This field is set by the Masking Engine. format: int32
rulesetName
String The name of the ruleset. This must be unique within an environment.
mainframeDatasetConnectorId
Integer The ID of the Mainframe Dataset Connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector. format: int32
newRulesetName
String The name of the ruleset. This must be unique within an environment.
_pageInfo (optional)
responseList (optional)
algorithmName
String The name of the algorithm.
totalMappings
Integer The total number of mappings assigned to this mapping algorithm. format: int32
unusedMappings
Integer The total number of unused mappings assigned to this mapping algorithm. format: int32
fileReferenceId (optional)
String The reference URI value returned from the endpoint for uploading files to the Masking Engine. The file should contain a newline separated list of mapping values.
ignoreCharacters (optional)
array[Integer] The integer ASCII values of characters to ignore in the column data to map
mappletInput (optional)
String The name of the input variable for the custom algorithm
mappletOutput (optional)
String The name of the output variable for the custom algorithm
fileName (optional)
String The name of the uploaded file.
fileReferenceId (optional)
String The reference URI value returned from the endpoint for uploading files to the Masking Engine.
fileDownloadId (optional)
String This value is returned on GET. It can be fed into the file-downloads endpoint.
maskingJobId (optional)
Integer The ID number of the masking job. This field is auto-generated by the Masking Engine. format: int32
jobName
String The name of the masking job. Once the masking job is created, this field cannot be changed.
rulesetId
Integer The ID of the ruleset that this masking job is based on. Once the masking 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. format: int32
rulesetType (optional)
String The type of the ruleset that this masking job is assigned to.
createdBy (optional)
String The user that created the masking job. This field is auto-generated by the Masking Engine.
createdTime (optional)
Date The time when the masking job was created. This field is auto-generated by the Masking Engine. format: date-time
email (optional)
String The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.
feedbackSize (optional)
Integer 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. format: int32
jobDescription (optional)
String A description of the job.
maxMemory (optional)
Integer The maximum amount of memory, in MB, that the masking job can consume during execution. format: int32
minMemory (optional)
Integer The minimum amount of memory, in MB, that the masking job can consume during execution. format: int32
multiTenant (optional)
Boolean This field determines whether the masking job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this masking job is based on.
numInputStreams (optional)
Integer This field controls the amount of parallelism that the masking job uses to extract out the data to be masked. For instance, when masking a database, specifying 5 input streams results in the masking job reading up to 5 database tables in parallel and then masking 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 masking job will consume more memory. If the number of input streams exceeds the number of units being masked (e.g. tables or files), then the excess streams will do nothing. format: int32
onTheFlyMasking (optional)
Boolean This field determines whether the masking job will be performed InPlace or OnTheFly. The process for InPlace masking is to read out the data to be masked, mask the data, and then load the masked data back into the original data source. The process for OnTheFly masking is to read out the data to be masked, mask the data, and then load the masked data back into a different data source. When masking OnTheFly, the field 'onTheFlyMaskingSource' must be provided.
databaseMaskingOptions (optional)
DatabaseMaskingOptions This field only applies when masking a database, and it can be used to specify various database options to optimize the masking job. Not all database options are supported for all database types.
onTheFlyMaskingSource (optional)
OnTheFlyMaskingSource This field is required when the masking job is performed OnTheFly; it describes the source connection from where the data to be masked will be extracted.
failImmediately (optional)
Boolean This field determines whether the masking job will fail immediately or delay failure until job completion when a masking algorithm fails to mask its data. Setting this value to 'false' provides a means for a user to see all cumulative masking errors before the job is marked as failed.
enabledTasks (optional)
array[JobTask] This field determines what tasks to perform before/after a job from a set of available driver support tasks as indicated by the chosen target ruleset/connector.
streamRowLimit (optional)
Integer This value constrains the total number of rows that may enter the job for each masking stream. A setting of 0 means unlimited. A value of -1 selects the default value. The default value for this setting varies by job type. The minimum explicit value allowed is 20
_pageInfo (optional)
responseList (optional)
name
String The name of the job SQL script, e.g. 'prescript.sql' or 'postscript.sql'
contents
String The file contents of the job SQL script.
minValue (optional)
Integer The minimum value for a Number range used in conjunction with maxValue. This field cannot be combined with minDate or maxDate. format: int32
maxValue (optional)
Integer The maximum value for a Number range used in conjunction with and must be greater than minValue. This field cannot be combined with minDate or maxDate. format: int32
minDate (optional)
date The minimum value for a Date range used in conjunction with maxDate. The Date must be specified in one of the following formats according to RFC 3339 Section 5.6: "yyyy-MM-dd", "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", or "EEE, dd MMM yyyy HH:mm:ss zzz". If a timezone is not specified, the Date will be interpreted as UTC. This field cannot be combined with minValue or maxValue. format: date
maxDate (optional)
date The maximum value for a Date range used in conjunction with and must be greater than minDate. The Date must be specified in one of the following formats according to RFC 3339 Section 5.6: "yyyy-MM-dd", "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", or "EEE, dd MMM yyyy HH:mm:ss zzz". If a timezone is not specified, the Date will be interpreted as UTC. This field cannot be combined with minValue or maxValue. format: date
outOfRangeDefaultValue (optional)
String The default replacement value for any value that is out-of-range.
taskId
Integer The ID of the monitorable Task. This field will be generated by the Masking Engine, correspond to taskType format: int32
taskType
String The type of async task to monitor.
EXECUTIONS
ASYNC_TASK
progression (optional)
_pageInfo (optional)
responseList (optional)
mountId (optional)
Integer The ID number of the mount. This field is auto-generated by the Masking Engine. format: int32
mountName
String The name of the mount. This field must be unique.
hostAddress
String The host address of the server. This field cannot be changed.
mountPath
String The path to the directory on the filesystem to mount. This field cannot be changed.
type
String The type of filesystem. This field cannot be changed.
CIFS
NFS3
NFS4
connectOnStartup (optional)
Boolean This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.
options (optional)
String The options for mount. The endpoint will return all default options and user specified options.
status (optional)
String The connection status for mount. This field is automatically managed by the masking engine
ACTIVE
DISCONNECTED
_pageInfo (optional)
responseList (optional)
roleId
Integer The ID of the role assigned to this User. format: int32
environmentIds (optional)
array[Integer] The list of ID numbers that correspond to the environments that this User has access to. format: int32
dataSampleId (optional)
Long The ID of the non-conformant data sample. format: int64
executionEventId (optional)
Long The ID of the execution event this sample is associated with. format: int64
dataSample (optional)
String The redacted value of the non-conformant field data that could not be masked by the assigned algorithm.
count (optional)
Long The approximate number of times this data pattern was encountered. format: int64
_pageInfo (optional)
responseList (optional)
dataSampleId (optional)
Long The ID of the non-conformant data sample. format: int64
executionEventId (optional)
Long The ID of the execution event this sample is associated with. format: int64
dataSample (optional)
String The redacted value of the non-conformant field data that could not be masked by the assigned algorithm.
count (optional)
Long The approximate number of times this data pattern was encountered. format: int64
isOAuth2ReadyWithNameMatching
Boolean Whether or not the Masking Engine is ready to enable OAuth2 with user matching based on the name property.
isOAuth2ReadyWithEmailAddressMatching
Boolean Whether or not the Masking Engine is ready to enable OAuth2 with user matching based on the email_address property.
isOAuth2ReadyWithPrincipalMatching
Boolean Whether or not the Masking Engine is ready to enable OAuth2 with user matching based on the principal property.
connectorId
Integer The ID number of the source connector for the OnTheFly masking job. format: int32
connectorType (optional)
String The type of the source connector for the OnTheFly masking job.
DATABASE
FILE
VSAM
numberOnPage (optional)
Long The number of items on this page. This should always match the page size unless it is the last page. format: int64
total (optional)
Long The total number of items format: int64
pluginId (optional)
Long The id of the plugin format: int64
pluginName (optional)
pluginAuthor (optional)
String The author of the plugin
pluginType (optional)
EXTENDED_ALGORITHM
DRIVER_SUPPORT
originalFileName (optional)
String The original name of the plugin JAR file
originalFileChecksum (optional)
String The hex string value of the SHA-256 hash of the plugin JAR file
installDate (optional)
Date Date and time when this plugin was installed format: date-time
installUser (optional)
Integer The login ID of the user that installed this plugin format: int32
builtIn (optional)
Boolean Whether this plugin was included with Delphix Engine software distribution
pluginVersion (optional)
String The string version identifier of the plugin
description (optional)
String The description of the plugin
pluginObjects (optional)
pluginId (optional)
Long The id of the plugin format: int64
pluginName (optional)
pluginAuthor (optional)
String The author of the plugin
pluginType (optional)
EXTENDED_ALGORITHM
DRIVER_SUPPORT
_pageInfo (optional)
responseList (optional)
objectIdentifier (optional)
objectName (optional)
objectType (optional)
String The type of plugin object
ALGORITHM
ALGORITHM_FRAMEWORK
DRIVER_SUPPORT_TASK
copy (optional)
Boolean This field indicates whether or not this privilege has the ability to copy the object it is applied to.
create (optional)
Boolean This field indicates whether or not this privilege has the ability to create the object it is applied to.
delete (optional)
Boolean This field indicates whether or not this privilege has the ability to delete the object it is applied to.
export (optional)
Boolean This field indicates whether or not this privilege has the ability to export the object it is applied to.
import (optional)
Boolean This field indicates whether or not this privilege has the ability to import the object it is applied to.
run (optional)
Boolean This field indicates whether or not this privilege has the ability to run the object it is applied to.
update (optional)
Boolean This field indicates whether or not this privilege has the ability to update the object it is applied to.
view (optional)
Boolean This field indicates whether or not this privilege has the ability to view the object it is applied to.
profileExpressionId (optional)
Integer The ID number of the profile expression. This field is auto-generated by the Masking Engine. format: int32
domainName
String The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.
expressionName
String The name of the profile expression; it must be unique.
regularExpression
String The regularExpression that will be used to match against column/field names or data values during the execution of a profile job.
createdBy (optional)
String The user that created the profile expression. This field is auto-generated by the Masking Engine.
dataLevelProfiling (optional)
Boolean This field determines whether the profile expression will be targeted at the underlying data in a data source (e.g. row values in the database column / field values in the file), or whether the profile expression will be targeted at the schema of the data source (e.g. column names in a database table or field names in a file). Data-Level profiling consumes more memory than Column-Name-Level/Field-Name-Level profiling due to the fact that the profile expression must be checked against a larger number of data values (e.g. hundreds) than column/field names (i.e. one).
_pageInfo (optional)
responseList (optional)
profileJobId (optional)
Integer The ID number of the profile job. This field is auto-generated by the Masking Engine. format: int32
jobName
String The name of the profile job. Once the profile job is created, this field cannot be changed.
profileSetId
Integer The ID number of the profile set to be used during the profiling phase. format: int32
rulesetId
Integer 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. format: int32
rulesetType (optional)
String The type of the ruleset that this profile job is assigned to.
createdBy (optional)
String The user that created the profile job. This field is auto-generated by the Masking Engine.
createdTime (optional)
Date The time when the profile job was created. This field is auto-generated by the Masking Engine. format: date-time
email (optional)
String The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.
feedbackSize (optional)
Integer 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. format: int32
jobDescription (optional)
String A description of the job.
maxMemory (optional)
Integer The maximum amount of memory, in MB, that the profile job can consume during execution. format: int32
minMemory (optional)
Integer The minimum amount of memory, in MB, that the profile job can consume during execution. format: int32
multiTenant (optional)
Boolean 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 (optional)
Integer 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. format: int32
multipleProfilerCheck (optional)
Boolean This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.
_pageInfo (optional)
responseList (optional)
profileSetId (optional)
Integer The ID number of the profile set. This field is auto-generated by the Masking Engine. format: int32
profileSetName
String The name of the profile set; it must be unique.
profileExpressionIds
array[Integer] The list of ID numbers that correspond to the profile expressions that belong in this profile set. During the execution of a profile job with this profile set assigned, the profile expressions are evaluated in an arbitrary order. format: int32
profileTypeExpressionIds (optional)
array[Integer] The optional list of ID numbers that correspond to the profile type expressions that belong in this profile set. format: int32
createdBy (optional)
String The user that created the profile set. This field is auto-generated by the Masking Engine.
createdTime (optional)
Date The time when the profile set was created. This field is auto-generated by the Masking Engine. format: date-time
description (optional)
String A description of the purpose of the profile set.
_pageInfo (optional)
responseList (optional)
profileExpressionId (optional)
Integer The ID number of the profile expression. This field is auto-generated by the Masking Engine. format: int32
domainName
String The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.
typeExpressionName
String The name of the profile expression; it must be unique among all profile expressions and profile type expressions
dataType
String Data type to apply a constraint to. Must be one of: String, Number, Date, Binary
String
Number
Date
Binary
minDataLength (optional)
Integer Minimum length of the value for string types format: int32
createdBy (optional)
String The user that created the profile type expression. This field is auto-generated by the Masking Engine.
_pageInfo (optional)
responseList (optional)
recordTypeId (optional)
Integer The ID number of the record type. This field is auto-generated by the Masking Engine. format: int32
recordTypeName (optional)
String The name of the record type.
fileFormatId (optional)
Integer The ID number of the file format that the record type refers to. format: int32
_pageInfo (optional)
responseList (optional)
recordTypeQualifierId (optional)
Integer The ID number of the record type qualifier. This field is auto-generated by the Masking Engine. format: int32
recordTypeId (optional)
Integer The ID number of the record type that the record type qualifier refers to. format: int32
pattern (optional)
String The pattern to match against the record type field.
fileFieldMetadataId (optional)
Integer The ID of the record type field the record type qualifier refers to. format: int32
_pageInfo (optional)
responseList (optional)
reidentificationJobId (optional)
Integer The ID number of the re-identification job. This field is auto-generated by the Masking Engine. format: int32
jobName
String The name of the re-identification job. Once the re-identification job is created, this field cannot be changed.
rulesetId
Integer The ID of the ruleset that this re-identification job is based on. Once the re-identification 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. format: int32
rulesetType (optional)
String The type of the ruleset that this re-identification job is assigned to.
createdBy (optional)
String The user that created the re-identification job. This field is auto-generated by the Masking Engine.
createdTime (optional)
Date The time when the re-identification job was created. This field is auto-generated by the Masking Engine. format: date-time
email (optional)
String The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.
feedbackSize (optional)
Integer The granularity with which the Masking Engine provides updates on the progress of the re-identification job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the masking phase. format: int32
jobDescription (optional)
String A description of the job.
maxMemory (optional)
Integer The maximum amount of memory, in MB, that the re-identification job can consume during execution. format: int32
minMemory (optional)
Integer The minimum amount of memory, in MB, that the re-identification job can consume during execution. format: int32
multiTenant (optional)
Boolean This field determines whether the re-identification job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this re-identification job is based on.
numInputStreams (optional)
Integer This field controls the amount of parallelism that the re-identification job uses to extract out the data to be masked. For instance, when masking a database, specifying 5 input streams results in the re-identification job reading up to 5 database tables in parallel and then masking 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 re-identification job will consume more memory. If the number of input streams exceeds the number of units being masked (e.g. tables or files), then the excess streams will do nothing. format: int32
onTheFlyMasking (optional)
Boolean This field determines whether the re-identification job will be performed InPlace or OnTheFly. The process for InPlace masking is to read out the data to be masked, mask the data, and then load the masked data back into the original data source. The process for OnTheFly masking is to read out the data to be masked, mask the data, and then load the masked data back into a different data source. When masking OnTheFly, the field 'onTheFlyMaskingSource' must be provided.
databaseMaskingOptions (optional)
DatabaseMaskingOptions This field only applies when masking a database, and it can be used to specify various database options to optimize the masking job. Not all database options are supported for all database types.
onTheFlyMaskingSource (optional)
OnTheFlyMaskingSource This field is required when the re-identification job is performed OnTheFly; it describes the source connection from where the data to be masked will be extracted.
failImmediately (optional)
Boolean This field determines whether the masking job will fail immediately or delay failure until job completion when a masking algorithm fails to mask its data. Setting this value to 'false' provides a means for a user to see all cumulative masking errors before the job is marked as failed.
enabledTasks (optional)
array[JobTask] This field determines what tasks to perform before/after a job from a set of available driver support tasks as indicated by the chosen target ruleset/connector.
streamRowLimit (optional)
Integer This value constrains the total number of rows that may enter the job for each masking stream. A setting of 0 means unlimited. A value of -1 selects the default value. The default value for this setting varies by job type. The minimum explicit value allowed is 20
_pageInfo (optional)
responseList (optional)
userName
String The username for resetting the password
token
String The generated token received in the email
password
String The new password for this username.
roleId (optional)
Integer The ID of the Role. This field will be generated by the Masking Engine. format: int32
roleName
String The name for this Role. Note that it must be unique.
environment (optional)
connector (optional)
ruleset (optional)
inventory (optional)
profileJob (optional)
maskingJob (optional)
tokenizeJob (optional)
reidentifyJob (optional)
domain (optional)
algorithm (optional)
jdbcDriver (optional)
plugin (optional)
profileExpression (optional)
Privilege Privileges for profile expressions.
profileSet (optional)
fileFormat (optional)
user (optional)
customAlgorithm (optional)
diagnostic (optional)
inventoryReport (optional)
approveInventories (optional)
Privilege Privileges for approved inventories
_pageInfo (optional)
responseList (optional)
fileReferenceId (optional)
String The reference URI value returned from the endpoint for uploading files to the Masking Engine.
latestKeyResetTime (optional)
Date The last time the algorithm's key was randomized. This changes the masked results of the algorithm. format: date-time
preservedRanges (optional)
ignoreCharacters (optional)
array[Integer] List of decimal values specifying UTF-16 codepoints of characters to ignore (not mask, not count as part of any segment) in the real value. For example, 65 would ignore 'A'
segments (optional)
segmentsGroupLength (optional)
array[Integer] The array to hold UI display length of each Segment group.
errorHandlingMode (optional)
String The behavior should a non-conformant, segment mapping data pattern be encountered by the algorithm.
DEFAULT
DONT_MASK
FAIL
offset (optional)
Integer The character offset of the range of input to preserve
length (optional)
Integer The character length of the range of input to preserve
length (optional)
Integer The length of the segment in digits. This must be 1 for alpha-numeric segments
minInt (optional)
Integer The minimum value of the integer output range of the mapping function
maxInt (optional)
Integer The maximum value of the integer output range of the mapping function
minChar (optional)
String The minimum value of the character output range of the mapping function
maxChar (optional)
String The maximum value of the character output range of the mapping function
explicitRange (optional)
String Explicitly specify the output range. Format depends on segment type and size
minRealInt (optional)
Integer The minimum value of the integer range specifying which real values will be masked
maxRealInt (optional)
Integer The maximum value of the integer range specifying which real values will be masked
minRealChar (optional)
String The minimum value of the character range specifying which real values will be masked
maxRealChar (optional)
String The maximum value of the character range specifying which real values will be masked
explicitRealRange (optional)
String Explicitly specify the range of input values that should be masked. Format depends on segment type and size
sshKeyName (optional)
String The name of the SSH key. This field will match the file name of the SSH key as it exists on the file system.
version (optional)
String The current version of the Masking Engine.
build (optional)
String The current build of the Masking Engine.
latestGlobalKeyResetTime (optional)
String The latest time the global encryption key has been regenerated.
patentNumbers (optional)
totalAllocatedMemoryForJobs (optional)
BigDecimal The total memory size in MB allocated for running jobs on the Masking Engine.
totalAvailableCores (optional)
Integer The total number of processors available to the Masking Engine.
totalTempFileSpace (optional)
BigDecimal The total number of temporary file space available in B (bytes) on the Masking Engine.
totalPermFileSpace (optional)
BigDecimal The total number of permanent file space available in B (bytes) on the Masking Engine.
latestApiVersion (optional)
String The latest API version supported on the Masking Engine.
tableMetadataId (optional)
Integer The ID of the table metadata. This field is set by the Masking Engine. format: int32
tableName
String The name of the table metadata. This name must match the name of a table in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same table cannot be added to a ruleset more than once.
rulesetId
Integer The ID of the ruleset to create the table metadata on. format: int32
customSql (optional)
String Custom SQL for the table.
whereClause (optional)
String SQL where clause for the table.
havingClause (optional)
String SQL having clause for the table.
keyColumn (optional)
String Key Column for the table.
isMasked (optional)
Boolean This field indicates whether or not a table is masked. This field is assigned by the Masking Engine to true or false based on whether the table is assigned an algorithm and domain. This field will get only masked table metadata when this is true, only unmasked column metadata when this is false and leaving this blank will get all tables
customSql (optional)
String Custom SQL for the table.
_pageInfo (optional)
responseList (optional)
event (optional)
String The steps or events a task will perform
order (optional)
Integer execution order of the task events
status (optional)
String The state of result of the task event
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
SKIPPED
NON_CONFORMANT
response (optional)
String Success or failure of the connection test.
latestKeyResetTime (optional)
Date The last time the algorithm's key was randomized. This changes the masked results of the algorithm. format: date-time
tokenizationJobId (optional)
Integer The ID number of the tokenization job. This field is auto-generated by the Masking Engine. format: int32
jobName
String The name of the tokenization job. Once the tokenization job is created, this field cannot be changed.
rulesetId
Integer The ID of the ruleset that this tokenization job is based on. Once the tokenization 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. format: int32
rulesetType (optional)
String The type of the ruleset that this tokenization job is assigned to.
createdBy (optional)
String The user that created the tokenization job. This field is auto-generated by the Masking Engine.
createdTime (optional)
Date The time when the tokenization job was created. This field is auto-generated by the Masking Engine. format: date-time
email (optional)
String The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.
feedbackSize (optional)
Integer The granularity with which the Masking Engine provides updates on the progress of the tokenization job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the masking phase. format: int32
jobDescription (optional)
String A description of the job.
maxMemory (optional)
Integer The maximum amount of memory, in MB, that the tokenization job can consume during execution. format: int32
minMemory (optional)
Integer The minimum amount of memory, in MB, that the tokenization job can consume during execution. format: int32
multiTenant (optional)
Boolean This field determines whether the tokenization job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this tokenization job is based on.
numInputStreams (optional)
Integer This field controls the amount of parallelism that the tokenization job uses to extract out the data to be masked. For instance, when masking a database, specifying 5 input streams results in the tokenization job reading up to 5 database tables in parallel and then masking 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 tokenization job will consume more memory. If the number of input streams exceeds the number of units being masked (e.g. tables or files), then the excess streams will do nothing. format: int32
onTheFlyMasking (optional)
Boolean This field determines whether the tokenization job will be performed InPlace or OnTheFly. The process for InPlace masking is to read out the data to be masked, mask the data, and then load the masked data back into the original data source. The process for OnTheFly masking is to read out the data to be masked, mask the data, and then load the masked data back into a different data source. When masking OnTheFly, the field 'onTheFlyMaskingSource' must be provided.
databaseMaskingOptions (optional)
DatabaseMaskingOptions This field only applies when masking a database, and it can be used to specify various database options to optimize the masking job. Not all database options are supported for all database types.
onTheFlyMaskingSource (optional)
OnTheFlyMaskingSource This field is required when the tokenization job is performed OnTheFly; it describes the source connection from where the data to be masked will be extracted.
failImmediately (optional)
Boolean This field determines whether the masking job will fail immediately or delay failure until job completion when a masking algorithm fails to mask its data. Setting this value to 'false' provides a means for a user to see all cumulative masking errors before the job is marked as failed.
enabledTasks (optional)
array[JobTask] This field determines what tasks to perform before/after a job from a set of available driver support tasks as indicated by the chosen target ruleset/connector.
streamRowLimit (optional)
Integer This value constrains the total number of rows that may enter the job for each masking stream. A setting of 0 means unlimited. A value of -1 selects the default value. The default value for this setting varies by job type. The minimum explicit value allowed is 20
_pageInfo (optional)
responseList (optional)
userId (optional)
Integer The ID of the User. This field will be generated by the Masking Engine. format: int32
userName
String The name for this User. Note that it must be unique among Users.
password (optional)
String The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.
firstName
String The first name of this User. This does not need to match the user name.
lastName
String The last name of this User. This does not need to match the user name.
email
String The email address for this User.
isAdmin
Boolean True for an administrative User, false for a non-administrative User.
showWelcome (optional)
Boolean Flag to enable and disable welcome page for user, default true for a newly created User.
userStatus
String Status of user account.
ACTIVE
LOCKED
DISABLED
disableReason (optional)
String The reason why the user's account was locked.
nonAdminProperties (optional)
NonAdminProperties This field only applies to non-admin Users, and it must always be provided for them.
apiAccess (optional)
Boolean For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.
principal (optional)
String Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.
_pageInfo (optional)
responseList (optional)