qTest Explorer Sessions API
The Tricentis qTest Explorer Sessions REST API for exploratory testing — sessions, screens, application and system information, resources, coverage, view settings and script generation.
OpenAPI Specification
swagger: "2.0"
info:
title: "qTest Explorer | Sessions API"
version: "1.0.0"
description: "These APIs are for internal reference by Tricentis development team only. They are not intended to be used publicly by any qTest or non-qTest users and so there is no support provided by Tricentis at any level. If you want to access these APIs, please send a support ticket to support@tricentis.com."
host: "session-js.qtestnet.com"
basePath: "/"
tags:
### V2 tags
- name: v2-session
description: "Session V2 APIs"
- name: v2-screen
description: "Screen V2 APIs"
- name: v2-application-information
description: "Application Information V2 APIs"
- name: v2-system-information
description: "System Information V2 APIs"
- name: v2-resource
description: "Resource V2 APIs"
- name: v2-view-setting
description: "view settings V2 APIs"
- name: v2-coverage
description: "Coverage V2 APIs"
- name: v2-script-generator-plugin
description: "Plugin V2 APIs"
- name: v2-project-settings
description: "Project settings V2 APIs"
- name: v2-project
description: "Project V2 APIs"
### V3 tags
- name: v3-application-information
description: "Application Information V3 APIs"
- name: v3-session
description: "Session V3 APIs"
- name: v3-screen
description: "Screen V3 APIs"
- name: v3-system-information
description: "System Information V3 APIs"
- name: v3-coverage
description: "Coverage V3 APIs"
- name: v3-resource
description: "Resource V3 APIs"
- name: v3-query
description: "Query V3 APIs"
- name: v3-upload
description: "Upload V3 APIs"
- name: v3-config
description: "Config V3 APIs"
- name: v3-search
description: "Search V3 APIs"
- name: v3-export
description: "Export V3 APIs"
- name: v3-project-settings
description: "Project settings V3 APIs"
### V4 tags
- name: v4-query
description: "Query V4 APIs"
paths:
### V2 APIs
/view-settings:
get:
tags:
- v2-view-setting
summary: Get view settings of sessions list in qTest Manager
parameters:
- name: "projectId"
in: query
type: integer
format: "int64"
description: qTest Manager project's id
required: true
- name: "objectId"
in: query
type: integer
format: "int64"
description: qTest Manager object's id
required: true
- name: "objectTypeId"
in: query
type: integer
format: "int64"
description: qTest Manager object type's id
required: true
responses:
200:
description: "View settings of sessions list in qTest Manager"
schema:
$ref: "#/definitions/ViewSettings"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.customView
put:
tags:
- v2-view-setting
summary: Update view settings of sessions list in qTest Manager
parameters:
- name: "projectId"
in: query
type: integer
format: "int64"
description: qTest Manager project's id
required: true
- name: "body"
in: body
description: "Application information object"
required: true
schema:
type: "object"
$ref: "#/definitions/ViewSettings"
responses:
201:
description: "aplication information is created successful"
schema:
$ref: "#/definitions/ViewSettings"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.customView
/sessions:
post:
tags:
- v2-session
summary: Create a session.
description: ""
parameters:
- in: "body"
name: "body"
description: "Session object that needs to be created."
required: true
schema:
$ref: "#/definitions/CreateSession"
responses:
201:
description: "Session object"
schema:
$ref: "#/definitions/Session"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
/sessions/{sessionId}:
get:
tags:
- v2-session
summary: "Get session by Id"
parameters:
- name: "sessionId"
in: "path"
description: "ID of session to return"
required: true
type: "integer"
format: "int64"
- name: "include"
in: "query"
description: "Get more infos of session, chain query with comma, Ex: time-line,app-infos"
type: "string"
default: "all"
items:
type: string
enum:
- "all"
- "time-lines"
- "app-infos"
- "sys-infos"
responses:
200:
description: "session object"
schema:
$ref: "#/definitions/Session"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
put:
tags:
- v2-session
summary: "Update session by Id"
parameters:
- name: "sessionId"
in: "path"
description: "ID of session to return"
required: true
type: "integer"
format: "int64"
- name: body
in: body
required: true
schema:
type: object
$ref: "#/definitions/Session"
responses:
200:
description: "Ok"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
delete:
tags:
- v2-session
summary: "Delete a session by Id"
parameters:
- name: "sessionId"
in: "path"
description: "ID of session to delete"
required: true
type: integer
format: "int64"
responses:
200:
description: "OK"
400:
description: "Bad request"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
/sessions/{sessionId}/status:
get:
tags:
- v2-session
summary: "Get status of session by Id"
parameters:
- name: "sessionId"
in: "path"
description: "ID of session to get status"
required: true
type: integer
format: "int64"
responses:
200:
description: "status of session"
schema:
type: object
properties:
status:
type: string
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
put:
tags:
- v2-session
summary: "Change status of session by Id"
parameters:
- name: "sessionId"
in: "path"
description: "Id of session to change status"
required: true
type: integer
format: "int64"
- name: "body"
in: "body"
description: "status string that want to change to"
required: true
schema:
type: object
required:
- status
properties:
status:
type: string
enum:
- "running"
- "completed"
- "reviewed"
responses:
200:
description: "operation succeed"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.session
/coverages/sessions:
get:
tags:
- v2-session
summary: Get all sessions relate to a qTest manager object
description: ""
parameters:
- name: publisherName
in: query
description: publisher name
required: true
type: string
- name: extId
in: query
description: external object's Id
required: true
type: string
- name: type
in: query
description: object's type
required: true
type: string
- name: projectId
in: query
description: project's Id
required: true
type: integer
responses:
200:
description: "Session object"
schema:
type: "object"
properties:
total:
type: integer
sessions:
type: array
items:
$ref: "#/definitions/Session"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
/sessions/{sessionId}/history:
get:
tags:
- v2-session
summary: Get all session's histories
description: ""
parameters:
- name: sessionId
in: path
description: Session's id
required: true
type: integer
responses:
200:
description: "Session's histories"
schema:
type: "object"
properties:
total:
type: integer
item:
type: array
items:
$ref: "#/definitions/History"
links:
$ref: "#/definitions/Links"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
security:
- v2_auth: []
x-swagger-router-controller: api.session
/sessions/{sessionId}/app-infos:
get:
tags:
- v2-application-information
summary: Get a list of application information of a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session to get application information list"
required: true
type: number
responses:
200:
description: "Application information list"
schema:
type: object
properties:
app_infos:
$ref: "#/definitions/AppInfos"
links:
$ref: "#/definitions/Links"
total:
type: number
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
post:
tags:
- v2-application-information
summary: Create an application information for a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session"
required: true
type: number
- name: "body"
in: body
description: "Application information object"
required: true
schema:
$ref: "#/definitions/AppInfo"
responses:
201:
description: "aplication information is created successful"
schema:
type: object
properties:
links:
$ref: "#/definitions/Links"
id:
type: number
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
put:
tags:
- v2-application-information
summary: Update list of application information for a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session"
required: true
type: number
- name: "body"
in: body
description: "List of application information object"
required: true
schema:
$ref: "#/definitions/AppInfos"
responses:
200:
description: "OK"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
/sessions/{sessionId}/app-infos/{appInfoId}:
delete:
tags:
- v2-application-information
summary: Delete an application information of a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session"
required: true
type: number
- name: "appInfoId"
in: path
description: "application information Id"
required: true
type: number
responses:
200:
description: "Operation successful"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
get:
tags:
- v2-application-information
summary: Get an application information of a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session"
required: true
type: number
- name: "appInfoId"
in: path
description: "application information Id"
required: true
type: number
responses:
200:
description: "Operation successful"
schema:
$ref: "#/definitions/Links"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
put:
tags:
- v2-application-information
summary: update an application information of a session by session Id
parameters:
- name: "sessionId"
in: path
description: "Id of session"
required: true
type: number
- name: "appInfoId"
in: path
description: "application information Id"
required: true
type: number
- name: "body"
in: body
required: true
schema:
$ref: "#/definitions/AppInfo"
responses:
200:
description: "Operation successful"
schema:
$ref: "#/definitions/Links"
401:
description: "Unauthorized"
404:
description: "Not Found"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.applicationInformation
/sessions/{sessionId}/sys-infos:
post:
tags:
- v2-system-information
summary: Create system infomation
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: body
in: body
description: "System information object"
required: true
schema:
type: "object"
$ref: "#/definitions/CreateSysInfo"
responses:
201:
description: "System infomation"
schema:
type: object
properties:
links:
$ref: "#/definitions/Links"
id:
type: number
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.systemInfomation
/sessions/{sessionId}/sys-infos/{sysInfoId}:
get:
tags:
- v2-system-information
summary: Get system infomation
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: "sysInfoId"
in: path
type: integer
format: "int64"
description: system infomation's id
required: true
responses:
200:
description: "System infomation"
schema:
$ref: "#/definitions/SysInfo"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.systemInfomation
put:
tags:
- v2-system-information
summary: Update system infomation
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: "sysInfoId"
in: path
type: integer
format: "int64"
description: system infomation's id
required: true
- name: body
in: body
schema:
type: object
$ref: "#/definitions/SysInfo"
responses:
200:
description: "Ok"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.systemInfomation
delete:
tags:
- v2-system-information
summary: Delete system infomation
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: "sysInfoId"
in: path
type: integer
format: "int64"
description: system infomation's id
required: true
responses:
200:
description: "Ok"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.systemInfomation
/sessions/{sessionId}/coverages:
get:
tags:
- v2-coverage
summary: Gets all Coverages by session id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
responses:
200:
description: OK
schema:
$ref: "#/definitions/Coverages"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
put:
tags:
- v2-coverage
summary: Updates all Coverages by session id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: body
in: body
description: body
required: true
schema:
$ref: "#/definitions/Coverages"
responses:
200:
description: OK
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
post:
tags:
- v2-coverage
summary: Creates a Coverage by session id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: body
in: body
description: body
required: true
schema:
$ref: "#/definitions/Coverage"
responses:
201:
description: Created
schema:
$ref: "#/definitions/Coverage"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/sessions/{sessionId}/coverages/{coverageId}:
get:
tags:
- v2-coverage
summary: Gets a Coverage by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: coverageId
in: path
description: coverage id
required: true
type: integer
responses:
200:
description: OK
schema:
$ref: "#/definitions/Coverage"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
put:
tags:
- v2-coverage
summary: Updates a Coverage by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: coverageId
in: path
description: coverage id
required: true
type: integer
- name: body
in: body
description: body
required: true
schema:
$ref: "#/definitions/Coverage"
responses:
200:
description: OK
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
delete:
tags:
- v2-coverage
summary: Deletes a Coverage by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: coverageId
in: path
description: coverage id
required: true
type: integer
responses:
200:
description: OK
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/sessions/{sessionId}/resources:
get:
tags:
- v2-resource
summary: Gets all Resources by session id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
responses:
200:
description: OK
schema:
$ref: "#/definitions/Resources"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/sessions/{sessionId}/resources/{resourceId}:
get:
tags:
- v2-resource
summary: Gets a Resource by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: resourceId
in: path
description: resource id
required: true
type: integer
responses:
200:
description: OK
schema:
$ref: "#/definitions/Resource"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
delete:
tags:
- v2-resource
summary: Deletes a Resource by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: resourceId
in: path
description: resource id
required: true
type: integer
responses:
200:
description: OK
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/sessions/{sessionId}/resources/{resourceId}/download:
get:
tags:
- v2-resource
summary: Downloads a Resource by id
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: resourceId
in: path
description: resource id
required: true
type: integer
responses:
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/sessions/{sessionId}/resources/upload:
post:
tags:
- v2-resource
summary: Uploads a Resource
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: sessionId
in: path
description: session id
required: true
type: integer
- name: file
in: formData
description: file to upload
required: true
type: file
responses:
201:
description: Created
401:
description: Unauthorized
403:
description: Forbidden
404:
description: The requested resource does not exist
security:
- v2_auth: []
x-swagger-router-controller: api.resource
/plugins:
get:
tags:
- v2-script-generator-plugin
summary: Get an array of script generator plugins
responses:
200:
description: "Array of script generator plugins"
schema:
type: object
properties:
plugins:
type: array
items:
$ref: "#/definitions/ScriptGeneratorPlugin"
types:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
401:
description: "Unauthorized"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.query
post:
tags:
- v2-script-generator-plugin
summary: Create an array of script generator plugins
parameters:
- name: body
in: body
schema:
type: object
$ref: "#/definitions/CreateScriptGeneratorPlugin"
responses:
200:
description: "Array of script generator plugins"
schema:
$ref: "#/definitions/ScriptGeneratorPlugin"
401:
description: "Unauthorized"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.query
/plugins/{pluginid}:
delete:
tags:
- v2-script-generator-plugin
summary: Delete script generator plugin
parameters:
- name: "pluginid"
in: path
type: integer
description: plugin's id
required: true
responses:
200:
description: "Ok"
401:
description: "Unauthorized"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.query
/plugins/{pluginid}/file:
get:
tags:
- v2-script-generator-plugin
summary: Download script generator plugin by id
produces:
- application/json
parameters:
- name: "pluginid"
in: path
type: integer
description: plugin's id
required: true
responses:
200:
description: "Ok"
401:
description: "Unauthorized"
403:
description: "Forbidden"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.query
/sessions/{sessionId}/screens:
get:
tags:
- v2-screen
summary: Get all screens of session
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
responses:
200:
description: "screens"
schema:
type: object
properties:
links:
$ref: "#/definitions/Links"
total:
type: integer
screens:
type: array
items:
$ref: "#/definitions/Screen"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.screen
post:
tags:
- v2-screen
summary: Create screen
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: body
in: body
description: "Screen need to be created"
required: true
schema:
type: object
$ref: "#/definitions/CreateScreen"
responses:
201:
description: "Ok"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
500:
description: "Server error"
security:
- v2_auth: []
x-swagger-router-controller: api.screen
put:
tags:
- v2-screen
summary: Update multiple screens
parameters:
- name: "sessionId"
in: path
type: integer
format: "int64"
description: session's id
required: true
- name: body
in: body
description: "Screens need to be updated"
required: true
schema:
type: array
items:
$ref: "#/definitions/UpdateScreen"
responses:
200:
description
# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-qtest-sessions-openapi.yaml