Skip to content

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.3.0.0).json
CC Engine APIs (2025.3.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0
https://help-api.delphix.com/masking/api/v5.1.43

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

license

Operations

login

Operations

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

Get all record type qualifiers

Request

Security
api_key
Query
record_type_idinteger(int32)

The ID of the record type whose record type qualifiers to get.

page_numberinteger(int64)

The page number for which to get record type qualifiers. This will default to the first page if excluded

Default 1
page_sizeinteger(int64)

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

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/record-type-qualifiers?record_type_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(RecordTypeQualifier)
Example: [{"recordTypeQualifierId":"3","recordTypeId":"1","pattern":"SSN","fileFieldMetadataId":"1"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create record type qualifier

Request

Security
api_key
Bodyapplication/jsonrequired

The record type qualifier to create

recordTypeIdinteger(int32)

The ID number of the record type that the record type qualifier refers to.

Example: "1"
patternstring<= 255 characters

The pattern to match against the record type field.

Example: "SSN"
fileFieldMetadataIdinteger(int32)

The ID of the record type field the record type qualifier refers to.

Example: "1"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/record-type-qualifiers \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "recordTypeQualifierId": "3",
    "recordTypeId": "1",
    "pattern": "SSN",
    "fileFieldMetadataId": "1"
  }'

Responses

Success

Bodyapplication/json
recordTypeQualifierIdinteger(int32)read-only

The ID number of the record type qualifier. This field is auto-generated by the Masking Engine.

Example: "3"
recordTypeIdinteger(int32)

The ID number of the record type that the record type qualifier refers to.

Example: "1"
patternstring<= 255 characters

The pattern to match against the record type field.

Example: "SSN"
fileFieldMetadataIdinteger(int32)

The ID of the record type field the record type qualifier refers to.

Example: "1"
Response
application/json
{
  "recordTypeQualifierId": "3",
  "recordTypeId": "1",
  "pattern": "SSN",
  "fileFieldMetadataId": "1"
}

Get record type qualifier by ID

Request

Security
api_key
Path
recordTypeQualifierIdinteger(int32)required

The ID of the record type qualifier to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/record-type-qualifiers/{recordTypeQualifierId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
recordTypeQualifierIdinteger(int32)read-only

The ID number of the record type qualifier. This field is auto-generated by the Masking Engine.

Example: "3"
recordTypeIdinteger(int32)

The ID number of the record type that the record type qualifier refers to.

Example: "1"
patternstring<= 255 characters

The pattern to match against the record type field.

Example: "SSN"
fileFieldMetadataIdinteger(int32)

The ID of the record type field the record type qualifier refers to.

Example: "1"
Response
application/json
{
  "recordTypeQualifierId": "3",
  "recordTypeId": "1",
  "pattern": "SSN",
  "fileFieldMetadataId": "1"
}

Update record type qualifier by ID

Request

Security
api_key
Path
recordTypeQualifierIdinteger(int32)required

The ID of the record type qualifier to update

Bodyapplication/jsonrequired

The record type qualifier body to update

recordTypeIdinteger(int32)

The ID number of the record type that the record type qualifier refers to.

Example: "1"
patternstring<= 255 characters

The pattern to match against the record type field.

Example: "SSN"
fileFieldMetadataIdinteger(int32)

The ID of the record type field the record type qualifier refers to.

Example: "1"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/record-type-qualifiers/{recordTypeQualifierId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "recordTypeQualifierId": "3",
    "recordTypeId": "1",
    "pattern": "SSN",
    "fileFieldMetadataId": "1"
  }'

Responses

Success

Bodyapplication/json
recordTypeQualifierIdinteger(int32)read-only

The ID number of the record type qualifier. This field is auto-generated by the Masking Engine.

Example: "3"
recordTypeIdinteger(int32)

The ID number of the record type that the record type qualifier refers to.

Example: "1"
patternstring<= 255 characters

The pattern to match against the record type field.

Example: "SSN"
fileFieldMetadataIdinteger(int32)

The ID of the record type field the record type qualifier refers to.

Example: "1"
Response
application/json
{
  "recordTypeQualifierId": "3",
  "recordTypeId": "1",
  "pattern": "SSN",
  "fileFieldMetadataId": "1"
}

Delete record type qualifier by ID

Request

Security
api_key
Path
recordTypeQualifierIdinteger(int32)required

The ID of the record type qualifier to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/record-type-qualifiers/{recordTypeQualifierId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations