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

Get status of Executions and async tasks

Request

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get tasks for monitor. 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

statestring

The state of task to get the status. Default is to return running tasks

Default "RUNNING"
Value"RUNNING"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/monitor-task?page_number=1&page_size=0&state=RUNNING' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(MonitorTask)
Example: [{"taskId":123,"taskType":"EXECUTIONS","progression":[{"event":"event1","order":1,"status":"SUCCEEDED"},{"event":"event2","order":2,"status":"SKIPPED"},{"event":"event3","order":3,"status":"RUNNING"},{"event":"event4","order":4,"status":"QUEUED"},{"event":"event5","order":5,"status":"QUEUED"}]}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get status of Executions or async tasks by id

Request

Security
api_key
Path
taskIdinteger(int32)required

The ID of the monitorable task to get

Query
monitorable_taskstring

The type of monitorable task to check progress

Default "EXECUTIONS"
Value"EXECUTIONS"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/monitor-task/{taskId}?monitorable_task=EXECUTIONS' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
taskIdinteger(int32)read-onlyrequired

The ID of the monitorable Task. This field will be generated by the Masking Engine, correspond to taskType

Example: 123
taskTypestringread-onlyrequired

The type of async task to monitor.

Enum"EXECUTIONS""ASYNC_TASK"
Example: "EXECUTIONS"
progressionArray of objects(TaskEvents)
Example: [{"event":"event1","order":1,"status":"SUCCEEDED"},{"event":"event2","order":2,"status":"SKIPPED"},{"event":"event3","order":3,"status":"RUNNING"},{"event":"event4","order":4,"status":"QUEUED"},{"event":"event5","order":5,"status":"QUEUED"}]
Response
application/json
{
  "taskId": 123,
  "taskType": "EXECUTIONS",
  "progression": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

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