Delphix JobCollectionExecutions API

openapi: 3.0.0
info:
  title: Delphix DCT Algorithms JobCollectionExecutions 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: JobCollectionExecutions
paths:
  /job-collection-executions:
    get:
      tags:
      - JobCollectionExecutions
      summary: Retrieve the list of compliance job collection executions.
      operationId: get_job_collection_executions
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/jobCollectionExecutionsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListJobCollectionExecutionsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/JobCollectionExecution'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /job-collection-executions/search:
    post:
      tags:
      - JobCollectionExecutions
      summary: Search compliance job collection executions.
      operationId: search_job_collection_executions
      x-filterable:
        fields:
          id:
            type: string
          compliance_job_collection_id:
            type: string
          compliance_job_collection_name:
            type: string
          status:
            type: string
          status_reason:
            type: string
          start_time:
            type: string
          end_time:
            type: string
          run_duration:
            type: integer
          actual_execution_count:
            type: integer
          planned_execution_count:
            type: integer
          rows_processed:
            type: integer
          rows_total:
            type: integer
          bytes_processed:
            type: integer
          bytes_total:
            type: integer
          processed_tables_files_count:
            type: integer
          tables_files_count:
            type: integer
          processed_columns_fields_count:
            type: integer
          columns_fields_count:
            type: integer
          execute_account_id:
            type: integer
          execute_account_name:
            type: string
          cancel_account_id:
            type: integer
          cancel_account_name:
            type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/jobCollectionExecutionsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchJobCollectionExecutionsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/JobCollectionExecution'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /job-collection-executions/{jobCollectionExecutionId}:
    parameters:
    - $ref: '#/components/parameters/jobCollectionExecutionIdParam'
    get:
      tags:
      - JobCollectionExecutions
      summary: Retrieve a compliance job collection execution by ID.
      operationId: get_job_collection_execution_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCollectionExecution'
  /job-collection-executions/{jobCollectionExecutionId}/cancel:
    parameters:
    - $ref: '#/components/parameters/jobCollectionExecutionIdParam'
    post:
      tags:
      - JobCollectionExecutions
      summary: Cancel a compliance job collection execution. This operation is asynchronous is not complete until the collection execution is marked cancelled.
      operationId: cancel_job_collection_execution
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelJobCollectionExecutionRequest'
      responses:
        '200':
          description: Job collection execution cancel initiated.
          content:
            application/json:
              schema:
                type: object
                title: CancelJobCollectionExecutionResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The finished cancel job.
components:
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
      example: 50
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
    jobCollectionExecutionIdParam:
      in: path
      name: jobCollectionExecutionId
      schema:
        type: string
        minLength: 1
      required: true
      description: The ID of the job collection execution.
    jobCollectionExecutionsSortParam:
      name: sort
      in: query
      description: The field to sort results by. A property name with a prepended '-' signifies a descending order.
      required: false
      schema:
        type: string
        enum:
        - id
        - -id
        - compliance_job_collection_id
        - -compliance_job_collection_id
        - compliance_job_collection_name
        - -compliance_job_collection_name
        - status
        - -status
        - status_reason
        - -status_reason
        - start_time
        - -start_time
        - end_time
        - -end_time
        - run_duration
        - -run_duration
        - actual_execution_count
        - -actual_execution_count
        - planned_execution_count
        - -planned_execution_count
        - rows_processed
        - -rows_processed
        - rows_total
        - -rows_total
        - bytes_processed
        - -bytes_processed
        - bytes_total
        - -bytes_total
        - processed_tables_files_count
        - -processed_tables_files_count
        - tables_files_count
        - -tables_files_count
        - processed_columns_fields_count
        - -processed_columns_fields_count
        - columns_fields_count
        - -columns_fields_count
        - execute_account_id
        - -execute_account_id
        - execute_account_name
        - -execute_account_name
        - cancel_account_id
        - -cancel_account_id
        - cancel_account_name
        - -cancel_account_name
        nullable: true
        example: start_time
    cursor:
      name: cursor
      in: query
      description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.
      schema:
        type: string
        minLength: 1
        maxLength: 4096
  schemas:
    JobTaskEvent:
      properties:
        message_details:
          type: string
    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
    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
    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
    CancelJobCollectionExecutionRequest:
      type: object
      description: Parameters to execute a compliance job collection.
    VirtualizationTaskEvent:
      deprecated: true
      properties:
        message_details:
          type: string
    JobCollectionExecution:
      description: The execution of a compliance job collection.
      type: object
      properties:
        id:
          description: The job collection execution ID.
          type: string
          example: 414ed52c-fa89-455d-9fb9-9c2fa5115f80
        compliance_job_collection_id:
          description: The ID of the compliance job collection executed.
          type: string
          example: 5ed2357d-21a7-310c-b951-a0f0edc1a0f6
        compliance_job_collection_name:
          description: The name of the compliance job collection executed.
          type: string
          example: My Job Collection
        status:
          $ref: '#/components/schemas/ExecutionStatus'
        status_reason:
          $ref: '#/components/schemas/ExecutionStatusReason'
        start_time:
          description: The date and time that this job collection execution started.
          type: string
          format: date-time
          example: '2021-05-01T09:51:34.148000+00:00'
        end_time:
          description: The date and time that this job collection execution completed.
          type: string
          format: date-time
          example: '2021-05-01T09:55:34.148000+00:00'
        run_duration:
          description: The time this job collection execution spent running, in milliseconds.
          type: integer
          format: int64
          example: 4000
        actual_execution_count:
          description: The number of compliance jobs that were actually executed.
          type: integer
          format: int32
          example: 5
        planned_execution_count:
          description: The number of compliance jobs that were planned to be executed.
          type: integer
          format: int32
          example: 7
        rows_processed:
          description: The number of rows processed so far by this job collection execution. This is not applicable for JSON file type.
          type: integer
          format: int64
          example: 1000
        rows_total:
          description: The total number of rows for this job collection execution. This value is set after the job collection execution has completed successfully. This is not applicable for JSON file type.
          type: integer
          format: int64
          example: 5000
        bytes_processed:
          description: The number of bytes processed so far by this job collection execution. This is only applicable for JSON file type.
          type: integer
          format: int64
          example: 500
        bytes_total:
          description: The total number of bytes for this job collection execution. This value is set after the job collectione execution has completed successfully. This is only applicable for JSON file type.
          type: integer
          format: int64
          example: 5000000
        processed_tables_files_count:
          description: The number of tables or files processed so far by this job collection execution.
          type: integer
          format: int64
          example: 5
        tables_files_count:
          description: The total number of tables or files for this job collection execution.
          type: integer
          format: int64
          example: 10
        processed_columns_fields_count:
          description: The number of columns or fields processed so far by this job collection execution.
          type: integer
          format: int64
          example: 50
        columns_fields_count:
          description: The total number of columns or fields for this job collection execution.
          type: integer
          format: int64
          example: 100
        percent_complete:
          description: The percentage of completion of this job collection execution.
          type: integer
          format: int32
          example: 20
        execute_account_id:
          description: The account id of the DCT user who started this job collection execution.
          type: integer
          format: int64
          example: 3
        execute_account_name:
          description: The account name of the DCT user who started this job collection execution.
          type: string
          example: John Doe
        cancel_account_id:
          description: The account id of the DCT user who cancelled this job collection execution.
          type: integer
          format: int64
          example: 3
        cancel_account_name:
          description: The account name of the DCT user who cancelled this job collection execution.
          type: string
          example: John Doe
    ExecutionStatus:
      description: The status of a masking or discovery job.
      type: string
      enum:
      - PENDING
      - QUEUED
      - RUNNING
      - CANCELLED
      - FAILED
      - SUCCEEDED
      - WARNING
      - WAITING
      example: RUNNING
    ExecutionStatusReason:
      description: The reason for the status of a compliance job collection execution.
      type: string
      enum:
      - NONE
      - JOB_FAILURE
      - RESOURCE_UNREACHABLE
      - DCT_JOB_CANCEL
      - ENGINE_JOB_CANCEL
      - JOB_MISSING
      example: JOB_MISSING
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    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
          description: The ID of the associated compliance node, if applicable.
          nullable: true
        compliance_node_name:
          type: string
          description: The name of the associated compliance node, if applicable.
          nullable: true
        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
          nullable: true
        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:
        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
    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"
  requestBodies:
    SearchBody:
      x-skip-codegen-attr: description
      description: 'A request body containing a filter expression. This enables searching

        for items matching arbitrarily complex conditions. The list of

        attributes which can be used in filter expressions is available

        in the x-filterable vendor extension.


        # Filter Expression Overview

        **Note: All keywords are case-insensitive**


        ## Comparison Operators

        | Operator | Description | Example |

        | --- | --- | --- |

        | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE  |

        | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] |

        | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |

        | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |

        | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |

        | LT | Tests if a field is less than a literal value | field1 LT 9.02 |

        | NE | Tests if a field is not equal to a literal value | field1 NE 42 |

        | EQ | Tests if a field is equal to a literal value | field1 EQ 42 |


        ## Search Operator

        The SEARCH operator filters for items which have any filterable

        attribute that contains the input string as a substring, comparison

        is done case-insensitively. This is not restricted to attributes with

        string values. Specifically `SEARCH ''12''` would match an item with an

        attribute with an integer value of `123`.


        ## Logical Operators

        Ordered by precedence.

        | Operator | Description | Example |

        | --- | --- | --- |

        | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |

        | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' |

        | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' |


        ## Grouping

        Parenthesis `()` can be used to override operator precedence.


        For example:

        NOT (field1 LT 1234 AND field2 CONTAINS ''foo'')


        ## Literal Values

        | Literal      | Description | Examples |

        | --- | --- | --- |

        | Nil | Represents the absence of a value | nil, Nil, nIl, NIL |

        | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |

        | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |

        | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' |

        | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |

        | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] |


        ## Limitations

        - A maximum of 8 unique identifiers may be used inside a filter expression.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SearchBody'
          examples:
            nested:
              description: 'An example of a nested Object comparison testing that at least one repository has a

                version which is equal to 19.0.0.

                '
              summary: Nested Object Comparison
              value:
                filter_expression: repositories CONTAINS {version eq '19.0.0'}
            relative:
              description: 'An example of a relative comparison testing that field1 has a

                value which is less than 123.

                '
              summary: Relative comparison
              value:
                filter_expression: field1 LE 123
            nil:
              description: 'An example of using nil to test for the absence of a value for field2.

                '
              summary: Absence of an attribute value
              value:
                filter_expression: field2 EQ NIL
            non-nil:
              description: 'An example of using nil to test for the existence of a value for field2.

                '
              summary: Existence of an attribute value
              value:
                filter_expression: field2 NE NIL
            contains:
              description: 'An example of using the ''CONTAINS'' operator to check if

                field2 contains the string ''foo''. If field2 is string valued

                then this is checking if ''foo'' is a substring of field2. If

                field2 is a list of strings then this is checking if ''foo''

                is a member of the list.

                '
              summary: Use of the CONTAINS operator
              value:
                filter_expression: field2 CONTAINS 'foo'
            in:
              description: 'An example of using the ''IN'' operator to check if field1

                is an element of a list literal.

                '
              summary: Use of the IN operator
              value:
                filter_expression: field1 IN [1, 2, 3]
            search:
              description: 'An example of using the ''SEARCH'' operator to retrieve all elements

                for which ''foo'' is a substring of a filterable attribute.

                '
              summary: Use of the SEARCH operator
              value:
                filter_expression: SEARCH 'foo'
            parenthesis:
              description: 'An example of parenthesis being used to group operators & override

                operator precedence.

                '
              summary: Overriding operator precedence
              value:
                filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar')
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization