Skip to content

Masking API (5.1.42)

Schema for the Continuous Compliance Engine API

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

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

Get all Mainframe Dataset metadata

Request

Security
api_key
Query
ruleset_idinteger(int32)

The ID of the ruleset to get all Mainframe Dataset metadata from

page_numberinteger(int64)

The page number for which to get Mainframe Dataset 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.2.0.0/cc-engine-apis-2025.2.0.0/mainframe-dataset-metadata?ruleset_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(MainframeDatasetMetadata)
Example: [{"fileName":"file.dat","rulesetId":1,"mainframeDatasetFormatId":2}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create Mainframe Dataset metadata

Request

Security
api_key
Bodyapplication/jsonrequired

The Mainframe Dataset metadata to create

fileNamestring<= 255 charactersrequired

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.

Example: "file.dat"
rulesetIdinteger(int32)required

The ID of the ruleset to create the Mainframe Dataset metadata on.

Example: 1
mainframeDatasetFormatIdinteger(int32)

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.

Example: 2
recordFormatstring

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Default "FIXED_BLOCKED"
Enum"FIXED_BLOCKED""VARIABLE_BLOCKED"
nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/mainframe-dataset-metadata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileName": "file.dat",
    "rulesetId": 1,
    "mainframeDatasetFormatId": 2
  }'

Responses

Successful operation

Bodyapplication/json
mainframeDatasetMetadataIdinteger(int32)read-only

The ID of the Mainframe Dataset metadata. This field is set by the Masking Engine.

fileNamestring<= 255 charactersrequired

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.

Example: "file.dat"
rulesetIdinteger(int32)required

The ID of the ruleset to create the Mainframe Dataset metadata on.

Example: 1
mainframeDatasetFormatIdinteger(int32)

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.

Example: 2
recordFormatstring

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Default "FIXED_BLOCKED"
Enum"FIXED_BLOCKED""VARIABLE_BLOCKED"
nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
Response
application/json
{
  "fileName": "file.dat",
  "rulesetId": 1,
  "mainframeDatasetFormatId": 2
}

Get Mainframe Dataset metadata by ID

Request

Security
api_key
Path
mainframeDatasetMetadataIdinteger(int32)required

The ID of the Mainframe Dataset metadata to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/mainframe-dataset-metadata/{mainframeDatasetMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
mainframeDatasetMetadataIdinteger(int32)read-only

The ID of the Mainframe Dataset metadata. This field is set by the Masking Engine.

fileNamestring<= 255 charactersrequired

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.

Example: "file.dat"
rulesetIdinteger(int32)required

The ID of the ruleset to create the Mainframe Dataset metadata on.

Example: 1
mainframeDatasetFormatIdinteger(int32)

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.

Example: 2
recordFormatstring

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Default "FIXED_BLOCKED"
Enum"FIXED_BLOCKED""VARIABLE_BLOCKED"
nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
Response
application/json
{
  "fileName": "file.dat",
  "rulesetId": 1,
  "mainframeDatasetFormatId": 2
}

Update Mainframe Dataset metadata by ID

Request

Security
api_key
Path
mainframeDatasetMetadataIdinteger(int32)required

The ID of the Mainframe Dataset metadata to update

Bodyapplication/jsonrequired

The updated Mainframe Dataset metadata

fileNamestring<= 255 charactersrequired

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.

Example: "file.dat"
rulesetIdinteger(int32)required

The ID of the ruleset to create the Mainframe Dataset metadata on.

Example: 1
mainframeDatasetFormatIdinteger(int32)

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.

Example: 2
recordFormatstring

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Default "FIXED_BLOCKED"
Enum"FIXED_BLOCKED""VARIABLE_BLOCKED"
nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/mainframe-dataset-metadata/{mainframeDatasetMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileName": "file.dat",
    "rulesetId": 1,
    "mainframeDatasetFormatId": 2
  }'

Responses

Successful operation

Bodyapplication/json
mainframeDatasetMetadataIdinteger(int32)read-only

The ID of the Mainframe Dataset metadata. This field is set by the Masking Engine.

fileNamestring<= 255 charactersrequired

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.

Example: "file.dat"
rulesetIdinteger(int32)required

The ID of the ruleset to create the Mainframe Dataset metadata on.

Example: 1
mainframeDatasetFormatIdinteger(int32)

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.

Example: 2
recordFormatstring

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Default "FIXED_BLOCKED"
Enum"FIXED_BLOCKED""VARIABLE_BLOCKED"
nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
Response
application/json
{
  "fileName": "file.dat",
  "rulesetId": 1,
  "mainframeDatasetFormatId": 2
}

Delete Mainframe Dataset metadata by ID

Request

Security
api_key
Path
mainframeDatasetMetadataIdinteger(int32)required

The ID of the Mainframe Dataset metadata to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/mainframe-dataset-metadata/{mainframeDatasetMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

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