Generated by API Evangelist
Written by API Evangelist tooling for Tricentis's API. It is a proposal applied on top of the contract, not a document Tricentis publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 Search API
version: 1.0.0
extends: openapi/tricentis-search-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/v3/projects/{projectId}/comments'].post
update:
x-apievangelist-phrasing:
intent: Search comments in a project
effect: read
questions:
- Can I find comments left by a particular author on test cases?
- How do I search comments within a date range?
instructions:
- text: Search {otype} comments in project {project}.
slots:
otype: requestBody.object_type
project: path.projectId
- text: Find {otype} comments by {author} in project {project} between {start} and {end}.
slots:
otype: requestBody.object_type
author: requestBody.author
project: path.projectId
start: requestBody.start
end: requestBody.end
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/histories'].post
update:
x-apievangelist-phrasing:
intent: Query change history of objects
effect: read
questions:
- Who changed this requirement and what did they change?
- Can I query the audit history of test runs or defects?
instructions:
- text: Get the change history of {otype} in project {project}.
slots:
otype: requestBody.object_type
project: path.projectId
- text: Query {otype} histories in project {project} matching {query}.
slots:
otype: requestBody.object_type
project: path.projectId
query: requestBody.query
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/search'].post
update:
x-apievangelist-phrasing:
intent: Query requirements, test cases, runs or defects
effect: read
questions:
- Can I run the same data query I use in the web app through the API?
- Can I include test steps when searching test cases?
instructions:
- text: Query {otype} in project {project} where {query}.
slots:
otype: requestBody.object_type
project: path.projectId
query: requestBody.query
- text: Search {otype} in project {project} and return fields {fields}.
slots:
otype: requestBody.object_type
project: path.projectId
fields: requestBody.fields
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.