Skip to content
/
Get all Mainframe Dataset...

Masking API (5.1.41)

Schema for the Continuous Compliance Engine API

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

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

Get all Mainframe Dataset rulesets

Request

Security
api_key
Query
environment_idinteger(int32)

The ID of the environment to get all Mainframe Dataset rulesets from

page_numberinteger(int64)

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

Responses

Successful operation

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(MainframeDatasetRuleset)
Example: [{"rulesetName":"Rule123","mainframeDatasetConnectorId":1}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create Mainframe Dataset ruleset

Request

Security
api_key
Bodyapplication/jsonrequired

The Mainframe Dataset ruleset to create

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
mainframeDatasetConnectorIdinteger(int32)required

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.

Example: 1
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/mainframe-dataset-rulesets \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "rulesetName": "Rule123",
    "mainframeDatasetConnectorId": 1
  }'

Responses

Successful operation

Bodyapplication/json
mainframeDatasetRulesetIdinteger(int32)read-only

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

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
mainframeDatasetConnectorIdinteger(int32)required

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.

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "mainframeDatasetConnectorId": 1
}

Get Mainframe Dataset ruleset by ID

Request

Security
api_key
Path
mainframeDatasetRulesetIdinteger(int32)required

The ID of the Mainframe Dataset ruleset to get

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

Responses

Successful operation

Bodyapplication/json
mainframeDatasetRulesetIdinteger(int32)read-only

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

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
mainframeDatasetConnectorIdinteger(int32)required

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.

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "mainframeDatasetConnectorId": 1
}

Delete Mainframe Dataset ruleset by ID

Request

Security
api_key
Path
mainframeDatasetRulesetIdinteger(int32)required

The ID of the Mainframe Dataset ruleset to delete

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

Responses

Successful operation

Update the set of mainframe datasets and their attributes associated with a mainframe dataset ruleset in bulk

Request

Security
api_key
Path
mainframeDatasetRulesetIdinteger(int32)required

The ID of the mainframe dataset ruleset to update the mainframe dataset for

Bodyapplication/jsonrequired

The exact list of mainframe datasets to put in the ruleset. Note that existing datasets for this ruleset not in this list will be deleted

mainframeDatasetMetadataArray of objects(MainframeDatasetMetadata)required
Example: [{"fileName":"file.dat","rulesetId":1,"mainframeDatasetFormatId":2}]
mainframeDatasetMetadata[].​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"
mainframeDatasetMetadata[].​rulesetIdinteger(int32)required

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

Example: 1
mainframeDatasetMetadata[].​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
mainframeDatasetMetadata[].​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"
mainframeDatasetMetadata[].​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.1.0.0/cc-engine-apis-2025.1.0.0/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/bulk-mainframe-dataset-update' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mainframeDatasetMetadata": [
      {
        "fileName": "file.dat",
        "rulesetId": 1,
        "mainframeDatasetFormatId": 2
      }
    ]
  }'

Responses

Success

Bodyapplication/json
asyncTaskIdinteger(int32)read-only

The ID of the AsyncTask. This field will be generated by the Masking Engine.

Example: 1
operationstringread-only

The type of operation that the AsyncTask is performing.

Enum"ADD_MAPPINGS""ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""DATAFILE_BULK_UPDATE""ENCRYPTION_KEY_CREATE""EXPORT""EXPORT_CLASSIFIER_FILES""EXPORT_MAPPINGS""EXPORT_PROFILE_SET"
Example: "RULESET_REFRESH"
referencestring<= 255 charactersread-only

The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.

Example: 13
statusstringread-only

The status of the AsyncTask in regard to its completion.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"
Example: "RUNNING"
startTimestring(date-time)read-only

The date and time that this AsyncTask was started.

endTimestring(date-time)read-only

The date and time that this AsyncTask completed.

cancellablebooleanread-only

True if the AsyncTask can be cancelled, false otherwise.

exceptionDetailstringread-only

The details associated with the Java exception that caused this async task to fail, if applicable.

Response
application/json
{
  "asyncTaskId": 1,
  "operation": "RULESET_REFRESH",
  "reference": 13,
  "status": "RUNNING",
  "cancellable": false
}

Copy mainframe dataset ruleset by ID

Request

Security
api_key
Path
mainframeDatasetRulesetIdinteger(int32)required

The ID of the mainframe dataset ruleset to copy

Bodyapplication/jsonrequired

The name of the ruleset. This must be unique within an environment.

newRulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/copy' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "newRulesetName": "Rule123"
  }'

Responses

Success

Bodyapplication/json
mainframeDatasetRulesetIdinteger(int32)read-only

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

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
mainframeDatasetConnectorIdinteger(int32)required

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.

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "mainframeDatasetConnectorId": 1
}

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