Delphix DataClasses API

openapi: 3.2.0
info:
  title: Delphix DCT Algorithms Data Classes 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: DataClasses
paths:
  /data-classes:
    get:
      tags:
      - DataClasses
      summary: Retrieve the list of Data Classes.
      operationId: get_data_classes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dataClassesSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DataClassesListResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataClass'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - DataClasses
      summary: Create a Data Class.
      operationId: create_data_class
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: data_class_create_request
              $ref: '#/components/schemas/DataClassCreateRequest'
        description: The new Data Class to create
        required: true
      responses:
        '201':
          description: Data Class creation initiated.
          content:
            application/json:
              schema:
                type: object
                title: DataClassCreateResponse
                properties:
                  id:
                    type: string
                    description: The ID of the created data class.
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /data-classes/search:
    post:
      tags:
      - DataClasses
      summary: Search for Data Classes.
      operationId: search_data_classes
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          default_algorithm_id:
            type: string
          default_algorithm_name:
            type: string
          default_token_algorithm_id:
            type: string
          default_token_algorithm_name:
            type: string
          algorithm_ids:
            type: array[string]
          algorithms:
            type: array[object]
            fields:
              id:
                type: string
              name:
                type: string
          description:
            type: string
          example:
            type: string
          revision_hash:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          creation_date:
            type: string
          account_id:
            type: integer
          account_name:
            type: string
          dct_managed:
            type: boolean
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dataClassesSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DataClassesSearchResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataClass'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /data-classes/{dataClassId}:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    get:
      tags:
      - DataClasses
      summary: Get a Data Class by ID.
      operationId: get_data_class_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataClass'
    patch:
      tags:
      - DataClasses
      summary: Update a Data Class.
      operationId: update_data_class
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: data_class_update_request
              $ref: '#/components/schemas/DataClassUpdateRequest'
        description: Update a Data Class.
        required: true
      responses:
        '200':
          description: Data Class update initiated.
          content:
            application/json:
              schema:
                type: object
                title: DataClassUpdateResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - DataClasses
      summary: Delete a Data Class.
      operationId: delete_data_class
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DataClassDeleteResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The completed job.
  /data-classes/{dataClassId}/algorithms:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    get:
      tags:
      - DataClasses
      summary: Retrieve the list of algorithms for a Data Class.
      operationId: get_data_class_algorithms
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/algorithmsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListAlgorithmsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Algorithm'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - DataClasses
      summary: Add algorithms to a Data Class.
      operationId: add_data_class_algorithms
      requestBody:
        description: Algorithms to add to a Data Class.
        content:
          application/json:
            schema:
              x-body-name: DataClassAddAlgorithmsRequestBody
              $ref: '#/components/schemas/DataClassAddAlgorithmsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DataClassAddAlgorithmsResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /data-classes/{dataClassId}/algorithms/remove:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    post:
      tags:
      - DataClasses
      summary: Remove algorithms from a Data Class.
      operationId: remove_data_class_algorithms
      requestBody:
        description: Algorithms to remove from a Data Class.
        content:
          application/json:
            schema:
              x-body-name: DataClassRemoveAlgorithmsRequestBody
              $ref: '#/components/schemas/DataClassRemoveAlgorithmsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DataClassRemoveAlgorithmsResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /data-classes/{dataClassId}/algorithms/search:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    post:
      tags:
      - DataClasses
      summary: Search for algorithms of a Data Class.
      operationId: search_data_class_algorithms
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          description:
            type: string
          framework_name:
            type: string
          framework_id:
            type: string
          plugin_name:
            type: string
          plugin_id:
            type: string
          engine_name:
            type: string
          engine_id:
            type: string
          revision_hash:
            type: string
          create_date:
            type: string
          config_invalid:
            type: boolean
          is_tokenization_supported:
            type: boolean
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/algorithmsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchAlgorithmsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Algorithm'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /data-classes/{dataClassId}/tags:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    get:
      tags:
      - DataClasses
      summary: Get tags for a Data Class.
      operationId: get_data_class_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    post:
      tags:
      - DataClasses
      summary: Create tags for a Data Class.
      operationId: create_data_class_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: data_class_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Data Class.
        required: true
      responses:
        '201':
          description: Data Class tags created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /data-classes/{dataClassId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/dataClassIdParam'
    post:
      tags:
      - DataClasses
      summary: Delete tags for a Data Class.
      operationId: delete_data_class_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
components:
  schemas:
    DataClassRemoveAlgorithmsRequest:
      description: Remove algorithms from a Data Class.
      type: object
      required:
      - algorithm_ids
      properties:
        algorithm_ids:
          description: The list of algorithm IDs to add to this data class.
          type: array
          maxItems: 500
          uniqueItems: true
          items:
            type: string
          example:
          - a638d976-6b7e-43f4-9212-90f4dc6d405c
          - 414ed52c-fa89-455d-9fb9-9c2fa5115f80
    DataClassAlgorithmInfo:
      description: Information about a data class algorithm.
      type: object
      properties:
        id:
          description: The algorithm ID.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        name:
          description: The algorithm name.
          type: string
          example: Masking Algorithm
        masking_type:
          description: The masking type of the algorithm.
          $ref: '#/components/schemas/MaskingTypeEnum'
        fields:
          description: The list of fields if it is a multi-column/multi-condition algorithm.
          type: array
          items:
            $ref: '#/components/schemas/AlgorithmField'
    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
    VirtualizationTaskEvent:
      deprecated: true
      properties:
        message_details:
          type: string
    DataClassAddAlgorithmsRequest:
      description: Algorithms to add to a Data Class.
      type: object
      required:
      - algorithm_ids
      properties:
        algorithm_ids:
          description: The list of algorithm IDs to remove from this data class.
          type: array
          maxItems: 500
          uniqueItems: true
          items:
            type: string
          example:
          - a638d976-6b7e-43f4-9212-90f4dc6d405c
          - 414ed52c-fa89-455d-9fb9-9c2fa5115f80
    DataClassUpdateRequest:
      description: Parameters used to update a Data Class.
      type: object
      properties:
        name:
          description: The name of this data class.
          type: string
          example: Account Number
        default_algorithm_id:
          description: The ID of the default masking algorithm for this data class.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        default_token_algorithm_id:
          description: The ID of the default tokenization algorithm for this data class.
          type:
          - string
          - 'null'
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        description:
          description: A description of this data class.
          type:
          - string
          - 'null'
          example: This data class is used for account numbers.
        example:
          description: An example data value for this data class.
          type:
          - string
          - 'null'
          maxLength: 200
          example: abc-123
    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"
    Algorithm:
      description: A masking algorithm.
      type: object
      properties:
        id:
          description: The algorithm entity ID.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        name:
          description: The name of this algorithm.
          type: string
          example: Address
        description:
          description: A description of this algorithm.
          type:
          - string
          - 'null'
        plugin_name:
          description: The name of the plugin that this algorithm belongs to.
          type: string
          example: dlpx-core
        plugin_id:
          description: The id of the plugin that this algorithm belongs to.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        framework_name:
          description: The name of the framework that this algorithm belongs to.
          type: string
          example: Secure Lookup
        framework_id:
          description: The id of the framework that this algorithm belongs to.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        engine_name:
          description: The name of the origin engine that this algorithm belongs to.
          type: string
          example: Compliance Engine 1
        engine_id:
          description: The id of the origin engine that this algorithm belongs to.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        revision_hash:
          description: The export revision hash of this algorithm from the source engine.
          type: string
          example: 90f4dc6d405c
        config:
          description: The configuration of this algorithm.
          type: object
          additionalProperties: true
        create_date:
          description: The date and time this algorithm was created.
          type: string
          format: date-time
          example: '2022-11-30T08:51:34.148000+00:00'
        account_id:
          description: The ID of the account who created this algorithm.
          type: integer
          format: int64
          readOnly: true
          example: 1
        account_name:
          description: The account name of the DCT user who created this algorithm.
          type: string
          readOnly: true
          example: John Doe
        dct_managed:
          description: Whether this algorithm is managed by DCT or not.
          type: boolean
          readOnly: true
        config_invalid:
          description: Whether this algorithm has invalid configuration. Config may become invalid following a DCT upgrade due to changes in the plugin. This field is only applicable to DCT managed algorithms.
          type: boolean
          readOnly: true
        is_default_instance:
          description: Whether this algorithm is defined in the plugin.
          type: boolean
          readOnly: true
        is_tokenization_supported:
          description: Whether this algorithm supports tokenization (re-identification). Depends on the algorithm configuration.
          type:
          - boolean
          - 'null'
          readOnly: true
        fields:
          description: The list of fields if it is a multi-column/multi-condition algorithm.
          type: array
          items:
            $ref: '#/components/schemas/AlgorithmField'
        tags:
          description: The tags of this algorithm.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    TagsResponse:
      type: object
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    AlgorithmField:
      description: The algorithm field details for a multi-column/multi-condition algorithm
      type: object
      properties:
        id:
          description: The id of the algorithm field.
          type: string
          example: 20b4692e-381d-40a0-a46e-0ba7658acaf3
          readOnly: true
        name:
          description: The name of the algorithm field.
          type: string
          example: ADDRESS_LINE1
          readOnly: true
        type:
          description: The type of algorithm field.
          type: string
          enum:
          - BIG_DECIMAL
          - LOCAL_DATE_TIME
          - STRING
          - BYTE_BUFFER
          example: STRING
          readOnly: true
        is_read_only:
          description: Indicates whether the field is read-only. Read-only fields are taken as input by the masking algorithm but not masked.
          type: boolean
          readOnly: true
        is_optional:
          description: Indicates whether the field is optional. Optional fields do not have to be assigned to a real data field or column in order for a masking assignment to be considered valid.
          type: boolean
          readOnly: true
        description:
          description: The description of the algorithm field.
          type: string
          readOnly: true
    Tag:
      type: object
      required:
      - key
      - value
      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
    DataClassCreateRequest:
      description: Parameters used to create a Data Class.
      type: object
      properties:
        name:
          description: The name of this data class.
          type: string
          example: Account Number
        default_algorithm_id:
          description: The ID of the default masking algorithm for this data class.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        default_token_algorithm_id:
          description: The ID of the default tokenization algorithm for this data class.
          type:
          - string
          - 'null'
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        algorithm_ids:
          description: The list of algorithm IDs available for this data class.
          type: array
          maxItems: 500
          uniqueItems: true
          items:
            type: string
          example:
          - a638d976-6b7e-43f4-9212-90f4dc6d405c
          - 414ed52c-fa89-455d-9fb9-9c2fa5115f80
        description:
          description: A description of this data class.
          type:
          - string
          - 'null'
          example: This data class is used for account numbers.
        example:
          description: An example data value for this data class.
          type:
          - string
          - 'null'
          maxLength: 200
          example: abc-123
        tags:
          description: The tags for this data class.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        make_current_account_owner:
          type: boolean
          default: true
          description: Whether the account creating this data class must be configured as owner of it.
    DataClass:
      description: A data class.
      type: object
      properties:
        id:
          description: The data class ID.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        name:
          description: The name of this data class.
          type: string
          example: Account Number
        description:
          description: A description of this data class.
          type:
          - string
          - 'null'
        default_algorithm_id:
          description: The ID of the default masking algorithm for this data class.
          type:
          - string
          - 'null'
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        default_algorithm_name:
          description: The name of the default masking algorithm for this data class.
          type:
          - string
          - 'null'
          example: alg1
        default_token_algorithm_id:
          description: The ID of the default tokenization algorithm for this data class.
          type:
          - string
          - 'null'
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        default_token_algorithm_name:
          description: The default tokenization algorithm for this data class.
          type:
          - string
          - 'null'
          example: alg2
        algorithm_ids:
          deprecated: true
          description: The list of algorithm IDs available for this data class.
          type: array
          items:
            type: string
          example:
          - a638d976-6b7e-43f4-9212-90f4dc6d405c
          - 414ed52c-fa89-455d-9fb9-9c2fa5115f80
        algorithms:
          description: The list of algorithm IDs and names available for this data class.
          type: array
          items:
            $ref: '#/components/schemas/DataClassAlgorithmInfo'
        example:
          description: An example data value for this data class.
          type:
          - string
          - 'null'
          maxLength: 200
        revision_hash:
          description: The export revision hash of this data class from the source engine.
          type:
          - string
          - 'null'
          example: 6e0509df463cf714b2697ccf2f8ac972970021d1
        engine_id:
          description: The ID of the engine that this data class originated from.
          type:
          - string
          - 'null'
        engine_name:
          description: The name of the engine that this data class originated from.
          type:
          - string
          - 'null'
        creation_date:
          type: string
          readOnly: true
          description: The date this data class was created.
          format: date-time
          example: '2022-11-30T08:51:34.148000+00:00'
        account_id:
          description: The ID of the account who created this data class.
          type: integer
          format: int64
          readOnly: true
          example: 1
        account_name:
          description: The account name of the DCT user who created this data class.
          type: string
          readOnly: true
          example: username
        dct_managed:
          description: Whether this data class is managed by DCT or not.
          type: boolean
          readOnly: true
        built_in:
          description: Whether this data class is built-in or user-defined.
          type: boolean
          readOnly: true
        tags:
          description: The tags of this data class.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    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'
    JobTaskEvent:
      properties:
        message_details:
          type: string
    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
    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
    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
    PaginatedResponseMetadata:
      type: object
      properties:
        pr

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