Skip to content
/
Get execution component l...

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

Get all logs. Note that the logs will be returned in order from most recent to least recent.

Request

Security
api_key
Query
log_levelstring

The log level of the log file. Note that, if this parameter is excluded, the log files will be returned in alphabetical order with respect to their log level.

Enum"DEBUG""ERROR""INFO""WARN"
page_numberinteger(int64)

The page number for which to get logs. 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/application-logs?log_level=DEBUG&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(LogFileInfo)
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get all audit logs

Request

Security
api_key
Query
user_namestring<= 1000 characters

The name of the user that took the action for this entry.

action_typestring

The type of action that occurred for this Audit Log entry.

Enum"CANCEL""CREATE""CONFIG_INSTALL""CONNECT""DELETE""DISCONNECT""EDIT""EXPORT""FORGOT_PASSWORD""GET"
targetstring

The type object or operation that the action occurred on for this Audit Log entry.

Enum"ALGORITHM""ANALYTIC""APPLICATION""APPLICATION_LOG""APPLICATION_SETTING""ASYNC_TASK""AUDIT_LOG""BILLING_PERIOD""BILLING_REPORT""BILLING_USAGE"
statusstring

The status of the action that occurred for this Audit Log entry. This can change over time as ATTEMPTED actions are completed.

Enum"ATTEMPTED""FAILED""SUCCEEDED"
start_timestring

The date after which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.

end_timestring

The date before which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.

search_stringstring

Search for activity description containing substring.

sort_bystring

Sort by field.

Enum"activityTime""userName""status""activityDescription""identity"
sort_dirstring

Sort by direction.

Enum"asc""desc"
page_numberinteger(int64)

The page number for which to get logs. 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/audit-logs?user_name=string&action_type=CANCEL&target=ALGORITHM&status=ATTEMPTED&start_time=string&end_time=string&search_string=string&sort_by=activityTime&sort_dir=asc&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(AuditLog)
Example: [{"userName":"maskingUser","activityDescription":"Created Database Connector 'con' in Environment 'env'.","activityTime":"2018-11-06T04:14:46.929+0000","actionType":"CREATE","target":"DATABASE_CONNECTOR","status":"SUCCEEDED"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get all execution components logs

Request

Security
api_key
Query
execution_idinteger(int32)required

The ID of the Execution to get all component logs

page_numberinteger(int64)

The page number for which to get executions component. 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/execution-component-log?execution_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ExecutionComponentLog)
Example: [{"executionId":123,"componentId":67,"componentName":"table_00","fileDownloadId":"EXECUTION_LOGS-AB8aCbcdDe=="}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get execution component log by component ID

Request

Security
api_key
Path
componentIdinteger(int32)required

The ID of the execution 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/execution-component-log/{componentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
executionIdinteger(int32)read-only

The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run.

Example: 123
componentIdinteger(int32)read-only

The ID of the execution component.

Example: 67
componentNamestring<= 100 characters

Name of the execution component

Example: "table_00"
fileDownloadIdstringread-only

This value is returned on GET. It can be fed into the file-downloads endpoint.

Example: "EXECUTION_LOGS-AB8aCbcdDe=="
Response
application/json
{
  "executionId": 123,
  "componentId": 67,
  "componentName": "table_00",
  "fileDownloadId": "EXECUTION_LOGS-AB8aCbcdDe=="
}

Get all execution logs

Request

Security
api_key
Query
job_idinteger(int32)

The ID of the job to get all executions for

page_numberinteger(int64)

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

execution_statusstring

The status of the job execution. Note that, if this parameter is excluded, then all executions will be returned.

Enum"CANCELLED""FAILED""QUEUED""RUNNING""SUCCEEDED""WAITING""WARNING"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/execution-logs?job_id=0&page_number=1&page_size=0&execution_status=CANCELLED' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ExecutionLog)
Example: [{"executionId":123,"jobId":167,"fileDownloadId":"EXECUTION_LOGS-AB8aCbcdDe==","status":"SUCCEEDED"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get all execution log by ID

Request

Security
api_key
Path
executionIdinteger(int32)required

The ID of the execution 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/execution-logs/{executionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
executionIdinteger(int32)

The ID of the execution for the referenced job. This field is generated by the Masking Engine when a job is run.

Example: 123
jobIdinteger(int32)

The ID of the job that is being executed.

Example: 167
fileDownloadIdstringread-only

This value is returned on GET. It can be fed into the file-downloads endpoint.

Example: "EXECUTION_LOGS-AB8aCbcdDe=="
statusstringread-only

The status of the execution regarding its completion.

Enum"CANCELLED""FAILED""QUEUED""RUNNING""SUCCEEDED""WARNING"
Example: "SUCCEEDED"
Response
application/json
{
  "executionId": 123,
  "jobId": 167,
  "fileDownloadId": "EXECUTION_LOGS-AB8aCbcdDe==",
  "status": "SUCCEEDED"
}

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

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations