Skip to content

Retrieve an Execution by ID.

Request

Security
ApiKeyAuth
Path
executionIdstring, non-emptyrequired

The ID of the Execution.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/20.0.0/continuous-compliance-apis-dct-20.0.0/executions/{executionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

The Execution entity ID.

Example:"414ed52c-fa89-455d-9fb9-9c2fa5115f80"
engine_idstring

The ID of the engine where this execution ran.

Example:"1"
hyperscale_instance_idstring
engine_namestring

The name of the engine where this execution ran.

Example:"prod01"
masking_job_idstring

The ID of the masking job that is being executed.

Example:"2"
masking_job_namestring

The name of the masking job that is being executed.

Example:"finance-masking-job"
source_connector_idstring

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

Example:"1-DATABASE-2"
target_connector_idstring

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

Example:"1-DATABASE-3"
statusstring(ExecutionStatus)

The status of a masking or discovery job.

Enum:"PENDING""QUEUED""RUNNING""CANCELLED""FAILED""SUCCEEDED""WARNING"
Example:"RUNNING"
rows_maskedinteger, (int64)

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

Example:1000
rows_totalinteger, (int64)

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

Example:5000
bytes_processedinteger, (int64)

The number of bytes masked so far by this execution. This is only applicable for JSON file type.

Example:500
bytes_totalinteger, (int64)

The total number of bytes that this execution should mask. This value is set to -1 while the total byte count is being calculated. This is only applicable for JSON file type.

Example:5000000
start_timestring, (date-time)

The date and time that this execution was started.

Example:"2021-05-01T09:51:34.148000+00:00"
submit_timestring, (date-time)

The date and time that this execution was submitted.

Example:"2021-05-01T08:51:34.148000+00:00"
end_timestring, (date-time)

The date and time that this execution completed.

Example:"2021-05-01T11:51:34.148000+00:00"
task_eventsArray of objects(TaskEvent)

The progression of steps or events performed by this execution. Only available for executions on masking engines that are version 6.0.14.0 and higher.

Example:
[ { "event": "Initializing", "status": "SUCCEEDED" }, { "event": "Job Completed", "status": "FAILED" } ]
hyperscale_task_eventsArray of objects(HyperscaleTaskEvent)
progressnumber

Progress of the task (value between 0 and 1, Hyperscale executions only)

Example:0.34
Response
{ "id": "414ed52c-fa89-455d-9fb9-9c2fa5115f80", "engine_id": "1", "hyperscale_instance_id": "string", "engine_name": "prod01", "masking_job_id": "2", "masking_job_name": "finance-masking-job", "source_connector_id": "1-DATABASE-2", "target_connector_id": "1-DATABASE-3", "status": "RUNNING", "rows_masked": 1000, "rows_total": 5000, "bytes_processed": 500, "bytes_total": 5000000, "start_time": "2021-05-01T09:51:34.148000+00:00", "submit_time": "2021-05-01T08:51:34.148000+00:00", "end_time": "2021-05-01T11:51:34.148000+00:00", "task_events": [ { … }, { … } ], "hyperscale_task_events": [ { … } ], "progress": 0.34 }