Masking API

Schema for the Masking Engine API
Version: 5.0.0
All rights reserved

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Algorithm

Application

ApplicationSettings

AsyncTask

ColumnMetadata

DatabaseConnector

DatabaseRuleset

Domain

EncryptionKey

Environment

Execution

ExecutionComponent

ExecutionEvent

FileConnector

FileDownload

FileFieldMetadata

FileFormat

FileMetadata

FileRuleset

FileUpload

Logging

Login

MainframeDatasetConnector

MainframeDatasetFieldMetadata

MainframeDatasetFormat

MainframeDatasetMetadata

MainframeDatasetRuleset

MaskingJob

NonConformantDataSample

ProfileExpression

ProfileJob

ProfileSet

ReidentificationJob

Role

SshKey

Sync

SystemInformation

TableMetadata

TokenizationJob

User

Algorithm

Up
post /algorithms
Create algorithm [INCUBATING] (createAlgorithm)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Request body

body Algorithm (required)
Body Parameter — The algorithm to create

Return type

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (deleteAlgorithm)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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 Accept 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 /algorithms/{algorithmName}
Get algorithm by name [INCUBATING] (getAlgorithm)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

algorithmName (required)
Path Parameter — The name of the algorithm to get

Return type

Algorithm

Example data

Content-Type: application/json
{
  "algorithmExtension" : "{}",
  "algorithmType" : "aeiou",
  "createdBy" : "aeiou",
  "description" : "aeiou",
  "algorithmName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 /algorithms
Get all algorithms [INCUBATING] (getAllAlgorithms)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Query parameters

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

AlgorithmList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "algorithmExtension" : "{}",
    "algorithmType" : "aeiou",
    "createdBy" : "aeiou",
    "description" : "aeiou",
    "algorithmName" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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
put /algorithms/{algorithmName}/randomize-key
Randomize algorithm key by name [INCUBATING] (randomizeAlgorithmKey)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

algorithmName (required)
Path Parameter — The name of the algorithm who's key should be randomized

Return type

Algorithm

Example data

Content-Type: application/json
{
  "algorithmExtension" : "{}",
  "algorithmType" : "aeiou",
  "createdBy" : "aeiou",
  "description" : "aeiou",
  "algorithmName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (updateAlgorithm)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

algorithmName (required)
Path Parameter — The name of the algorithm to update

Request body

body Algorithm (required)
Body Parameter — The updated algorithm

Return type

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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

Application

Up
post /applications
Create application (createApplication)

Request body

body Application (required)
Body Parameter — The application to create

Return type

Application

Example data

Content-Type: application/json
{
  "applicationName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success Application

400

Bad request

409

Conflict

Up
get /applications
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

ApplicationList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "applicationName" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success ApplicationList

400

Bad request

Up
get /applications/{applicationName}
Get application by name [INCUBATING] (getApplication)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

applicationName (required)
Path Parameter — The name of the application to get

Return type

Application

Example data

Content-Type: application/json
{
  "applicationName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success Application

404

Not found

ApplicationSettings

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

ApplicationSettingsList

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 Accept 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

ApplicationSettings

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 Accept 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 ApplicationSettings (required)
Body Parameter — The updated application setting

Return type

ApplicationSettings

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 Accept 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

AsyncTask

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 Accept 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 /async-tasks
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

AsyncTaskList

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"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

AsyncTask

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success AsyncTask

401

Unauthorized access

404

Not found

ColumnMetadata

Up
get /column-metadata
Get all column metadata [INCUBATING] (getAllColumnMetadata)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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

ColumnMetadataList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "xmlFileFormatId" : 123,
    "columnLength" : 123,
    "notes" : "aeiou",
    "dateFormat" : "aeiou",
    "dataType" : "aeiou",
    "xmlDataSource" : "aeiou",
    "isPrimaryKey" : true,
    "isIndex" : true,
    "isMasked" : true,
    "algorithmName" : "aeiou",
    "tableMetadataId" : 123,
    "isProfilerWritable" : true,
    "columnMetadataId" : 123,
    "isForeignKey" : true,
    "domainName" : "aeiou",
    "columnName" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (getColumnMetadataById)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

columnMetadataId (required)
Path Parameter — The ID of the column metadata to get format: int32

Return type

ColumnMetadata

Example data

Content-Type: application/json
{
  "xmlFileFormatId" : 123,
  "columnLength" : 123,
  "notes" : "aeiou",
  "dateFormat" : "aeiou",
  "dataType" : "aeiou",
  "xmlDataSource" : "aeiou",
  "isPrimaryKey" : true,
  "isIndex" : true,
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "tableMetadataId" : 123,
  "isProfilerWritable" : true,
  "columnMetadataId" : 123,
  "isForeignKey" : true,
  "domainName" : "aeiou",
  "columnName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (updateColumnMetadata)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

columnMetadataId (required)
Path Parameter — The ID of the column metadata to update format: int32

Request body

body ColumnMetadata (required)
Body Parameter — The updated column metadata

Return type

ColumnMetadata

Example data

Content-Type: application/json
{
  "xmlFileFormatId" : 123,
  "columnLength" : 123,
  "notes" : "aeiou",
  "dateFormat" : "aeiou",
  "dataType" : "aeiou",
  "xmlDataSource" : "aeiou",
  "isPrimaryKey" : true,
  "isIndex" : true,
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "tableMetadataId" : 123,
  "isProfilerWritable" : true,
  "columnMetadataId" : 123,
  "isForeignKey" : true,
  "domainName" : "aeiou",
  "columnName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

DatabaseConnector

Up
post /database-connectors
Create database connector [INCUBATING] (createDatabaseConnector)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Request body

body DatabaseConnector (required)
Body Parameter — The database connector to create

Return type

DatabaseConnector

Example data

Content-Type: application/json
{
  "servicePrincipal" : "aeiou",
  "databaseName" : "aeiou",
  "instanceName" : "aeiou",
  "databaseConnectorId" : 123,
  "jdbc" : "aeiou",
  "schemaName" : "aeiou",
  "sid" : "aeiou",
  "databaseType" : "aeiou",
  "password" : "aeiou",
  "environmentId" : 123,
  "port" : 123,
  "customDriverName" : "aeiou",
  "host" : "aeiou",
  "connectorName" : "aeiou",
  "username" : "aeiou",
  "kerberosAuth" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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 [INCUBATING] (getAllDatabaseConnectors)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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
environmentId (optional)
Query Parameter — The ID of the environment to get all database connectors from format: int32

Return type

DatabaseConnectorList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "servicePrincipal" : "aeiou",
    "databaseName" : "aeiou",
    "instanceName" : "aeiou",
    "databaseConnectorId" : 123,
    "jdbc" : "aeiou",
    "schemaName" : "aeiou",
    "sid" : "aeiou",
    "databaseType" : "aeiou",
    "password" : "aeiou",
    "environmentId" : 123,
    "port" : 123,
    "customDriverName" : "aeiou",
    "host" : "aeiou",
    "connectorName" : "aeiou",
    "username" : "aeiou",
    "kerberosAuth" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept 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}
Get database connector by ID [INCUBATING] (getDatabaseConnectorById)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

databaseConnectorId (required)
Path Parameter — The ID of the database connector to get format: int32

Return type

DatabaseConnector

Example data

Content-Type: application/json
{
  "servicePrincipal" : "aeiou",
  "databaseName" : "aeiou",
  "instanceName" : "aeiou",
  "databaseConnectorId" : 123,
  "jdbc" : "aeiou",
  "schemaName" : "aeiou",
  "sid" : "aeiou",
  "databaseType" : "aeiou",
  "password" : "aeiou",
  "environmentId" : 123,
  "port" : 123,
  "customDriverName" : "aeiou",
  "host" : "aeiou",
  "connectorName" : "aeiou",
  "username" : "aeiou",
  "kerberosAuth" : true
}

Produces

This API call produces the following media types according to the Accept 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 DatabaseConnector (optional)
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

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 DatabaseConnector (required)
Body Parameter — The database connector to test

Return type

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (updateDatabaseConnector)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

databaseConnectorId (required)
Path Parameter — The ID of the database connector to update format: int32

Request body

body DatabaseConnector (required)
Body Parameter — The updated database connector

Return type

DatabaseConnector

Example data

Content-Type: application/json
{
  "servicePrincipal" : "aeiou",
  "databaseName" : "aeiou",
  "instanceName" : "aeiou",
  "databaseConnectorId" : 123,
  "jdbc" : "aeiou",
  "schemaName" : "aeiou",
  "sid" : "aeiou",
  "databaseType" : "aeiou",
  "password" : "aeiou",
  "environmentId" : 123,
  "port" : 123,
  "customDriverName" : "aeiou",
  "host" : "aeiou",
  "connectorName" : "aeiou",
  "username" : "aeiou",
  "kerberosAuth" : true
}

Produces

This API call produces the following media types according to the Accept 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

DatabaseRuleset

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 TableMetadataBulkInput (required)
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

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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
post /database-rulesets
Create database ruleset (createDatabaseRuleset)

Request body

body DatabaseRuleset (required)
Body Parameter — The database ruleset to create

Return type

DatabaseRuleset

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 Accept 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 Accept 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

DatabaseRulesetList

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 Accept 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

DatabaseRuleset

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 Accept 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

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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 DatabaseRuleset (required)
Body Parameter — The updated form of the database ruleset

Return type

DatabaseRuleset

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 Accept 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

Domain

Up
post /domains
Create domain [INCUBATING] (createDomain)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Request body

body Domain (required)
Body Parameter — The domain to create

Return type

Domain

Example data

Content-Type: application/json
{
  "defaultAlgorithmCode" : "aeiou",
  "defaultTokenizationCode" : "aeiou",
  "createdBy" : "aeiou",
  "domainName" : "aeiou",
  "classification" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (deleteDomain)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

400

Bad request

404

Not found

Up
get /domains
Get all domains [INCUBATING] (getAllDomains)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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

DomainList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "defaultAlgorithmCode" : "aeiou",
    "defaultTokenizationCode" : "aeiou",
    "createdBy" : "aeiou",
    "domainName" : "aeiou",
    "classification" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (getDomain)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

domainName (required)
Path Parameter — The name of the domain to get

Return type

Domain

Example data

Content-Type: application/json
{
  "defaultAlgorithmCode" : "aeiou",
  "defaultTokenizationCode" : "aeiou",
  "createdBy" : "aeiou",
  "domainName" : "aeiou",
  "classification" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 [INCUBATING] (updateDomain)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Path parameters

domainName (required)
Path Parameter — The name of the domain to update

Request body

body Domain (required)
Body Parameter — The updated domain

Return type

Domain

Example data

Content-Type: application/json
{
  "defaultAlgorithmCode" : "aeiou",
  "defaultTokenizationCode" : "aeiou",
  "createdBy" : "aeiou",
  "domainName" : "aeiou",
  "classification" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success Domain

400

Bad request

404

Not found

EncryptionKey

Up
put /encryptionKey
Generate a new encryption key for the masking engine (generateEncryptionKey)

Return type

AsyncTask

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success AsyncTask

401

Unauthorized access

Environment

Up
post /environments
Create environment (createEnvironment)

Request body

body Environment (required)
Body Parameter — The environment to create

Return type

Environment

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "application" : "aeiou",
  "purpose" : "aeiou",
  "environmentName" : "aeiou",
  "isWorkflowEnabled" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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

Up
get /environments
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

Return type

EnvironmentList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "environmentId" : 123,
    "application" : "aeiou",
    "purpose" : "aeiou",
    "environmentName" : "aeiou",
    "isWorkflowEnabled" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

Environment

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "application" : "aeiou",
  "purpose" : "aeiou",
  "environmentName" : "aeiou",
  "isWorkflowEnabled" : true
}

Produces

This API call produces the following media types according to the Accept 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 Environment (required)
Body Parameter — The updated environment

Return type

Environment

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "application" : "aeiou",
  "purpose" : "aeiou",
  "environmentName" : "aeiou",
  "isWorkflowEnabled" : true
}

Produces

This API call produces the following media types according to the Accept 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

Execution

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

Return type

Execution

Example data

Content-Type: application/json
{
  "targetConnectorId" : 123,
  "executionId" : 123,
  "jobId" : 123,
  "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 Accept 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
post /executions
Create execution (createExecution)

Request body

body Execution (required)
Body Parameter — The execution to create

Return type

Execution

Example data

Content-Type: application/json
{
  "targetConnectorId" : 123,
  "executionId" : 123,
  "jobId" : 123,
  "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 Accept 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

Up
get /executions
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

Return type

ExecutionList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "targetConnectorId" : 123,
    "executionId" : 123,
    "jobId" : 123,
    "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 Accept 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

Execution

Example data

Content-Type: application/json
{
  "targetConnectorId" : 123,
  "executionId" : 123,
  "jobId" : 123,
  "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 Accept 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

ExecutionComponent

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

ExecutionComponentList

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 Accept 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

ExecutionEvent

Up
get /execution-events
Get all execution events [INCUBATING] (getAllExecutionEvents)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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

ExecutionEventList

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 Accept 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

FileConnector

Up
post /file-connectors
Create file connector (createFileConnector)

Request body

body FileConnector (required)
Body Parameter — The file connector to create

Return type

FileConnector

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "fileConnectorId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  },
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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
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

FileConnectorList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "environmentId" : 123,
    "fileConnectorId" : 123,
    "connectorName" : "aeiou",
    "connectionInfo" : {
      "path" : "aeiou",
      "password" : "aeiou",
      "connectionMode" : "aeiou",
      "port" : 123,
      "sshKey" : "aeiou",
      "loginName" : "aeiou",
      "host" : "aeiou"
    },
    "fileType" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

FileConnector

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "fileConnectorId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  },
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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)

Path parameters

fileConnectorId (required)
Path Parameter — The ID of the file connector to test format: int32

Return type

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 FileConnector (required)
Body Parameter — The file connector to test

Return type

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 FileConnector (required)
Body Parameter — The updated file connector

Return type

FileConnector

Example data

Content-Type: application/json
{
  "environmentId" : 123,
  "fileConnectorId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  },
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

FileDownload

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:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success File

400

Bad request

401

Unauthorized access

404

Not found

FileFieldMetadata

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

FileFieldMetadataList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "fieldPositionNumber" : 123,
    "isProfilerWritable" : true,
    "fileFormatId" : 123,
    "fieldName" : "aeiou",
    "notes" : "aeiou",
    "fileFieldMetadataId" : 123,
    "dateFormat" : "aeiou",
    "domainName" : "aeiou",
    "isMasked" : true,
    "algorithmName" : "aeiou",
    "fieldLength" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

FileFieldMetadata

Example data

Content-Type: application/json
{
  "fieldPositionNumber" : 123,
  "isProfilerWritable" : true,
  "fileFormatId" : 123,
  "fieldName" : "aeiou",
  "notes" : "aeiou",
  "fileFieldMetadataId" : 123,
  "dateFormat" : "aeiou",
  "domainName" : "aeiou",
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "fieldLength" : 123
}

Produces

This API call produces the following media types according to the Accept 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 FileFieldMetadata (required)
Body Parameter — The updated file field metadata

Return type

FileFieldMetadata

Example data

Content-Type: application/json
{
  "fieldPositionNumber" : 123,
  "isProfilerWritable" : true,
  "fileFormatId" : 123,
  "fieldName" : "aeiou",
  "notes" : "aeiou",
  "fileFieldMetadataId" : 123,
  "dateFormat" : "aeiou",
  "domainName" : "aeiou",
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "fieldLength" : 123
}

Produces

This API call produces the following media types according to the Accept 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

FileFormat

Up
post /file-formats
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

FileFormat

Example data

Content-Type: application/json
{
  "fileFormatId" : 123,
  "fileFormatName" : "aeiou",
  "fileFormatType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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-formats
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

FileFormatList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "fileFormatId" : 123,
    "fileFormatName" : "aeiou",
    "fileFormatType" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

FileFormat

Example data

Content-Type: application/json
{
  "fileFormatId" : 123,
  "fileFormatName" : "aeiou",
  "fileFormatType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

FileMetadata

Up
post /file-metadata
Create file metadata (createFileMetadata)

Request body

body FileMetadata (required)
Body Parameter — The file metadata to create

Return type

FileMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "fileName" : "aeiou",
  "fileFormatId" : 123,
  "fileMetadataId" : 123,
  "enclosure" : "aeiou",
  "nameIsRegularExpression" : true,
  "delimiter" : "aeiou",
  "endOfRecord" : "aeiou",
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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-metadata
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

FileMetadataList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "rulesetId" : 123,
    "fileName" : "aeiou",
    "fileFormatId" : 123,
    "fileMetadataId" : 123,
    "enclosure" : "aeiou",
    "nameIsRegularExpression" : true,
    "delimiter" : "aeiou",
    "endOfRecord" : "aeiou",
    "fileType" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

FileMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "fileName" : "aeiou",
  "fileFormatId" : 123,
  "fileMetadataId" : 123,
  "enclosure" : "aeiou",
  "nameIsRegularExpression" : true,
  "delimiter" : "aeiou",
  "endOfRecord" : "aeiou",
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 FileMetadata (required)
Body Parameter — Updated fileMetadata object

Return type

FileMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "fileName" : "aeiou",
  "fileFormatId" : 123,
  "fileMetadataId" : 123,
  "enclosure" : "aeiou",
  "nameIsRegularExpression" : true,
  "delimiter" : "aeiou",
  "endOfRecord" : "aeiou",
  "fileType" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

FileRuleset

Up
post /file-rulesets
Create file ruleset (createFileRuleset)

Request body

body FileRuleset (required)
Body Parameter — The file ruleset to create

Return type

FileRuleset

Example data

Content-Type: application/json
{
  "fileConnectorId" : 123,
  "rulesetName" : "aeiou",
  "fileRulesetId" : 123
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 /file-rulesets
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

FileRulesetList

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 Accept 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

FileRuleset

Example data

Content-Type: application/json
{
  "fileConnectorId" : 123,
  "rulesetName" : "aeiou",
  "fileRulesetId" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success FileRuleset

401

Unauthorized access

404

Not found

FileUpload

Up
delete /file-uploads
Delete all file uploads (deleteAllFileUploads)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

400

Bad request

401

Unauthorized access

Up
post /file-uploads
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:

Form parameters

file (required)
Form Parameter — The file to be uploaded.

Return type

FileUpload

Example data

Content-Type: application/json
{
  "fileReferenceId" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success FileUpload

401

Unauthorized access

409

Conflict

Logging

Up
get /application-logs
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

LogFileInfoList

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success LogFileInfoList

401

Unauthorized access

Up
get /audit-logs
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

AuditLogList

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success AuditLogList

401

Unauthorized access

Login

Up
post /login
Log in to the Masking Engine (login)

Request body

login Login (required)
Body Parameter — The login object

Return type

LoginResponse

Example data

Content-Type: application/json
{
  "Authorization" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Success LoginResponse

401

Unauthorized access

Up
put /logout
Log out of the Masking Engine (logout)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

401

Unauthorized access

MainframeDatasetConnector

Up
post /mainframe-dataset-connectors
Create Mainframe Dataset connector (createMainframeDatasetConnector)

Request body

Body Parameter — The Mainframe Dataset connector to create

Return type

MainframeDatasetConnector

Example data

Content-Type: application/json
{
  "mainframe-datasetConnectorId" : 123,
  "environmentId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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

MainframeDatasetConnectorList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "mainframe-datasetConnectorId" : 123,
    "environmentId" : 123,
    "connectorName" : "aeiou",
    "connectionInfo" : {
      "path" : "aeiou",
      "password" : "aeiou",
      "connectionMode" : "aeiou",
      "port" : 123,
      "sshKey" : "aeiou",
      "loginName" : "aeiou",
      "host" : "aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetConnector

Example data

Content-Type: application/json
{
  "mainframe-datasetConnectorId" : 123,
  "environmentId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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)

Path parameters

mainframeDatasetConnectorId (required)
Path Parameter — The ID of the Mainframe Dataset connector to test format: int32

Return type

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

TestConnectorResponse

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetConnector

Example data

Content-Type: application/json
{
  "mainframe-datasetConnectorId" : 123,
  "environmentId" : 123,
  "connectorName" : "aeiou",
  "connectionInfo" : {
    "path" : "aeiou",
    "password" : "aeiou",
    "connectionMode" : "aeiou",
    "port" : 123,
    "sshKey" : "aeiou",
    "loginName" : "aeiou",
    "host" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetFieldMetadata

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

MainframeDatasetFieldMetadataList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "isProfilerWritable" : true,
    "fieldName" : "aeiou",
    "dateFormat" : "aeiou",
    "domainName" : "aeiou",
    "mainframeDatasetFormatId" : 123,
    "isMasked" : true,
    "algorithmName" : "aeiou",
    "mainframeDatasetFieldMetadataId" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetFieldMetadata

Example data

Content-Type: application/json
{
  "isProfilerWritable" : true,
  "fieldName" : "aeiou",
  "dateFormat" : "aeiou",
  "domainName" : "aeiou",
  "mainframeDatasetFormatId" : 123,
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "mainframeDatasetFieldMetadataId" : 123
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetFieldMetadata

Example data

Content-Type: application/json
{
  "isProfilerWritable" : true,
  "fieldName" : "aeiou",
  "dateFormat" : "aeiou",
  "domainName" : "aeiou",
  "mainframeDatasetFormatId" : 123,
  "isMasked" : true,
  "algorithmName" : "aeiou",
  "mainframeDatasetFieldMetadataId" : 123
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetFormat

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

MainframeDatasetFormat

Example data

Content-Type: application/json
{
  "mainframeDatasetFormatName" : "aeiou",
  "mainframeDatasetFormatId" : 123
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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

MainframeDatasetFormatList

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 Accept 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

MainframeDatasetFormat

Example data

Content-Type: application/json
{
  "mainframeDatasetFormatName" : "aeiou",
  "mainframeDatasetFormatId" : 123
}

Produces

This API call produces the following media types according to the Accept 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

MainframeDatasetMetadata

Up
post /mainframe-dataset-metadata
Create Mainframe Dataset metadata (createMainframeDatasetMetadata)

Request body

body MainframeDatasetMetadata (required)
Body Parameter — The Mainframe Dataset metadata to create

Return type

MainframeDatasetMetadata

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 Accept 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 Accept 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

MainframeDatasetMetadataList

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 Accept 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

MainframeDatasetMetadata

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 Accept 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 MainframeDatasetMetadata (required)
Body Parameter — The updated Mainframe Dataset metadata

Return type

MainframeDatasetMetadata

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 Accept 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

MainframeDatasetRuleset

Up
post /mainframe-dataset-rulesets
Create Mainframe Dataset ruleset (createMainframeDatasetRuleset)

Request body

body MainframeDatasetRuleset (required)
Body Parameter — The Mainframe Dataset ruleset to create

Return type

MainframeDatasetRuleset

Example data

Content-Type: application/json
{
  "mainframeDatasetConnectorId" : 123,
  "rulesetName" : "aeiou",
  "mainframeDatasetRulesetId" : 123
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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

MainframeDatasetRulesetList

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 Accept 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

MainframeDatasetRuleset

Example data

Content-Type: application/json
{
  "mainframeDatasetConnectorId" : 123,
  "rulesetName" : "aeiou",
  "mainframeDatasetRulesetId" : 123
}

Produces

This API call produces the following media types according to the Accept 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

MaskingJob

Up
post /masking-jobs
Create masking job (createMaskingJob)

Request body

body MaskingJob (required)
Body Parameter — The masking job to create

Return type

MaskingJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 Accept 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 /masking-jobs
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

MaskingJobList

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,
      "bulkData" : true,
      "dropIndexes" : true,
      "truncateTables" : true,
      "commitSize" : 123,
      "prescript" : {
        "contents" : "aeiou",
        "name" : "aeiou"
      }
    },
    "multiTenant" : true,
    "failImmediately" : true,
    "feedbackSize" : 123,
    "maxMemory" : 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 Accept 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

MaskingJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 MaskingJob (required)
Body Parameter — The updated masking job

Return type

MaskingJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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

NonConformantDataSample

Up
get /non-conformant-data-sample
Get all non-conformant data samples [INCUBATING] (getAllNonConformantDataSamples)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

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

NonConformantDataSampleList

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 Accept 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

ProfileExpression

Up
post /profile-expressions
Create profile expression (createProfileExpression)

Request body

body ProfileExpression (required)
Body Parameter — The profile expression to create

Return type

ProfileExpression

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 Accept 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 Accept 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

ProfileExpressionList

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 Accept 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

ProfileExpression

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 Accept 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 ProfileExpression (required)
Body Parameter — The updated profile expression

Return type

ProfileExpression

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 Accept 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

ProfileJob

Up
post /profile-jobs
Create profile job (createProfileJob)

Request body

body ProfileJob (required)
Body Parameter — The profile job to create

Return type

ProfileJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "multiTenant" : true,
  "multipleProfilerCheck" : true,
  "profileJobId" : 123,
  "feedbackSize" : 123,
  "maxMemory" : 123,
  "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 Accept 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 Accept 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 /profile-jobs
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

ProfileJobList

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,
    "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 Accept 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

ProfileJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "multiTenant" : true,
  "multipleProfilerCheck" : true,
  "profileJobId" : 123,
  "feedbackSize" : 123,
  "maxMemory" : 123,
  "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 Accept 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 ProfileJob (required)
Body Parameter — The updated profile job

Return type

ProfileJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "multiTenant" : true,
  "multipleProfilerCheck" : true,
  "profileJobId" : 123,
  "feedbackSize" : 123,
  "maxMemory" : 123,
  "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 Accept 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

ProfileSet

Up
post /profile-sets
Create profile set (createProfileSet)

Request body

body ProfileSet (required)
Body Parameter — The profile set to create

Return type

ProfileSet

Example data

Content-Type: application/json
{
  "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 Accept 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 Accept 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-sets
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

ProfileSetList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "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 Accept 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

ProfileSet

Example data

Content-Type: application/json
{
  "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 Accept 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 ProfileSet (required)
Body Parameter — The updated profile set

Return type

ProfileSet

Example data

Content-Type: application/json
{
  "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 Accept 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

ReidentificationJob

Up
post /reidentification-jobs
Create re-identification job (createReidentificationJob)

Request body

body ReidentificationJob (required)
Body Parameter — The re-identification job to create

Return type

ReidentificationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 Accept 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

ReidentificationJobList

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,
      "bulkData" : true,
      "dropIndexes" : true,
      "truncateTables" : true,
      "commitSize" : 123,
      "prescript" : {
        "contents" : "aeiou",
        "name" : "aeiou"
      }
    },
    "multiTenant" : true,
    "failImmediately" : true,
    "feedbackSize" : 123,
    "maxMemory" : 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 Accept 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

ReidentificationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 ReidentificationJob (required)
Body Parameter — The updated re-identification job

Return type

ReidentificationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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

Role

Up
post /roles
Create role (createRole)

Request body

body Role (required)
Body Parameter — The role to create

Return type

Role

Example data

Content-Type: application/json
{
  "roleId" : 123,
  "maskingJob" : "",
  "ruleset" : "",
  "tokenizeJob" : "",
  "inventory" : "",
  "scheduler" : "",
  "environment" : {
    "view" : true,
    "import" : true,
    "create" : true,
    "update" : true,
    "run" : true,
    "copy" : true,
    "delete" : true,
    "export" : true
  },
  "profileJob" : "",
  "connector" : "",
  "domain" : "",
  "roleName" : "aeiou",
  "reidentifyJob" : "",
  "user" : "",
  "fileFormat" : "",
  "algorithm" : "",
  "profileExpression" : "",
  "profileSet" : ""
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 /roles
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

RoleList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "roleId" : 123,
    "maskingJob" : "",
    "ruleset" : "",
    "tokenizeJob" : "",
    "inventory" : "",
    "scheduler" : "",
    "environment" : {
      "view" : true,
      "import" : true,
      "create" : true,
      "update" : true,
      "run" : true,
      "copy" : true,
      "delete" : true,
      "export" : true
    },
    "profileJob" : "",
    "connector" : "",
    "domain" : "",
    "roleName" : "aeiou",
    "reidentifyJob" : "",
    "user" : "",
    "fileFormat" : "",
    "algorithm" : "",
    "profileExpression" : "",
    "profileSet" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success RoleList

400

Bad request

401

Unauthorized access

Up
get /roles/{roleId}
Get role by ID (getRoleById)

Path parameters

roleId (required)
Path Parameter — The ID of the role to get format: int32

Return type

Role

Example data

Content-Type: application/json
{
  "roleId" : 123,
  "maskingJob" : "",
  "ruleset" : "",
  "tokenizeJob" : "",
  "inventory" : "",
  "scheduler" : "",
  "environment" : {
    "view" : true,
    "import" : true,
    "create" : true,
    "update" : true,
    "run" : true,
    "copy" : true,
    "delete" : true,
    "export" : true
  },
  "profileJob" : "",
  "connector" : "",
  "domain" : "",
  "roleName" : "aeiou",
  "reidentifyJob" : "",
  "user" : "",
  "fileFormat" : "",
  "algorithm" : "",
  "profileExpression" : "",
  "profileSet" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success Role

401

Unauthorized access

404

Not found

Up
put /roles/{roleId}
Update role by ID (updateRole)

Path parameters

roleId (required)
Path Parameter — The ID of the role to update format: int32

Request body

body Role (required)
Body Parameter — The updated role

Return type

Role

Example data

Content-Type: application/json
{
  "roleId" : 123,
  "maskingJob" : "",
  "ruleset" : "",
  "tokenizeJob" : "",
  "inventory" : "",
  "scheduler" : "",
  "environment" : {
    "view" : true,
    "import" : true,
    "create" : true,
    "update" : true,
    "run" : true,
    "copy" : true,
    "delete" : true,
    "export" : true
  },
  "profileJob" : "",
  "connector" : "",
  "domain" : "",
  "roleName" : "aeiou",
  "reidentifyJob" : "",
  "user" : "",
  "fileFormat" : "",
  "algorithm" : "",
  "profileExpression" : "",
  "profileSet" : ""
}

Produces

This API call produces the following media types according to the Accept 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

SshKey

Up
post /ssh-keys
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

SshKey

Example data

Content-Type: application/json
{
  "sshKeyName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 /ssh-keys
Get all SSH keys (getAllSshKeys)

Return type

array[SshKey]

Example data

Content-Type: application/json
[ {
  "sshKeyName" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Sync

Up
post /export-async
Export masking object (asyncExport)
Export masking objects

Request body

body ExportObjectMetadata (required)
Body Parameter — The identifier for the masking object to export

Return type

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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
post /import-async
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

AsyncTask

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

Produces

This API call produces the following media types according to the Accept 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
post /export
Export masking object (export)
Export masking objects

Request body

body ExportObjectMetadata (required)
Body Parameter — The identifier for the masking object to export

Return type

ExportObject

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 Accept 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

Up
get /syncable-objects
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

ExportObjectMetadataList

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 Accept 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
post /import
Import masking objects (importObject)
Import masking objects

Request body

body ExportObject (required)
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

array[ImportObjectMetadata]

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 Accept 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

Up
delete /export-async
Delete all export documents from /async-export tasks (purgeExportDirectory)

Produces

This API call produces the following media types according to the Accept 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 /import-async
Delete all import documents from /async-import tasks (purgeImportDirectory)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

400

Bad request

401

Unauthorized access

SystemInformation

Up
get /system-information
Get system information [INCUBATING] (getSystemInformation)
Incubating endpoints are subject to changes that may or may not maintain backwards-compatibility.

Return type

SystemInformation

Example data

Content-Type: application/json
{
  "build" : "aeiou",
  "patentNumbers" : [ "aeiou" ],
  "version" : "aeiou",
  "latestGlobalKeyResetTime" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success SystemInformation

TableMetadata

Up
post /table-metadata
Create table metadata (createTableMetadata)

Request body

body TableMetadata (required)
Body Parameter — The table metadata to create

Return type

TableMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "whereClause" : "aeiou",
  "havingClause" : "aeiou",
  "customSql" : "aeiou",
  "keyColumn" : "aeiou",
  "tableMetadataId" : 123,
  "tableName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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
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

Return type

TableMetadataList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "rulesetId" : 123,
    "whereClause" : "aeiou",
    "havingClause" : "aeiou",
    "customSql" : "aeiou",
    "keyColumn" : "aeiou",
    "tableMetadataId" : 123,
    "tableName" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

TableMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "whereClause" : "aeiou",
  "havingClause" : "aeiou",
  "customSql" : "aeiou",
  "keyColumn" : "aeiou",
  "tableMetadataId" : 123,
  "tableName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 TableMetadata (required)
Body Parameter — The updated table metadata

Return type

TableMetadata

Example data

Content-Type: application/json
{
  "rulesetId" : 123,
  "whereClause" : "aeiou",
  "havingClause" : "aeiou",
  "customSql" : "aeiou",
  "keyColumn" : "aeiou",
  "tableMetadataId" : 123,
  "tableName" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

TokenizationJob

Up
post /tokenization-jobs
Create tokenization job (createTokenizationJob)

Request body

body TokenizationJob (required)
Body Parameter — The tokenization job to create

Return type

TokenizationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 Accept 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

TokenizationJobList

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,
      "bulkData" : true,
      "dropIndexes" : true,
      "truncateTables" : true,
      "commitSize" : 123,
      "prescript" : {
        "contents" : "aeiou",
        "name" : "aeiou"
      }
    },
    "multiTenant" : true,
    "failImmediately" : true,
    "feedbackSize" : 123,
    "maxMemory" : 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 Accept 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

TokenizationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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 TokenizationJob (required)
Body Parameter — The updated tokenization job

Return type

TokenizationJob

Example data

Content-Type: application/json
{
  "jobName" : "aeiou",
  "rulesetId" : 123,
  "minMemory" : 123,
  "databaseMaskingOptions" : {
    "disableTriggers" : true,
    "numOutputThreadsPerStream" : 123,
    "disableConstraints" : true,
    "postscript" : "",
    "batchUpdate" : true,
    "bulkData" : true,
    "dropIndexes" : true,
    "truncateTables" : true,
    "commitSize" : 123,
    "prescript" : {
      "contents" : "aeiou",
      "name" : "aeiou"
    }
  },
  "multiTenant" : true,
  "failImmediately" : true,
  "feedbackSize" : 123,
  "maxMemory" : 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 Accept 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

User

Up
post /users
Create user (createUser)

Request body

body User (required)
Body Parameter — The user to create

Return type

User

Example data

Content-Type: application/json
{
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "password" : "aeiou",
  "nonAdminProperties" : {
    "roleId" : 123,
    "environmentIds" : [ 123 ]
  },
  "apiAccess" : true,
  "showWelcome" : true,
  "isLocked" : true,
  "isAdmin" : true,
  "userName" : "aeiou",
  "userId" : 123,
  "email" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 /users
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

UserList

Example data

Content-Type: application/json
{
  "_pageInfo" : {
    "total" : 123456789,
    "numberOnPage" : 123456789
  },
  "responseList" : [ {
    "firstName" : "aeiou",
    "lastName" : "aeiou",
    "password" : "aeiou",
    "nonAdminProperties" : {
      "roleId" : 123,
      "environmentIds" : [ 123 ]
    },
    "apiAccess" : true,
    "showWelcome" : true,
    "isLocked" : true,
    "isAdmin" : true,
    "userName" : "aeiou",
    "userId" : 123,
    "email" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success UserList

400

Bad request

401

Unauthorized access

Up
get /users/{userId}
Get user by ID (getUserById)

Path parameters

userId (required)
Path Parameter — The ID of the user to get format: int32

Return type

User

Example data

Content-Type: application/json
{
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "password" : "aeiou",
  "nonAdminProperties" : {
    "roleId" : 123,
    "environmentIds" : [ 123 ]
  },
  "apiAccess" : true,
  "showWelcome" : true,
  "isLocked" : true,
  "isAdmin" : true,
  "userName" : "aeiou",
  "userId" : 123,
  "email" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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
put /users/{userId}
Update user by ID (updateUserById)

Path parameters

userId (required)
Path Parameter — The ID of the user to update format: int32

Request body

body User (required)
Body Parameter — The updated user

Return type

User

Example data

Content-Type: application/json
{
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "password" : "aeiou",
  "nonAdminProperties" : {
    "roleId" : 123,
    "environmentIds" : [ 123 ]
  },
  "apiAccess" : true,
  "showWelcome" : true,
  "isLocked" : true,
  "isAdmin" : true,
  "userName" : "aeiou",
  "userId" : 123,
  "email" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Algorithm
  2. AlgorithmExtension
  3. AlgorithmIdentifier
  4. AlgorithmList
  5. Application
  6. ApplicationList
  7. ApplicationSettings
  8. ApplicationSettingsList
  9. AsyncTask
  10. AsyncTaskList
  11. AuditLog
  12. AuditLogList
  13. BinaryLookupExtension
  14. ColumnMetadata
  15. ColumnMetadataList
  16. ConnectionInfo
  17. DataCleansingExtension
  18. DatabaseConnector
  19. DatabaseConnectorList
  20. DatabaseMaskingOptions
  21. DatabaseRuleset
  22. DatabaseRulesetList
  23. Domain
  24. DomainList
  25. Environment
  26. EnvironmentList
  27. ErrorMessage
  28. Execution
  29. ExecutionComponent
  30. ExecutionComponentList
  31. ExecutionEvent
  32. ExecutionEventList
  33. ExecutionList
  34. ExportObject
  35. ExportObjectMetadata
  36. ExportObjectMetadataList
  37. ExportResponseMetadata
  38. FileConnector
  39. FileConnectorList
  40. FileFieldMetadata
  41. FileFieldMetadataList
  42. FileFormat
  43. FileFormatList
  44. FileMetadata
  45. FileMetadataList
  46. FileRuleset
  47. FileRulesetList
  48. FileUpload
  49. FreeTextRedactionExtension
  50. ImportObjectMetadata
  51. IntegerIdentifier
  52. KeyIdentifier
  53. LogFileInfo
  54. LogFileInfoList
  55. LogStatement
  56. Login
  57. LoginResponse
  58. MainframeDatasetConnector
  59. MainframeDatasetConnectorList
  60. MainframeDatasetFieldMetadata
  61. MainframeDatasetFieldMetadataList
  62. MainframeDatasetFormat
  63. MainframeDatasetFormatList
  64. MainframeDatasetMetadata
  65. MainframeDatasetMetadataList
  66. MainframeDatasetRuleset
  67. MainframeDatasetRulesetList
  68. MappingExtension
  69. MappletExtension
  70. MaskingJob
  71. MaskingJobList
  72. MaskingJobScript
  73. MinMaxExtension
  74. NonAdminProperties
  75. NonConformantDataSample
  76. NonConformantDataSampleList
  77. NonConformantDataSamples
  78. ObjectIdentifier
  79. OnTheFlyMaskingSource
  80. PageInfo
  81. Privilege
  82. ProfileExpression
  83. ProfileExpressionList
  84. ProfileJob
  85. ProfileJobList
  86. ProfileSet
  87. ProfileSetList
  88. ReidentificationJob
  89. ReidentificationJobList
  90. Role
  91. RoleList
  92. SecureLookupExtension
  93. SegmentMappingExtension
  94. SegmentMappingPreservedRange
  95. SegmentMappingSegment
  96. SshKey
  97. StringIdentifier
  98. SystemInformation
  99. TableMetadata
  100. TableMetadataBulkInput
  101. TableMetadataList
  102. TestConnectorResponse
  103. TokenizationExtension
  104. TokenizationJob
  105. TokenizationJobList
  106. User
  107. UserList

Algorithm - Up

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
String The type of algorithm
Enum:
BINARY_LOOKUP
CLEANSING
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
algorithmExtension (optional)

AlgorithmExtension - Up

AlgorithmIdentifier - Up

algorithmName

AlgorithmList - Up

_pageInfo (optional)
responseList (optional)

Application - Up

applicationName
String The name of this Application. Note that it must be unique.

ApplicationList - Up

_pageInfo (optional)
responseList (optional)

ApplicationSettings - Up

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

ApplicationSettingsList - Up

_pageInfo (optional)
responseList (optional)

AsyncTask - Up

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.
Enum:
ALGORITHM_CREATE
ALGORITHM_UPDATE
ENCRYPTION_KEY_CREATE
EXPORT
IMPORT
RULESET_REFRESH
TABLE_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.
Enum:
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.

AsyncTaskList - Up

_pageInfo (optional)
responseList (optional)

AuditLog - Up

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.
Enum:
CANCEL
CREATE
DELETE
EDIT
EXPORT
GET
GET_ALL
IMPORT
LOCK
LOGIN
LOGOUT
RUN
TEST
UNLOCK
target (optional)
String The type object or operation that the action occurred on for this Audit Log entry.
Enum:
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_EVENT
FILE_CONNECTOR
FILE_DOWNLOAD
FILE_FIELD_METADATA
FILE_FORMAT
FILE_METADATA
FILE_RULESET
FILE_UPLOAD
INSTALLATION
LDAP
MAINFRAME_DATASET_CONNECTOR
MAINFRAME_DATASET_FIELD_METADATA
MAINFRAME_DATASET_FORMAT
MAINFRAME_DATASET_METADATA
MAINFRAME_DATASET_RULESET
MASKING_JOB
NON_CONFORMING_DATA_SAMPLE
PROFILE_EXPRESSION
PROFILE_JOB
PROFILE_SET
REIDENTIFICATION_JOB
ROLE
SSH_KEY
SSO
SYNCABLE_OBJECT
SYSTEM_INFORMATION
TABLE_METADATA
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.
Enum:
ATTEMPTED
FAILED
SUCCEEDED
ipAddress (optional)
String The IP address of the user who performed the action for this Audit Log entry.

AuditLogList - Up

_pageInfo (optional)
responseList (optional)

BinaryLookupExtension - Up

fileReferenceIds (optional)
array[String] A list of file reference UUID 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

ColumnMetadata - Up

columnMetadataId (optional)
Integer The ID number of the column metadata. This field is auto-generated by the Masking Engine. format: int32
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.
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 (optional)
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.
xmlDataSource (optional)
String This field is used to indicate where XML content should be pulled from. This field is only relevant when using XML data for a CLOB column, otherwise it should be left null.
Enum:
TABLE
FILE_FORMAT
xmlFileFormatId (optional)
Integer This field is used to reference an XML file format. This field is only relevant when the user-defined 'xmlDataSource' is FILE_FORMAT. format: int32

ColumnMetadataList - Up

_pageInfo (optional)
responseList (optional)

ConnectionInfo - Up

connectionMode
String This field denotes which connection mode the connector will use to connect to the underlying files.
Enum:
FTP
SFTP
path
String This field applies to all connection modes, and it is the file system path to the desired files.
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.

DataCleansingExtension - Up

fileReferenceId (optional)
String The reference UUID 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

DatabaseConnector - Up

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.
Enum:
AURORA_POSTGRES
DB2
DB2_ISERIES
DB2_MAINFRAME
GENERIC
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', 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.

DatabaseConnectorList - Up

_pageInfo (optional)
responseList (optional)

DatabaseMaskingOptions - Up

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.
bulkData (optional)
Boolean This field determines whether the database masking phase will be done via bulk data. The process for bulk data masking is to export the data being masked into a file, read the data file into memory, mask the data file in memory, and then import the masked data from the file back into the database. This process typically results in better masking job performance than normal, but the masking job must consume a very large amount of memory during the process, so this option should be used with caution. Note that this option is not applicable to OnTheFly masking jobs.
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)
MaskingJobScript The SQL script that runs before the job executes.
postscript (optional)
MaskingJobScript The SQL script that runs after the job executes.

DatabaseRuleset - Up

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.

DatabaseRulesetList - Up

_pageInfo (optional)
responseList (optional)

Domain - Up

domainName
classification
Enum:
CUSTOMER
EMPLOYEE
COMPANY
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

DomainList - Up

_pageInfo (optional)
responseList (optional)

Environment - Up

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.
application
String The name of the Application that this Environment is associated with. Note that the Application must already exist when attempting to create the Environment.
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.
Enum:
MASK
TOKENIZE
isWorkflowEnabled (optional)
Boolean True to have workflow enabled, false to leave the workflow disabled.

EnvironmentList - Up

_pageInfo (optional)
responseList (optional)

ErrorMessage - Up

errorMessage
String The error message.

Execution - Up

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
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.
Enum:
FAILED
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. 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

ExecutionComponent - Up

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.
Enum:
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. 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

ExecutionComponentList - Up

_pageInfo (optional)
responseList (optional)

ExecutionEvent - Up

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.
Enum:
JOB_ABORTED
UNMASKED_DATA
MASKING_FALLBACK
severity (optional)
String The severity of the execution event.
Enum:
INFO
WARNING
CRITICAL
cause (optional)
String The cause of the execution event.
Enum:
UNHANDLED_EXCEPTION
IGNORED_EXCEPTION
PATTERN_MATCH_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.

ExecutionEventList - Up

_pageInfo (optional)
responseList (optional)

ExecutionList - Up

_pageInfo (optional)
responseList (optional)

ExportObject - Up

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

ExportObjectMetadata - Up

objectIdentifier
objectType
String Type of object to export
Enum:
ALGORITHM_REFERENCE
APPLICATION_SETTINGS
BINARYLOOKUP
CLEANSING
DATABASE_CONNECTOR
DATABASE_RULESET
DATE_SHIFT
DOMAIN
DOMAIN_REFERENCE
FILE_CONNECTOR
FILE_FORMAT
FILE_RULESET
GLOBAL_OBJECT
KEY
LOOKUP
MAPPLET
MASKING_JOB
MIN_MAX
PROFILE_EXPRESSION
PROFILE_EXPRESSION_REFERENCE
PROFILE_JOB
PROFILE_SET
PROFILE_SET_REFERENCE
REDACTION
SEGMENT
SOURCE_DATABASE_CONNECTOR
SOURCE_FILE_CONNECTOR
TOKENIZATION
revisionHash (optional)
String Global comparison value for syncable object

ExportObjectMetadataList - Up

_pageInfo (optional)
responseList (optional)

ExportResponseMetadata - Up

exportHost (optional)
exportDate (optional)
requestedObjectList (optional)
exportedObjectList (optional)

FileConnector - Up

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.
Enum:
DELIMITED
EXCEL
FIXED_WIDTH
XML
connectionInfo
ConnectionInfo This field object contains the information needed to connect to the underlying files.

FileConnectorList - Up

_pageInfo (optional)
responseList (optional)

FileFieldMetadata - Up

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
fieldLength (optional)
Integer The length of the file field, in number of characters, as determined by the associated file format. format: int32
fieldName (optional)
String The name of the file field, as determined by the associated file format.
fieldPositionNumber (optional)
Integer The position of the file field with respect to the other file fields, as determined by the associated file format. 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.
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.

FileFieldMetadataList - Up

_pageInfo (optional)
responseList (optional)

FileFormat - Up

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.
Enum:
DELIMITED
EXCEL
FIXED_WIDTH
XML

FileFormatList - Up

_pageInfo (optional)
responseList (optional)

FileMetadata - Up

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.
Enum:
DELIMITED
EXCEL
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.
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.

FileMetadataList - Up

_pageInfo (optional)
responseList (optional)

FileRuleset - Up

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

FileRulesetList - Up

_pageInfo (optional)
responseList (optional)

FileUpload - Up

fileReferenceId (optional)
String The reference ID of the uploaded file. This reference ID can be used in a subsequent API request that requires a file.

FreeTextRedactionExtension - Up

blackListRedaction (optional)
Boolean Black list redaction if true, white list redaction if false.
lookupFileReferenceId (optional)
String The reference UUID 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.

ImportObjectMetadata - Up

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
Enum:
ALGORITHM_REFERENCE
APPLICATION_SETTINGS
BINARYLOOKUP
CLEANSING
DATABASE_CONNECTOR
DATABASE_RULESET
DATE_SHIFT
DOMAIN
DOMAIN_REFERENCE
FILE_CONNECTOR
FILE_FORMAT
FILE_RULESET
GLOBAL_OBJECT
KEY
LOOKUP
MAPPLET
MASKING_JOB
MIN_MAX
PROFILE_EXPRESSION
PROFILE_EXPRESSION_REFERENCE
PROFILE_JOB
PROFILE_SET
PROFILE_SET_REFERENCE
REDACTION
SEGMENT
SOURCE_DATABASE_CONNECTOR
SOURCE_FILE_CONNECTOR
TOKENIZATION
importStatus (optional)
Enum:
SUCCESS
FAILED
SKIPPED
failureMessage (optional)

KeyIdentifier - Up

keyId

LogFileInfo - Up

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.
Enum:
DEBUG
ERROR
INFO
WARN

LogFileInfoList - Up

_pageInfo (optional)
responseList (optional)

LogStatement - Up

logStatement
String The statement to inject into the Masking Engine logs.
logLevel
String The log level at which to inject the log statement.
Enum:
DEBUG
ERROR
INFO
WARN

Login - Up

username
String The username for logging into the Masking Engine.
password
String The password for logging into the Masking Engine.

LoginResponse - Up

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.

MainframeDatasetConnector - Up

mainframe-datasetConnectorId (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.

MainframeDatasetConnectorList - Up

_pageInfo (optional)
responseList (optional)

MainframeDatasetFieldMetadata - Up

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.
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.

MainframeDatasetFieldMetadataList - Up

_pageInfo (optional)
responseList (optional)

MainframeDatasetFormat - Up

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.

MainframeDatasetFormatList - Up

_pageInfo (optional)
responseList (optional)

MainframeDatasetMetadata - Up

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.
Enum:
FIXED_BLOCKED
VARIABLE_BLOCKED
nameIsRegularExpression (optional)
Boolean Whether or not this file name represents a regular expression.

MainframeDatasetMetadataList - Up

_pageInfo (optional)
responseList (optional)

MainframeDatasetRuleset - Up

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

MainframeDatasetRulesetList - Up

_pageInfo (optional)
responseList (optional)

MappingExtension - Up

fileReferenceId (optional)
String The reference UUID 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

MappletExtension - Up

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
fileReferenceId (optional)
String The reference UUID 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.

MaskingJob - Up

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
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.

MaskingJobList - Up

_pageInfo (optional)
responseList (optional)

MaskingJobScript - Up

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.

MinMaxExtension - Up

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.

NonAdminProperties - Up

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

NonConformantDataSample - Up

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

NonConformantDataSampleList - Up

_pageInfo (optional)
responseList (optional)

NonConformantDataSamples - Up

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

ObjectIdentifier - Up

OnTheFlyMaskingSource - Up

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.
Enum:
DATABASE
FILE
VSAM

PageInfo - Up

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

Privilege - Up

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.

ProfileExpression - Up

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).

ProfileExpressionList - Up

_pageInfo (optional)
responseList (optional)

ProfileJob - Up

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
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.

ProfileJobList - Up

_pageInfo (optional)
responseList (optional)

ProfileSet - Up

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
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.

ProfileSetList - Up

_pageInfo (optional)
responseList (optional)

ReidentificationJob - Up

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
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.

ReidentificationJobList - Up

_pageInfo (optional)
responseList (optional)

Role - Up

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)
Privilege Privileges for environments.
connector (optional)
Privilege Privileges for connectors.
ruleset (optional)
Privilege Privileges for rulesets.
inventory (optional)
Privilege Privileges for inventories.
profileJob (optional)
Privilege Privileges for profile jobs.
maskingJob (optional)
Privilege Privileges for masking jobs.
tokenizeJob (optional)
Privilege Privileges for tokenize jobs.
reidentifyJob (optional)
Privilege Privileges for re-identify jobs.
scheduler (optional)
Privilege Privileges for the job scheduler.
domain (optional)
Privilege Privileges for domains.
algorithm (optional)
Privilege Privileges for algorithms.
profileExpression (optional)
Privilege Privileges for profile expressions.
profileSet (optional)
Privilege Privileges for profile sets.
fileFormat (optional)
Privilege Privileges for file formats.
user (optional)
Privilege Privileges for users and roles.

RoleList - Up

_pageInfo (optional)
responseList (optional)

SecureLookupExtension - Up

fileReferenceId (optional)
String The reference UUID 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

SegmentMappingExtension - Up

preservedRanges (optional)
array[SegmentMappingPreservedRange] List of character {offset, length} values specifying ranges of the real value to preserve. Offsets begin at 0
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.
Enum:
DEFAULT
DONT_MASK
FAIL

SegmentMappingPreservedRange - Up

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

SegmentMappingSegment - Up

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

SshKey - Up

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.

StringIdentifier - Up

id

SystemInformation - Up

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)
array[String] The patent numbers for the Masking Engine.

TableMetadata - Up

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.

TableMetadataBulkInput - Up

tableMetadata

TableMetadataList - Up

_pageInfo (optional)
responseList (optional)

TestConnectorResponse - Up

response (optional)
String Success or failure of the connection test.

TokenizationExtension - Up

latestKeyResetTime (optional)
Date The last time the algorithm's key was randomized. This changes the masked results of the algorithm. format: date-time

TokenizationJob - Up

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
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.

TokenizationJobList - Up

_pageInfo (optional)
responseList (optional)

User - Up

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.
isLocked
Boolean True if a user is locked, set to false to unlock a locked user.
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. When SSO is disabled, the value is ignored and the user will be granted API access.

UserList - Up

_pageInfo (optional)
responseList (optional)