Delphix ComplianceJobs API

openapi: 3.2.0
info:
  title: Delphix DCT Compliance Jobs 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: ComplianceJobs
paths:
  /compliance-jobs:
    get:
      tags:
      - ComplianceJobs
      summary: Retrieve the list of compliance jobs
      operationId: get_compliance_jobs
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/complianceJobsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListComplianceJobsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComplianceJob'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - ComplianceJobs
      summary: Create a Compliance Job
      operationId: create_compliance_job
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: create_compliance_job_request
              $ref: '#/components/schemas/CreateComplianceJobRequest'
        description: Input params to create a compliance job.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: CreateComplianceJobResponse
                properties:
                  id:
                    type: string
                    description: The ID of the created compliance job.
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated DCT job.
  /compliance-jobs/search:
    post:
      tags:
      - ComplianceJobs
      summary: Search compliance jobs
      operationId: search_compliance_jobs
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          engine_job_id:
            type: integer
          job_orchestrator_id:
            type: string
          job_orchestrator_name:
            type: string
          type:
            type: string
          execution_type:
            type: string
          hyperscale_state:
            type: string
          is_on_the_fly_masking:
            type: boolean
          is_multi_tenant:
            type: boolean
          creation_date:
            type: string
          last_completed_execution_date:
            type: string
          last_execution_status:
            type: string
          last_execution_id:
            type: string
          last_execution_start_time:
            type: string
          last_execution_run_time:
            type: integer
          rule_set_id:
            type: string
          rule_set_name:
            type: string
          hyperscale_instance_id:
            type: string
          description:
            type: string
          dataset_id:
            type: string
          retain_execution_data:
            type: string
          max_memory:
            type: integer
          min_memory:
            type: integer
          feedback_size:
            type: integer
          stream_row_limit:
            type: integer
          num_input_streams:
            type: integer
          max_concurrent_source_connections:
            type: integer
          max_concurrent_target_connections:
            type: integer
          hyperscale_enabled:
            type: boolean
          auto_calculate_unload_split:
            type: boolean
          consider_continuous_compliance_warning_event_as:
            type: string
          create_all_indexes_with_nologging:
            type: boolean
          disable_parallel_index_creation:
            type: boolean
          enable_all_constraints_with_novalidate:
            type: boolean
          max_parallel_connections_per_table:
            type: integer
          max_records_per_split:
            type: integer
          max_split_per_connection:
            type: integer
          parallelism_degree:
            type: integer
          discovery_policy_id:
            type: string
          discovery_policy_name:
            type: string
          account_id:
            type: integer
          account_name:
            type: string
          dct_managed:
            type: boolean
          fail_immediately:
            type: boolean
          batch_update:
            type: boolean
          commit_size:
            type: integer
          num_output_threads_per_stream:
            type: integer
          pre_script.name:
            type: string
          pre_script.contents:
            type: string
          post_script.name:
            type: string
          post_script.contents:
            type: string
          on_the_fly_source_connector_id:
            type: string
          truncate_tables:
            type: boolean
          drop_indexes:
            type: boolean
          enabled_tasks:
            type: array[string]
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/complianceJobsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchComplianceJobsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComplianceJob'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /compliance-jobs/{complianceJobId}:
    parameters:
    - $ref: '#/components/parameters/complianceJobIdParam'
    get:
      summary: Retrieve a compliance job by ID
      operationId: get_compliance_job_by_id
      tags:
      - ComplianceJobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceJob'
    patch:
      summary: Update values of a compliance job
      operationId: update_compliance_job
      tags:
      - ComplianceJobs
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_compliance_job_request
              $ref: '#/components/schemas/UpdateComplianceJobRequest'
        description: Input params to update a compliance job.
        required: true
      responses:
        '200':
          description: Compliance job update initiated.
          content:
            application/json:
              schema:
                type: object
                title: UpdateComplianceJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  compliance_job:
                    $ref: '#/components/schemas/ComplianceJob'
                    description: The updated compliance job.
    delete:
      tags:
      - ComplianceJobs
      summary: Delete a compliance job
      operationId: delete_compliance_job
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteComplianceJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /compliance-jobs/{complianceJobId}/connectors:
    parameters:
    - $ref: '#/components/parameters/complianceJobIdParam'
    get:
      tags:
      - ComplianceJobs
      summary: Get connectors for a Masking Job by ID
      operationId: get_compliance_job_connectors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceJobConnectorsResponse'
  /compliance-jobs/{complianceJobId}/tags:
    parameters:
    - $ref: '#/components/parameters/complianceJobIdParam'
    post:
      tags:
      - ComplianceJobs
      summary: Create tags for a compliance job
      operationId: create_compliance_job_tag
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: compliance_job_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Masking Job.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - ComplianceJobs
      summary: Get tags for a compliance job
      operationId: get_compliance_job_tag
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /compliance-jobs/{complianceJobId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/complianceJobIdParam'
    post:
      tags:
      - ComplianceJobs
      summary: Delete tags for a compliance job
      operationId: delete_compliance_job_tag
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
        required: false
      responses:
        '204':
          description: No Content
  /compliance-jobs/{complianceJobId}/execute:
    parameters:
    - $ref: '#/components/parameters/complianceJobIdParam'
    - name: executionType
      in: query
      description: The type of execution for the compliance job, default value is STANDARD
      required: false
      schema:
        type: string
        enum:
        - STANDARD
        - HYPERSCALE
        default: STANDARD
    post:
      summary: Execute a compliance job
      operationId: execute_compliance_job
      tags:
      - ComplianceJobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteComplianceJobRequest'
      responses:
        '200':
          description: Compliance job execute initiated.
          content:
            application/json:
              schema:
                type: object
                title: ExecuteComplianceJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
components:
  schemas:
    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
    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
    JobTaskEvent:
      properties:
        message_details:
          type: string
    ComplianceJobScript:
      description: A SQL script to be run before or after a compliance job.
      type: object
      required:
      - name
      - contents
      properties:
        name:
          description: The name of the SQL script.
          type: string
          example: pre_script.sql
        contents:
          description: The contents of the SQL script.
          type: string
          maxLength: 65535
    VirtualizationTask:
      deprecated: true
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    DeleteTag:
      type: object
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
        tags:
          description: List of tags to be deleted
          type: array
          minItems: 1
          maxItems: 1000
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Tag'
    SearchBody:
      description: Search body.
      type: object
      properties:
        filter_expression:
          type: string
          minLength: 5
          maxLength: 50000
          example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
    CreateComplianceJobRequest:
      description: Parameters to create a compliance job.
      type: object
      required:
      - name
      - rule_set_id
      - type
      properties:
        name:
          description: The name of this compliance job.
          type: string
          example: My favorite ComplianceJob
        description:
          description: A description of the compliance job.
          type: string
          example: Job for app finance
        rule_set_id:
          description: The ID of the Rule Set used by this compliance job.
          type: string
          example: uuid
        type:
          description: The type of compliance job.
          type: string
          enum:
          - MASKING
          - DISCOVERY
          - TOKENIZATION
          - REIDENTIFICATION
          example: MASKING
        discovery_policy_id:
          description: The ID of the discovery policy to use for this compliance job. This is only applicable for DISCOVERY jobs.
          type: string
          example: uuid
        max_memory:
          description: The maximum amount of memory, in MB, that the compliance job can consume during execution. A value of 0 or omitting this field uses the default max memory set in application settings.
          type: integer
          format: int32
          minimum: 0
          example: 1024
        min_memory:
          description: The minimum amount of memory, in MB, that the compliance job can consume during execution. Omitting this field uses the default min memory set in application settings.
          type: integer
          format: int32
          minimum: 0
          example: 1024
        feedback_size:
          description: The granularity with which the system provides updates on the progress of the compliance job. For instance, a feedback size of 50000 results in log updates whenever 50000 rows are processed during the masking phase.
          type: integer
          format: int32
          minimum: 1
          example: 50000
          default: 50000
        stream_row_limit:
          description: This value constrains the total number of rows that may enter the job for each masking stream. A value of 0 means unlimited. A value of -1 selects the default value. The minimum explicit value allowed is 20.
          type: integer
          format: int32
          minimum: -1
          example: 20000
        num_input_streams:
          description: This field controls the amount of parallelism that the masking job uses to extract out the data to be masked. For instance, when masking a database, specifying 5 input streams results in the compliance job reading up to 5 database tables in parallel and then masking those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the masking job will consume more memory. If the number of input streams exceeds the number of units being masked (e.g. tables or files), then the excess streams will do nothing.
          type: integer
          format: int32
          minimum: 1
          default: 1
          example: 4
        max_concurrent_source_connections:
          description: Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only).
          type: integer
          format: int32
          minimum: 1
          example: 32
        max_concurrent_target_connections:
          description: Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only).
          type: integer
          format: int32
          minimum: 1
          example: 32
        hyperscale_enabled:
          type: boolean
          example: true
          description: This flag indicates if this compliance job is enabled for Hyperscale processing.
        auto_calculate_unload_split:
          type: boolean
          example: true
          description: If set, hyperscale will auto calculate the no of splits required for masking job.
        consider_continuous_compliance_warning_event_as:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          example: SUCCESS
          description: The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data.
        create_all_indexes_with_nologging:
          type: boolean
          example: false
          description: Add all indexes with NOLOGGING as part of post load.
        disable_parallel_index_creation:
          type: boolean
          example: false
          description: Exclude indexes from combining with constraint and trigger groups as part of pre load.
        enable_all_constraints_with_novalidate:
          type: boolean
          example: false
          description: Enable all constraints with NOVALIDATE as part of post load.
        max_parallel_connections_per_table:
          type: integer
          minimum: 1
          maximum: 32767
          example: 10
          description: Maximum number of parallel connection that per table per masking job.
        max_records_per_split:
          type: integer
          format: int64
          minimum: 1
          example: 100000000
          description: Maximum number of rows allowed per split file for job execution.
        max_split_per_connection:
          type: integer
          minimum: 1
          maximum: 32767
          example: 4
          description: Maximum number of split files allowed per connection for job execution.
        parallelism_degree:
          description: The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only).
          type: integer
          format: int32
          minimum: -1
          maximum: 32767
          example: 4
        fail_immediately:
          description: Whether to fail immediately or delay failure until job completion when a masking algorithm fails to mask its data.
          type: boolean
          default: false
          example: false
        batch_update:
          description: Whether the database load phase to output the masked data will be performed in batches. The size of the batches is determined by the field 'commit_size'.
          type: boolean
          default: true
          example: true
        commit_size:
          description: The size of the database commits when performing batch updates. Omitting this field uses the default commit size set in application settings.
          type: integer
          format: int32
          minimum: 1
          example: 10000
        num_output_threads_per_stream:
          description: The amount of parallelism, per input stream, that the job uses to load back the masked data. For example, specifying 4 output threads per stream with 5 input streams results in a total of 20 output threads for the whole job.
          type: integer
          format: int32
          minimum: 1
          default: 1
          example: 10
        make_current_account_owner:
          type: boolean
          default: true
          description: Whether the account creating this compliance job should be configured as its owner.
        is_multi_tenant:
          description: If true, this job must be executed using a connector that is different from the underlying connector associated with its ruleset.
          type: boolean
          default: false
          example: false
        on_the_fly_source_connector_id:
          type:
          - string
          - 'null'
          description: The ID of the OTF source connector for this job.
        reset_profiling_assignments:
          description: Determines whether the ruleset assignments for the previous profiling execution need to be cleared before this job gets executed.
          type: boolean
          example: true
        multiple_profiler_check:
          description: When enabled, assigns a default algorithm if multiple classifiers match across different data classes above the threshold.
          type: boolean
          example: true
        truncate_tables:
          description: Whether to truncate target database tables before loading masked data. Only applies to database on-the-fly masking jobs.
          type: boolean
          default: false
          example: false
        drop_indexes:
          description: Whether to temporarily drop indexes prior to masking. This only applies to MySQL/MariaDB masking jobs. Other platforms should use enabled_tasks.
          type: boolean
          default: false
          example: false
        pre_script:
          $ref: '#/components/schemas/ComplianceJobScript'
        post_script:
          $ref: '#/components/schemas/ComplianceJobScript'
        enabled_tasks:
          description: Tasks to perform before/after a job from a set of available driver support tasks as indicated by the target rule-set's connector.
          type: array
          items:
            type: string
        tags:
          description: The tags to set on the compliance job.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    JobTask:
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    ConnectorTypeEnum:
      type: string
      enum:
      - DATABASE
      - FILE
      - MAINFRAME_DATASET
      example: DATABASE
    ExecuteComplianceJobRequest:
      type: object
      description: Parameters to execute a compliance job.
      properties:
        target_connector_id:
          description: The ID of the target connector. This field is only used for multi-tenant jobs.
          type:
          - string
          - 'null'
          example: 1-DATABASE-3
        source_connector_id:
          description: The ID of the source connector. This field is only used for multi-tenant and on-the-fly jobs.
          type:
          - string
          - 'null'
          example: 1-DATABASE-4
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    TagsRequest:
      type: object
      required:
      - tags
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          minItems: 1
          maxItems: 1000
          uniqueItems: true
    TagsResponse:
      type: object
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Connector:
      description: Connectors are the way users define the data sources to which the Masking Engine should connect.
      type: object
      properties:
        id:
          description: The Connector entity ID.
          type: string
          example: 1-database-123
        name:
          description: The Connector name.
          type: string
          example: connector-name
        engine_id:
          description: The id of the Compliance Engine that this Connector belongs to.
          type: string
          example: '123'
        engine_name:
          description: The name of the Compliance Engine that this Connector belongs to.
          type: string
          example: my-compliance-engine-1
        type:
          description: The type of Connector. One of Database, File, or Mainframe.
          $ref: '#/components/schemas/ConnectorTypeEnum'
        hostname:
          description: The network hostname or IP address of the database server.
          type: string
          example: database_server.mycompany.co
        port:
          description: The TCP port of the server.
          type: integer
          format: int32
          minimum: 1
          maximum: 65535
          example: 9100
        username:
          description: The username this Connector will use to connect to the database.
          type: string
        password:
          x-dct-toolkit-credential-field: true
          description: The password this Connector will use to connect to the database.
          type: string
        auth_present:
          description: Whether this connector has authentication credentials set
          type: boolean
        database_type:
          description: The database variant, such as Oracle or MSSQL Server
          type: string
          enum:
          - AURORA_POSTGRES
          - DB2
          - DB2_ISERIES
          - DB2_MAINFRAME
          - EXTENDED
          - GENERIC
          - MARIADB
          - MSSQL
          - MYSQL
          - ORACLE
          - POSTGRES
          - RDS_POSTGRES
          - SYBASE
          - YUGABYTEDB_POSTGRES
          - COCKROACHDB_POSTGRES
          example: ORACLE
        custom_driver_name:
          description: The name of the custom JDBC driver for this connector
          type: string
        databa

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