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

Get all Mainframe Dataset field metadata

Request

Security
api_key
Query
mainframe_dataset_format_idinteger(int32)

The ID of the Mainframe Dataset format to get all Mainframe Dataset field metadata from

is_maskedboolean

Get only masked Mainframe Dataset field metadata when this is true and only unmasked Mainframe Dataset field metadata when this is false

page_numberinteger(int64)

The page number for which to get Mainframe Dataset field metadata. 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/mainframe-dataset-field-metadata?mainframe_dataset_format_id=0&is_masked=true&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(MainframeDatasetFieldMetadata)
Example: [{"algorithmName":"FirstNameLookup","domainName":"FIRST_NAME"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get Mainframe Dataset field metadata by ID

Request

Security
api_key
Path
mainframeDatasetFieldMetadataIdinteger(int32)required

The ID of the Mainframe Dataset field metadata 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/mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
mainframeDatasetFieldMetadataIdinteger(int32)read-only

The ID number of the Mainframe Dataset field metadata. This field is auto-generated by the Masking Engine.

mainframeDatasetFormatIdinteger(int32)read-only

The ID number of the Mainframe Dataset format that defines this Mainframe Dataset field.

fieldNamestring<= 100 charactersread-only

The name of the Mainframe Dataset field, as determined by the associated Mainframe Dataset format.

algorithmNamestring<= 500 characters

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.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

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.

Example: "FIRST_NAME"
dateFormatstring<= 50 characters

The date format of the date assigned to this Mainframe Dataset field.

isMaskedbooleanread-only

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.

isProfilerWritableboolean

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.

Default false
parentIdinteger(int32)read-only

The ID number of the parent field of Mainframe Dataset field.

Response
application/json
{
  "algorithmName": "FirstNameLookup",
  "domainName": "FIRST_NAME"
}

Update Mainframe Dataset field metadata by ID

Request

Security
api_key
Path
mainframeDatasetFieldMetadataIdinteger(int32)required

The ID of the Mainframe Dataset field metadata to update

Bodyapplication/jsonrequired

The updated Mainframe Dataset field metadata

algorithmNamestring<= 500 characters

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.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

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.

Example: "FIRST_NAME"
dateFormatstring<= 50 characters

The date format of the date assigned to this Mainframe Dataset field.

isProfilerWritableboolean

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.

Default false
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "algorithmName": "FirstNameLookup",
    "domainName": "FIRST_NAME"
  }'

Responses

Success

Bodyapplication/json
mainframeDatasetFieldMetadataIdinteger(int32)read-only

The ID number of the Mainframe Dataset field metadata. This field is auto-generated by the Masking Engine.

mainframeDatasetFormatIdinteger(int32)read-only

The ID number of the Mainframe Dataset format that defines this Mainframe Dataset field.

fieldNamestring<= 100 charactersread-only

The name of the Mainframe Dataset field, as determined by the associated Mainframe Dataset format.

algorithmNamestring<= 500 characters

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.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

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.

Example: "FIRST_NAME"
dateFormatstring<= 50 characters

The date format of the date assigned to this Mainframe Dataset field.

isMaskedbooleanread-only

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.

isProfilerWritableboolean

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.

Default false
parentIdinteger(int32)read-only

The ID number of the parent field of Mainframe Dataset field.

Response
application/json
{
  "algorithmName": "FirstNameLookup",
  "domainName": "FIRST_NAME"
}

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

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations