Skip to content
/
Get execution by ID

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

Get all executions

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"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/executions?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(Execution)
Example: [{"jobId":167}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create execution

Request

Security
api_key
Bodyapplication/jsonrequired

The execution to create

jobIdinteger(int32)required

The ID of the job that is being executed.

Example: 167
connectorTypestring

The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

Enum"DATABASE""FILE""VSAM"
sourceConnectorIdinteger(int32)

The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

targetConnectorIdinteger(int32)

The ID of the target connector. This field is only used for multi-tenant jobs.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/executions \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "jobId": 167
  }'

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.

jobIdinteger(int32)required

The ID of the job that is being executed.

Example: 167
connectorTypestring

The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

Enum"DATABASE""FILE""VSAM"
sourceConnectorIdinteger(int32)

The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

targetConnectorIdinteger(int32)

The ID of the target connector. This field is only used for multi-tenant jobs.

statusstringread-only

The status of the execution regarding its completion.

Enum"CANCELLED""FAILED""QUEUED""RUNNING""SUCCEEDED""WARNING"
rowsMaskedinteger(int64)read-only

The number of rows masked or profiled so far by this execution. This is not applicable to JSON.

rowsTotalinteger(int64)read-only

The total number of rows that this execution should mask or profile. This value is set to -1 while the total row count is being calculated. This is not applicable to JSON.

bytesProcessedinteger(int64)read-only

The number of bytes masked or profiled so far by this execution. This is only applicable to JSON files and ASDD profiling jobs on XML files.

bytesTotalinteger(int64)read-only

The total number of bytes or profiled that this execution should mask. This value is set to -1 while the total byte count is being calculated. This is only applicable to JSON files and ASDD profiling jobs on XML files.

startTimestring(date-time)read-only

The date and time that this execution was started.

endTimestring(date-time)read-only

The date and time that this execution completed.

submitTimestring(date-time)read-only

The date and time that this execution was submitted.

Response
application/json
{
  "jobId": 167
}

Callbacks

Receives notification callback
post

Get execution 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/executions/{executionId}' \
  -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.

jobIdinteger(int32)required

The ID of the job that is being executed.

Example: 167
connectorTypestring

The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

Enum"DATABASE""FILE""VSAM"
sourceConnectorIdinteger(int32)

The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

targetConnectorIdinteger(int32)

The ID of the target connector. This field is only used for multi-tenant jobs.

statusstringread-only

The status of the execution regarding its completion.

Enum"CANCELLED""FAILED""QUEUED""RUNNING""SUCCEEDED""WARNING"
rowsMaskedinteger(int64)read-only

The number of rows masked or profiled so far by this execution. This is not applicable to JSON.

rowsTotalinteger(int64)read-only

The total number of rows that this execution should mask or profile. This value is set to -1 while the total row count is being calculated. This is not applicable to JSON.

bytesProcessedinteger(int64)read-only

The number of bytes masked or profiled so far by this execution. This is only applicable to JSON files and ASDD profiling jobs on XML files.

bytesTotalinteger(int64)read-only

The total number of bytes or profiled that this execution should mask. This value is set to -1 while the total byte count is being calculated. This is only applicable to JSON files and ASDD profiling jobs on XML files.

startTimestring(date-time)read-only

The date and time that this execution was started.

endTimestring(date-time)read-only

The date and time that this execution completed.

submitTimestring(date-time)read-only

The date and time that this execution was submitted.

Response
application/json
{
  "jobId": 167
}

Cancel execution by ID

Request

Security
api_key
Path
executionIdinteger(int32)required

The ID of the execution to cancel

Query
expectedStatusstring

The expected status of the execution to cancel to prevent cancelling a queued job that has transitioned to a running state since the request was issued.

Enum"QUEUED""RUNNING"
gracefulboolean

A cancellation strategy to re-enable SQL objects that were disabled earlier in the execution before terminating.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/executions/{executionId}/cancel?expectedStatus=QUEUED&graceful=true' \
  -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.

jobIdinteger(int32)required

The ID of the job that is being executed.

Example: 167
connectorTypestring

The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

Enum"DATABASE""FILE""VSAM"
sourceConnectorIdinteger(int32)

The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

targetConnectorIdinteger(int32)

The ID of the target connector. This field is only used for multi-tenant jobs.

statusstringread-only

The status of the execution regarding its completion.

Enum"CANCELLED""FAILED""QUEUED""RUNNING""SUCCEEDED""WARNING"
rowsMaskedinteger(int64)read-only

The number of rows masked or profiled so far by this execution. This is not applicable to JSON.

rowsTotalinteger(int64)read-only

The total number of rows that this execution should mask or profile. This value is set to -1 while the total row count is being calculated. This is not applicable to JSON.

bytesProcessedinteger(int64)read-only

The number of bytes masked or profiled so far by this execution. This is only applicable to JSON files and ASDD profiling jobs on XML files.

bytesTotalinteger(int64)read-only

The total number of bytes or profiled that this execution should mask. This value is set to -1 while the total byte count is being calculated. This is only applicable to JSON files and ASDD profiling jobs on XML files.

startTimestring(date-time)read-only

The date and time that this execution was started.

endTimestring(date-time)read-only

The date and time that this execution completed.

submitTimestring(date-time)read-only

The date and time that this execution was submitted.

Response
application/json
{
  "jobId": 167
}

Search executions

Request

Security
api_key
Query
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_sortstring

The field to sort results by. A property name with a prepended '-' signifies a descending order.

Enum"environmentId""-environmentId""executionId""-executionId""jobId""-jobId"
Bodyapplication/json

A request body containing a filter expression. Refer to the documentation to learn the syntax for filter-queries. Supported filterable attributes: "environmentId", "executionId", "jobId"

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/executions/search?page_number=1&page_size=0&execution_sort=environmentId' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter_expression": "<attribute> EQ 123"
  }'

Responses

Success

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

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