Tricentis Test Case API

Test Case API

OpenAPI Specification

tricentis-test-case-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: "[Introduction to qTest API Specification](https://documentation.tricentis.com/qtest/od/en/content/apis/overview/qtest_api_specification.htm) \n[How to use interactive API Doc](https://documentation.tricentis.com/qtest/od/en/content/apis/overview/how_to_use_interactive_api_documentation.htm)\n The bearer token can be found at `[qtestUrl/p/{projectId}/portal/project#tab=resource]` under the API & SDK tab."
  version: v3.0
  title: qTest Manager API Version 3.0 Test Case API
servers:
- url: https://apitryout.qtestnet.com/
tags:
- name: test-case
  description: Test Case API
paths:
  /api/v3/projects/{projectId}/test-cases:
    get:
      tags:
      - test-case
      summary: Gets multiple Test Cases
      description: To retrieve all Test Cases or Test Cases which are located directly under a Module
      operationId: getTestCases
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: parentId
        in: query
        description: Module ID
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        description: By default the first page is returned. However, you can specify any page number to retrieve test cases.
        required: false
        schema:
          type: integer
          format: int64
          default: 1
      - name: size
        in: query
        description: 'The result is paginated. By the default, the number of requirements in each page is 20.


          You can specify your custom number in this parameter.'
        required: false
        schema:
          type: integer
          format: int32
          default: 20
      - name: expandProps
        in: query
        description: By default, Test Case properties are included in the response. specify <em>expandProps=false</em> to exclude them
        required: false
        schema:
          type: boolean
          default: true
      - name: expandSteps
        in: query
        description: By default, Test Steps are excluded from the response body. Input <em>expandSteps=true</em> to include Test Steps
        required: false
        schema:
          type: boolean
          default: false
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      - name: utc
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: modifiedAfter
        in: query
        required: false
        schema:
          type: string
          default: all
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
    post:
      tags:
      - test-case
      summary: Creates a Test Case
      description: 'To create a Test Case


        <strong>qTest Manager version:</strong> 4+'
      operationId: createTestCase
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: agentId
        in: query
        required: false
        schema:
          type: string
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      - name: aiGenerated
        in: query
        description: Indicates that the contents of the Test Step were created using an Artificial Intelligence service.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
        description: 'Test Case properties, Test Steps along with custom field information(if any), Attachments and other information to create a Test Case.


          If <em>parent_id</em> is omitted, the Test Case will be created under "Created via API" Module.


          <em>tosca_guid</em>: GUID of Tosca test case. Use for creating Tosca Test Case.


          <em>tosca_node_path</em>: Node Path of Tosca test case. Use for creating Tosca Test Case.


          <em>tosca_guid</em> and <em>tosca_node_path</em> are optional but must be specified in pair


          Support create test case with Parameters by inputting parameters identifier in teststep''s <em>description</em> with sample like below. Parameters will be automatically added to current project.


          &nbsp;&nbsp;&nbsp;&nbsp;    {

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      "description": "Description [~param1] with [~param2]."

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      ...

          &nbsp;&nbsp;&nbsp;&nbsp;    {'
        required: true
  /api/v3/projects/{projectId}/test-cases/update/testcases:
    put:
      tags:
      - test-case
      summary: Updates multiple test cases
      description: 'To update multiple Test Cases


        <strong>qTest Manager version:</strong> 6+'
      operationId: updateMultipleTestCases
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
        description: 'Test Case properties for all the test cases, Test Steps along with custom field information(if any) to update the Test Case.


          Support update test case with Parameters by inputting parameters identifier in teststep''s <em>description</em> with sample like below. Parameters will be automatically added to current project.


          &nbsp;&nbsp;&nbsp;&nbsp;    {

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      "description": "Description [~param1] with [~param2]."

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      ...

          &nbsp;&nbsp;&nbsp;&nbsp;    {'
        required: true
  /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments:
    get:
      tags:
      - test-case
      summary: Gets all Comments of a Test Case
      description: 'To retrieve all comments of a Test Case


        <strong>qTest Manager version:</strong> 7.5+'
      operationId: getTestCaseComments
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: idOrKey
        in: path
        description: PID or ID of the Test Case whose comments you want to retrieve
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: By default the first page is returned but you can specify any page number to retrieve objects
        required: false
        schema:
          type: integer
          format: int64
          default: 1
      - name: pageSize
        in: query
        description: The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter
        required: false
        schema:
          type: integer
          format: int64
          default: 100
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResourceCommentResource'
      security:
      - Authorization: []
    post:
      tags:
      - test-case
      summary: Adds a Comment to a Test Case
      description: 'To add a Comment to a Test Case


        <strong>qTest Manager version:</strong> 7.5+'
      operationId: addTestCaseComment
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: idOrKey
        in: path
        description: PID or ID of the Test Case
        required: true
        schema:
          type: string
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentResource'
        description: The comment's properties and its content
        required: true
  /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}:
    get:
      tags:
      - test-case
      summary: Gets a Comment of a Test Case
      description: 'To retrieve a comment of a Test Case


        <strong>qTest Manager version:</strong> 7.5+'
      operationId: getTestCaseCommentById
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: idOrKey
        in: path
        description: PID or ID of the Test Case
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: ID of the comment.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentResource'
      security:
      - Authorization: []
    put:
      tags:
      - test-case
      summary: Updates a Comment of a Test Case
      description: 'To modify a comment of a Test Case


        <strong>qTest Manager version:</strong> 7.5+'
      operationId: updateTestCaseComment
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: idOrKey
        in: path
        description: PID or ID of the Test Case
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: ID of the comment.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentResource'
        description: The comment's updated content
        required: true
    delete:
      tags:
      - test-case
      summary: Deletes a Comment of a Test Case
      description: 'To delete a comment of a Test Case


        <strong>qTest Manager version:</strong> 7.5+'
      operationId: deleteTestCaseComment
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: idOrKey
        in: path
        description: PID or ID of the Test Case
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: ID of the comment.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: successful operation
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}:
    get:
      tags:
      - test-case
      summary: Gets a Test Case
      description: 'To retrieve a Test Case


        <strong>qTest Manager version:</strong> 6+'
      operationId: getTestCase
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: PID or ID of the Test Case
        required: true
        schema:
          type: string
      - name: versionId
        in: query
        description: ID of the Test Case version
        required: false
        schema:
          type: integer
          format: int64
      - name: expand
        in: query
        description: By default, Test Steps are excluded from the response. Specify <em>expand=teststep</em> to include Test Steps
        required: false
        schema:
          type: string
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
    put:
      tags:
      - test-case
      summary: Updates a Test Case
      description: 'To update a Test Case


        <strong>qTest Manager version:</strong> 6+'
      operationId: updateTestCase
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case which needs to be updated.
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
        description: 'Test Case properties, Test Steps along with custom field information(if any) to update the Test Case.


          Support update test case with Parameters by inputting parameters identifier in teststep''s <em>description</em> with sample like below. Parameters will be automatically added to current project.


          &nbsp;&nbsp;&nbsp;&nbsp;    {

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      "description": "Description [~param1] with [~param2]."

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      ...

          &nbsp;&nbsp;&nbsp;&nbsp;    {'
        required: true
    delete:
      tags:
      - test-case
      summary: Deletes a Test Case
      description: 'To delete Test Case


        <strong>qTest Manager version:</strong> 6+'
      operationId: deleteTestCase
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case which needs to be deleted.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: ''
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/approve:
    put:
      tags:
      - test-case
      summary: Approves a Test Case
      description: 'To approve a Test Case


        <strong>qTest Manager version:</strong> 7.4+'
      operationId: approveTestCase
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps:
    get:
      tags:
      - test-case
      summary: Gets Test Steps of a Test Case
      description: 'To retrieve all Test Steps of a Test Case''s latest version


        <strong>qTest Manager version:</strong> 6+'
      operationId: getTestSteps
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestStepResource'
      security:
      - Authorization: []
    post:
      tags:
      - test-case
      summary: Creates a Test Step
      description: 'To add a Test Step to a Test Case''s latest version


        <strong>qTest Manager version:</strong> 6+'
      operationId: addTestStep
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestStepResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestStepResource'
        description: 'Given resource will add or create a test step and its CustomField columns details.


          Support create test step with Parameters by inputting parameters identifier in teststep''s <em>description</em> with sample like below. Parameters will be automatically added to current project.


          &nbsp;&nbsp;&nbsp;&nbsp;    {

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      "description": "Description [~param1] with [~param2]."

          &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      ...

          &nbsp;&nbsp;&nbsp;&nbsp;    {'
        required: true
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}:
    get:
      tags:
      - test-case
      summary: Gets a Test Step
      description: 'To retrieve a Test Step of a Test Case''s latest version


        <strong>qTest Manager version:</strong> 6+'
      operationId: getTestStep
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: stepId
        in: path
        description: "ID of the test step. \n\nThe ObjectId of customFieldInfo is used as a StepId here."
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestStepResource'
      security:
      - Authorization: []
    put:
      tags:
      - test-case
      summary: Update a Test Step
      description: 'To update a Test Step of a Test Case''s latest version


        <strong>qTest Manager version:</strong> 6+'
      operationId: updateTestStep
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: stepId
        in: path
        description: ID of the Test Step
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestStepResource'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestStepResource'
        description: "Updated content of the Test Step for test case ID or PID \n\nThis Shows the updated CustomFields id, as well as you will get the updated stepId which will be ObjectId.\n\nSupport update test step with Parameters by inputting parameters identifier in teststep's <em>description</em> with sample like below. Parameters will be automatically added to current project.\n\n&nbsp;&nbsp;&nbsp;&nbsp;    {\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      \"description\": \"Description [~param1] with [~param2].\"\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      ...\n&nbsp;&nbsp;&nbsp;&nbsp;    {"
        required: true
    delete:
      tags:
      - test-case
      summary: Deletes a Test Step
      description: 'To delete a test step of a Test Case


        <strong>qTest Manager version:</strong> 6+'
      operationId: deleteTestStep
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: stepId
        in: path
        description: ID of the Test Step
        required: true
        schema:
          type: integer
          format: int64
      - name: updateVersion
        in: query
        description: If specified updateVersion=true, then the test case version will be updated when the test step is deleted.
        required: false
        schema:
          type: boolean
          default: true
      responses:
        default:
          description: successful operation
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/vera/approve:
    put:
      tags:
      - test-case
      summary: test-case.vera.approve
      description: ''
      operationId: approveTestCaseByVera
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions:
    get:
      tags:
      - test-case
      summary: Gets all versions of a Test Case
      description: 'Get all versions of a Test Case.


        Example:


        API returns all approved major test case versions and the last unapproved minor version if there is one.


        <li>if version history is 1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 3.2; it will only return versions 1.0, 2.0, 3.0 and 3.2</li><li>if the version history is 1.0, 1.1, 2.0, 2.1, 2.2, 3.0; it will only return versions 1.0, 2.0, and 3.0</li><li>if the version history is 0.1, 0.2, 0.3, 0.4; it will only return version 0.4</li><strong>qTest Manager version:</strong> 7.4+'
      operationId: getVersions
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the test case
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}:
    get:
      tags:
      - test-case
      summary: Gets a version of a Test Case
      description: 'To retrieve a specific version of a Test Case


        <strong>qTest Manager version:</strong> 4+'
      operationId: getTestCaseVersionById
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: versionId
        in: path
        description: ID of the Test Case version
        required: true
        schema:
          type: integer
          format: int64
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to change to Identifier text mode. Result should be like "<strong>[~myIdentifier]</strong>".
        required: false
        schema:
          type: boolean
          default: false
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCaseWithCustomFieldResource'
      security:
      - Authorization: []
  /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}/test-steps:
    get:
      tags:
      - test-case
      summary: Gets Test Steps of a Test Case version
      description: To retrieve all Test Steps of a specific Test Case version
      operationId: getTestStepsByVersion
      parameters:
      - name: projectId
        in: path
        description: ID of the project
        required: true
        schema:
          type: integer
          format: int64
      - name: testCaseId
        in: path
        description: ID of the Test Case
        required: true
        schema:
          type: integer
          format: int64
      - name: versionId
        in: path
        description: ID of the Test Case version
        required: true
        schema:
          type: integer
          format: int64
      - name: expand
        in: query
        description: "when you Specify <em>expand=calledteststep</em> \n\nIt will include Test Steps of the called Test Cases in your response."
        required: false
        schema:
          type: string
          enum:
          - calledteststep
      - name: showParamIdentifier
        in: query
        description: By default, Parameters in Test Steps are displayed in ID number mode (like "<strong>[~123]</strong>"). Input <strong><em>showParamIdentifier=true</em></strong> to chan

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-test-case-api-openapi.yml