Delphix Executions API

openapi: 3.2.0
info:
  title: Delphix DCT Executions API
  version: 3.28.0
  description: Delphix DCT API
  contact:
    name: Delphix Support
    url: https://portal.perforce.com/s/
    email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: Executions
paths:
  /executions:
    get:
      tags:
      - Executions
      summary: Retrieve the list of masking executions
      operationId: get_executions
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListExecutionsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Execution'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/search:
    post:
      tags:
      - Executions
      summary: Search masking executions
      operationId: search_executions
      x-filterable:
        fields:
          id:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          job_orchestrator_id:
            type: string
          job_orchestrator_name:
            type: string
          masking_job_id:
            type: string
          masking_job_name:
            type: string
          compliance_job_type:
            type: string
          dct_managed:
            type: boolean
          source_connector_id:
            type: string
          source_connector_name:
            type: string
          target_connector_id:
            type: string
          target_connector_name:
            type: string
          status:
            type: string
          rows_masked:
            type: integer
          rows_total:
            type: integer
          bytes_processed:
            type: integer
          bytes_total:
            type: integer
          start_time:
            type: string
          submit_time:
            type: string
          end_time:
            type: string
          run_duration:
            type: integer
          queue_duration:
            type: integer
          total_duration:
            type: integer
          account_id:
            type: integer
          account_name:
            type: string
          hyperscale_instance_id:
            type: string
          hyperscale_engine_count:
            type: integer
          collection_execution_id:
            type: string
          owning_entity_id:
            type: string
          owning_entity_type:
            type: string
          task_events:
            type: array[object]
            fields:
              event:
                type: string
              status:
                type: string
          hyperscale_task_events:
            type: array[object]
            fields:
              name:
                type: string
              progress:
                type: number
              status:
                type: string
              processed_objects:
                type: integer
              processed_rows:
                type: integer
              total_constraints:
                type: integer
              processed_indexes:
                type: integer
              total_indexes:
                type: integer
              processed_triggers:
                type: integer
              total_triggers:
                type: integer
              start_time:
                type: string
              end_time:
                type: string
              errors:
                type: array[object]
                fields:
                  table_name:
                    type: string
                  error:
                    type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchExecutionsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Execution'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Retrieve an Execution by ID
      operationId: get_execution_by_id
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Execution'
  /executions/{executionId}/cancel:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      summary: Cancel an Execution
      operationId: cancel_execution
      tags:
      - Executions
      requestBody:
        required: false
        content:
          application/json:
            schema:
              x-body-name: cancel_execution
              $ref: '#/components/schemas/ExecutionCancelParameters'
      responses:
        '200':
          description: OK
  /executions/{executionId}/restart:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      summary: Restart an Execution (Hyperscale only)
      operationId: restart_execution
      tags:
      - Executions
      responses:
        '200':
          description: Masking job execution restarted.
          content:
            application/json:
              schema:
                type: object
                title: RestartExecutionResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /executions/{executionId}/cleanup:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      summary: Cleanup an Execution (Hyperscale only)
      operationId: cleanup_execution
      tags:
      - Executions
      responses:
        '200':
          description: Masking job execution cleaned up.
          content:
            application/json:
              schema:
                type: object
                title: CleanupExecutionResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /executions/{executionId}/events:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Retrieve the list of events for a masking execution
      operationId: get_execution_events
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionEventsSortParam'
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListExecutionEventsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExecutionEvent'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}/events/search:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      tags:
      - Executions
      summary: Search masking executions events
      operationId: search_execution_events
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionEventsSortParam'
      x-filterable:
        fields:
          id:
            type: string
          execution_id:
            type: string
          execution_component_id:
            type: string
          event_type:
            type: string
          severity:
            type: string
          cause:
            type: string
          count:
            type: integer
          timestamp:
            type: string
          masked_object_name:
            type: string
          algorithm_name:
            type: string
          exception_type:
            type: string
          exception_detail:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchExecutionEventsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExecutionEvent'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}/log:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Retrieve the masking execution log
      description: Returns the execution log information for the given execution.
      operationId: get_execution_log
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionLog'
        '404':
          description: Execution not found or log not available.
  /executions/{executionId}/execution-components:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Get execution components for an execution
      operationId: get_execution_components
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionComponentsSortParam'
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ExecutionComponentsListResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExecutionComponent'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}/execution-components/search:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      tags:
      - Executions
      summary: Search execution components for an execution
      operationId: search_execution_components
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/executionComponentsSortParam'
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          execution_id:
            type: string
          status:
            type: string
          rows_masked:
            type: integer
          rows_total:
            type: integer
          bytes_processed:
            type: integer
          bytes_total:
            type: integer
          start_time:
            type: string
          end_time:
            type: string
          non_conforming_data_count:
            type: integer
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ExecutionComponentsSearchResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExecutionComponent'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}/execution-components/{executionComponentId}:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    - $ref: '#/components/parameters/executionComponentIdParam'
    get:
      summary: Get an execution component by ID
      operationId: get_execution_component_by_id
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionComponent'
  /executions/{executionId}/execution-components/{executionComponentId}/log:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    - $ref: '#/components/parameters/executionComponentIdParam'
    get:
      summary: Get an execution component log
      description: Returns the execution component log information for the given execution component.
      operationId: get_execution_component_log
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionComponentLog'
        '404':
          description: Execution component not found or log not available.
  /executions/{executionId}/discovery-results:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Retrieve the list of discovery results for a masking execution
      operationId: get_discovery_results
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/discoveryResultSortParam'
      tags:
      - Executions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListDiscoveryResultsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveryResult'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /executions/{executionId}/discovery-results/search:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      tags:
      - Executions
      summary: Search discovery results associated with execution of a discovery job
      operationId: search_discovery_results
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/discoveryResultSortParam'
      x-filterable:
        fields:
          id:
            type: string
          table_name:
            type: string
          file_name:
            type: string
          column_name:
            type: string
          field_name:
            type: string
          data_class_name:
            type: string
          algorithm_name:
            type: string
          data_type:
            type: string
          confidence:
            type: integer
          is_profiler_writable:
            type: boolean
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchDiscoveryResultsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveryResult'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
components:
  schemas:
    ExecutionLog:
      description: A log containing warnings or errors associated with a job execution.
      allOf:
      - type: object
        properties:
          id:
            description: The ExecutionLog entity ID.
            type: string
            example: 1-LOG-1
          execution_id:
            description: The ID of the execution.
            type: string
            example: ea02f031-75d7-4c76-8747-2a7f04181451
          masking_job_id:
            description: The ID of the masking job that is being executed.
            type: string
            example: '2'
          status:
            $ref: '#/components/schemas/ExecutionStatus'
      - $ref: '#/components/schemas/ExecutionLogsDownloadProperties'
    HyperscaleTaskEvent:
      properties:
        name:
          type: string
          description: Name of the task (Unload, Masking, Load, Post-Load)
          example: Unload
        progress:
          description: progress of the task (between 0 and 1)
          type: number
          example: 0.34
        status:
          type: string
          enum:
          - CANCELLED
          - CANCEL_INITIATED
          - FAILED
          - RUNNING
          - SUCCEEDED
          example: FAILED
        processed_objects:
          description: The number of objects (tables) already processed by this task.
          type: integer
          format: int64
        processed_rows:
          description: The number of rows already processed by this task.
          type: integer
          format: int64
        processed_constraints:
          description: The number of constraints processed by this task (Post-load task only)
          type: integer
          format: int64
        total_constraints:
          description: The total number of constraints to be processed by this task (Post-load task only)
          type: integer
          format: int64
        processed_indexes:
          description: The number of indexes processed by this task (Post-load task only)
          type: integer
          format: int64
        total_indexes:
          description: The total number of indexes to be processed by this task (Post-load task only)
          type: integer
          format: int64
        processed_triggers:
          description: The number of triggered processed by this task (Post-load task only)
          type: integer
          format: int64
        total_triggers:
          description: The total number of triggers to be processed by this task (Post-load task only)
          type: integer
          format: int64
        start_time:
          description: The date and time that this task was started.
          type: string
          format: date-time
          example: '2022-01-02T05:11:24.148000+00:00'
        end_time:
          description: The date and time that this task completed.
          type: string
          format: date-time
          example: '2022-01-02T05:13:24.148000+00:00'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/HyperscaleTaskError'
    Job:
      description: An asynchronous task.
      type: object
      properties:
        id:
          description: The Job entity ID.
          type: string
          example: job-123
        status:
          description: The status of the job.
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
          example: RUNNING
        is_waiting_for_telemetry:
          description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.
          type: boolean
        type:
          description: The type of job being done.
          type: string
          example: DB_REFRESH
        localized_type:
          description: The i18n translated type of job being done.
          type: string
          example: DB Refresh
        error_details:
          description: Details about the failure for FAILED jobs.
          type: string
          example: Unable to connect to the engine.
        warning_message:
          description: Warnings for the job.
          type: string
          example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.'
        target_id:
          description: A reference to the job's target.
          type: string
          example: vdb-123
        target_name:
          description: A reference to the job's target name.
          type: string
          example: vdb
        start_time:
          description: The time the job started executing.
          type: string
          format: date-time
          example: '2022-01-02T05:11:24.148000+00:00'
        update_time:
          description: The time the job was last updated.
          type: string
          format: date-time
          example: '2022-01-02T06:11:24.148000+00:00'
        trace_id:
          description: traceId of the request which created this Job
          type: string
        engine_ids:
          description: IDs of the engines this Job is executing on.
          type: array
          items:
            type: string
          deprecated: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        engines:
          type: array
          items:
            $ref: '#/components/schemas/Engine'
        account_id:
          description: The ID of the account who initiated this job.
          type: integer
          example: 1
        account_name:
          description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-<id>.
          type: string
          example: User 1
        compliance_node_id:
          type:
          - string
          - 'null'
          description: The ID of the associated compliance node, if applicable.
        compliance_node_name:
          type:
          - string
          - 'null'
          description: The name of the associated compliance node, if applicable.
        percent_complete:
          description: Completion percentage of the Job.
          type: integer
          minimum: 0
          maximum: 100
          example: '50'
        virtualization_tasks:
          deprecated: true
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTask'
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/JobTask'
        execution_id:
          description: The ID of the associated masking execution, if any.
          type:
          - string
          - 'null'
        result_type:
          description: The type of the job result. This is the type of the object present in the result.
          type: string
        result:
          description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.
          type: object
    ExecutionStatus:
      description: The status of a masking or discovery job.
      type: string
      enum:
      - PENDING
      - QUEUED
      - RUNNING
      - CANCELLED
      - FAILED
      - SUCCEEDED
      - WARNING
      - WAITING
      example: RUNNING
    ExecutionComponentLog:
      description: A log containing information about an execution component
      allOf:
      - type: object
        properties:
          execution_component_id:
            description: The ID of the execution component
            type: string
            example: '123'
      - $ref: '#/components/schemas/ExecutionLogsDownloadProperties'
    DiscoveryResult:
      description: The result of sensitive data discovery on a single column or field
      type: object
      properties:
        id:
          description: The DCT local id of this discovery result
          type: string
          example: 1
        table_name:
          description: The name of the table to which the column belongs
          type: string
          example: cust_address
        file_name:
          description: The name of the file to which the discovery result applies
          type: string
          example: report.json
        column_name:
          description: The name the column to which the discovery result applies
          type: string
          example: ADDR_LINE_1
        field_name:
          description: The name the field to which the discovery result applies
          type: string
          example: customer name
        data_class_name:
          description: The data class selected for the column or field
          type: string
          example: FIRST_NAME
        algorithm_name:
          description: The name of the algorithm selected for the column or field
          type: string
          example: FIRST_NAME_SL
        data_type:
          description: The data type determined for the column or field
          type: string
          example: varchar
        confidence:
          description: The confidence of the discovery result, ranging from -100 to 100
          type: integer
          format: int32
          example: 85
        is_profiler_writable:
          description: Whether the corresponding ruleset column or field was configured to allow the discovery process to update the masking assignment
          type: boolean
    PaginatedResponseMetadata:
      type: object
      properties:
        prev_cursor:
          description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        next_cursor:
          description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        total:
          description: The total number of results. This value may not be provided.
          type: integer
          format: int_64
    HyperscaleTaskError:
      properties:
        table_name:
          type: string
          description: the name of the table for which the error occurred, including the schema.
          example: public_schema.table_x
        error:
          type: string
          description: A textual description of the error.
    JobTaskEvent:
      properties:
        message_details:
          type: string
    Execution:
      description: The execution of a masking or discovery job.
      type: object
      properties:
        id:
          description: The Execution entity ID.
          type: string
          example: 414ed52c-fa89-455d-9fb9-9c2fa5115f80
        engine_id:
          description: The ID of the engine where this execution ran.
          type: string
          example: '1'
        hyperscale_instance_id:
          type: string
        engine_name:
          description: The name of the engine where this execution ran.
          type: string
          example: prod01
        job_orchestrator_id:
          description: The ID of the job orchestrator that is associated with this execution.
          type: string
        job_orchestrator_name:
          description: The name of the job orchestrator that is associated with this execution.
          type: string
        masking_job_id:
          description: The ID of the masking job that is being executed.
          type: string
          example: '2'
        masking_job_name:
          description: The name of the masking job that is being executed.
          type: string
          example: finance-masking-job
        compliance_job_type:
          description: The type of the compliance job being executed.
          type: string
          enum:
          - MASKING
          - DISCOVERY
          - TOKENIZATION
          - REIDENTIFICATION
          example: MASKING
        dct_managed:
          description: Indicates whether this execution is for a DCT-managed masking job.
          type: boolean
          example: true
        source_connector_id:
          description: The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.
          type: string
          example: 1-DATABASE-2
        target_connector_id:
          description: The ID of the target connector. This field is only used for multi-tenant jobs.
          type: string
          example: 1-DATABASE-3
        source_connector_name:
          description: The name of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.
          type: string
          example: source-database
        target_connector_name:
          description: The name of the target connector. This field is only used for multi-tenant jobs.
          type: string
          example: target-database
        status:
          $ref: '#/components/schemas/ExecutionStatus'
        rows_masked:
          description: The number of rows masked or profiled so far by this execution. This is not applicable for JSON file type.
          type: integer
          format: int64
          example: 1000
        rows_total:
          description: 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.
          type: integer
          format: int64
          example: 5000
        bytes_processed:
          description: The number of bytes masked so far by this execution. This is only applicable for JSON file type.
          type: integer
          format: int64
          example: 500
        bytes_total:
          description: 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.
          type: integer
          format: int64
          example: 5000000
        start_time:
          description: The date and time that this execution was started.
          type: string
          format: date-time
          example: '2021-05-01T09:51:34.148000+00:00'
        submit_time:
          description: The date and time that this execution was submitted.
          type: string
          format: date-time
          example: '2021-05-01T08:51:34.148000+00:00'
        end_time:
          description: The date and time that this execution completed.
          type: string
          format: date-time
          example: '2021-05-01T11:51:34.148000+00:00'
        run_duration:
          description: The time this execution spent running, in milliseconds.
          type: integer
          format: int64
          example: 4000
        queue_duration:
          description: The time this execution spent in the queue, in milliseconds.
          type: integer
          format: int64
          example: 1000
        total_duration:
          description: The total time this execution took, in milliseconds.
          type: integer
          format: int64
          example: 5000
        account_id:
          description: The account id of the DCT user who started this execution.
          type: integer
          format: int64
          example: 3
        account_name:
          description: The account name of the DCT user who started this execution.
          type: string
          example: username
        task_events:
          description: 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.
          type: array
          items:
            $ref: '#/components/schemas/TaskEvent'
          example:
          - event: Initializing
            status: SUCCEEDED
          - event: Job Completed
            status: FAILED
        hyperscale_task_events:
          type: array
          items:
     

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-executions-api-openapi.yml