qTest Data Export API

swagger: "2.0"
info:
  title: qTest Data Export
  version: ""
  description: >-
host: "dataexport-0.qtestnet.com"
basePath: /uta/api/v1
externalDocs:
  description: Introduction to qTest Data Export
  url: >-
    https://documentation.tricentis.com/qtest/od/en/content/apis/data_export/data_export_overview.htm
tags:
  - name: AccessFiles
paths:
  /files:
    get:
      tags:
        - AccessFiles
      summary: Produce a list of files.
      description: >-
        Produce a list of files, each with its own filepath. Use this
        information to start a file download.
      parameters:
        - name: apiKey
          type: string
          in: header
          description: The unique API access key for your organization.
          required: true
        - name: directoryFilter
          type: string
          in: query
          description: >-
            The full path of a directory from the root. Use the format
            "qTest/yyyy-MM-dd/<name of the table>". For example, to retrieve all
            files loaded into the builds table on December 4th, 2022, enter the
            value "qtest/2022-12-04/builds". To retrieve all files from a
            specific date, enter the value "qtest/yyyy-MM-dd".
        - name: pageToken
          type: string
          in: query
          description: >-
            The value that points you to the next page of your data, if the data
            you're trying to retrieve exceeds the pageSize value. Use this value
            in a new request to retrieve the next set of data. Once you've
            retrieved all data, the pageToken value is null and the lastPage
            value is true.
        - name: pageSize
          type: integer
          in: query
          description: >-
            The maximum number of objects you want to fetch per request. The
            default is the maximum value of 1000.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ObjectResponse'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponseMessage'
        '500':
          description: Server Error
          schema:
            $ref: '#/definitions/ErrorResponseMessage'
  /file/{filepath}:
    get:
      tags:
        - AccessFiles
      summary: Download a file.
      description: >-
        Download a file from the filepath produced by the GET request /files.
        Files in a folder are listed in increasing numerical order. Read the
        file numbers from least to greatest. For example, 0000_part_00.parquet,
        0000_part_01.parquet, 0001_part_00.parquet, 0001_part_01.parquet, and so
        on.
      parameters:
        - name: filepath
          type: string
          in: path
          description: >-
            The full file path for the file you want to retrieve, including the
            file name.
          required: true
        - name: apiKey
          type: string
          in: header
          description: The unique API access key for your organization.
          required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SuccessResponseMessage'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponseMessage'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponseMessage'
        '500':
          description: Server Error
          schema:
            $ref: '#/definitions/ErrorResponseMessage'
definitions:
  CustomError:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      errors:
        type: array
        items:
          $ref: '#/definitions/CustomErrorMessage'
  CustomErrorMessage:
    type: object
    properties:
      code:
        type: string
      field:
        type: string
      resource:
        type: string
  ErrorResponseMessage:
    type: object
    properties:
      timeStamp:
        type: string
        format: date-time
      error:
        $ref: '#/definitions/CustomError'
  ObjectDetails:
    type: object
    properties:
      uniqueID:
        type: string
      filePath:
        type: string
      createdDate:
        type: string
        format: date-time
      sizeKB:
        type: integer
        format: int64
  ObjectResponse:
    type: object
    properties:
      pageToken:
        type: string
      lastPage:
        type: boolean
      files:
        type: array
        items:
          $ref: '#/definitions/ObjectDetails'
  SuccessResponseMessage:
    type: object
    properties:
      message:
        type: object