QA Touch API

Before you start using our API, your first step is to obtain an api-token from your QA Touch site. Once you obtain the token, then you are ready to go.

Requirements

All the API endpoints require a couple of headers so that we can authenticate you before processing the request.

Required Headers

  1. domain
  2. api-token

Pagination

By default, all the endpoints which return more than 50 rows are paginated. You can move to another page by adding parameters to the request.

For example : api.qatouch.com/api/v1/getAllProjects?page=2

The above example will return the data which are available in the second page of the request.

Projects

List Projects

Provides the list of projects created for your domain.

GET api.qatouch.com/api/v1/getAllProjects
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllProjects" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Projects

Count of the total projects available.

GET api.qatouch.com/api/v1/count/allProjects
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allProjects" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Create Project

Create a new project in your domain.

POST api.qatouch.com/api/v1/project
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
name Name of the new Project to be created

Example request

curl --location --request POST "api.qatouch.com/api/v1/project?name=Automation" \
  --header "api-token: " \
  --header "domain: " \
  --data ""

Test Cases

List Test Cases

Provides the list of test cases available for the project.

GET api.qatouch.com/api/v1/getAllTestCases/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
moduleKey To list all test cases for a particular module
mode To list all test cases based on the provided mode which is automation or manual
requirementKey To list all test cases which is present under the provided requirements

Note: The above parameters can be used only one at a time and can't be requested with multiple parameters.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllTestCases/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Test Cases

Count of the total test cases available for the project.

GET api.qatouch.com/api/v1/count/allTestCases/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allTestCases/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List all Modules

Provides the list of Modules available for the project.

GET api.qatouch.com/api/v1/getAllModules/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request POST "api.qatouch.com/api/v1/getAllModules/{projectKey}" \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Create Module

Create a new module in your project for Test Case.

POST api.qatouch.com/api/v1/module
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Module to be created
moduleName Name of the module to be created
parentKey (Optional) To create child module, provide this parameter with existing Module's Key

Example request

curl --location --request POST "api.qatouch.com/api/v1/module?projectKey={projectKey}&moduleName={moduleName}" \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Create Test Cases

Create a new Test Cases in your project.

POST api.qatouch.com/api/v1/testCase?projectKey={projectKey}&sectionKey={sectionKey}&caseTitle={caseTitle}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Module to be created
sectionKey Provide the section key for under which the test case should be created
caseTitle Title of the test case

Example request

curl --location --request POST "api.qatouch.com/api/v1/module?projectKey={projectKey}&moduleName={moduleName}" \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Releases

List Releases

Provides the list of Releases available for the project.

GET api.qatouch.com/api/v1/getAllMilestones/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllMilestones/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Releases

Count of the total Releases available for the project.

GET api.qatouch.com/api/v1/count/allMilestones/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allMilestones/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Create Release

Create a new Release in your project.

POST api.qatouch.com/api/v1/milestone
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Release to be created
milestone Name of the release to be created

Example request

curl --location --request POST "api.qatouch.com/api/v1/milestone?projectKey={projectKey}&milestone={milestone} \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Test Runs

List Test Runs

Provides the list of Test Runs available for the project.

GET api.qatouch.com/api/v1/getAllTestRuns/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllTestRuns/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Test Runs

Count of the total Test Runs available for the project.

GET api.qatouch.com/api/v1/count/allTestRuns/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allTestRuns/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Test Run Results

Provides the list of Test Runs Results available for a Test Run.

GET api.qatouch.com/api/v1/testRunResults/{projectKey}/{testRunKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/testRunResults/{projectKey}/{testRunKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Test Run Results for Release

Provides the list of Test Run Results available for a particular release.

GET api.qatouch.com/api/v1/testRunResults/{projectKey}/{releaseKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
status To get test run results based on the status provided, you can get the available status using List Statuses for Test Run api

Example request

curl --location --request GET "api.qatouch.com/api/v1/testRunResults/{projectKey}/{releaseKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Test Run Results History

Provides the list of History(s) available of Test Runs Results.

GET api.qatouch.com/api/v1/testRunResults/history/{projectKey}/{testRunKey}/{resultKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/testRunResults/history/{projectKey}/{testRunKey}/{resultKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Statuses for Test Run

Provides the list of available statuses for Test Runs.

GET api.qatouch.com/api/v1/testRuns/getAvailableStatuses
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/testRuns/getAvailableStatuses" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Update Test Run Status

Update the status for the test run.

PATCH api.qatouch.com/api/v1/testRunResults/status?status={status}&project={projectKey}&test_run={testRunKey}&run_result={resultKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
status Status to be updated.
project Project Key.
test_run Test Run Key.
run_result Test Run Result Key.

Example request

curl --location --request PATCH "api.qatouchapi.com/api/v1/testRunResults/status?status={status}&project={projectKey}&test_run={testRunKey}&run_result={runResultKey}" \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

List all available Users for Testing

Provides the list of Users in the project available for Testing.

GET api.qatouch.com/api/v1/testRun/availableUsers/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/testRun/availableUsers/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Create Test Run

Create a new Test Run in your project.

POST api.qatouch.com/api/v1/testRun
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Test Run to be created
assignTo User key to which the Test Run to be assigned
milestoneKey Provide the Release key to be assigned to Test Run
testRun Title of the Test Run

Example request

curl --location --request POST "api.qatouch.com/api/v1/testRun?projectKey={projectKey}&assignTo={assignTo}&milestoneKey={milestoneKey}&testRun={testRun} \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Defects

List Defects

Provides the list of Defects available for the project.

GET api.qatouch.com/api/v1/getAllDefects/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllDefects/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Defects Statuses

Provides the list of available defect statuses.

GET api.qatouch.com/api/v1/defects/status
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/defects/status" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Defects Severity

Provides the list of available defect severity.

GET api.qatouch.com/api/v1/defects/severity
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/defects/severity" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Defects Issue Type

Provides the list of available defect Issue Type.

GET api.qatouch.com/api/v1/defects/issueType
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/defects/issueType" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Defects Environments

Provides the list of available defect environments.

GET api.qatouch.com/api/v1/defects/environment
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/defects/environment" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Defects

Count of the total Defects available for the project.

GET api.qatouch.com/api/v1/count/allDefects/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allDefects/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Create Defect

Create a new Defect in your project.

POST api.qatouch.com/api/v1/defects
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Defect to be created
priority Priority to be given to the Defect
issueSummary Title of the Defect

Example request

curl --location --request POST "api.qatouch.com/api/v1/defects?projectKey={projectKey}&priority={priority}&issueSummary={issueSummary} \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Requirements

List Requirements

Provides the list of Requirements available for the project.

GET api.qatouch.com/api/v1/getAllRequirements/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllRequirements/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Count Requirements

Count of the total Requirements available for the project.

GET api.qatouch.com/api/v1/count/allRequirements/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/count/allRequirements/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

List Requirement Documents

Provides the list of Requirement Documents created for your domain.

POST api.qatouch.com/api/v1/getAllRequirementDocuments/{projectKey}
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.

Example request

curl --location --request GET "api.qatouch.com/api/v1/getAllRequirementDocuments/{projectKey}" \
  --header "domain: {your-domain}" \
  --header "api-token: {your-api-token}" \
  --data ""

Create Requirement Document

Create a new Requirement Document in your project.

POST api.qatouch.com/api/v1/requirement/document
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Requirement Document has to be created
releaseKey Provide the release key under which Requirement Document has to be created
title Title of the Requirement Document

Example request

curl --location --request POST "api.qatouch.com/api/v1/requirement/document?projectKey={projectKey}&releaseKey={releaseKey}&title={title} \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""

Create Requirement

Create a new Requirement Document in your project.

POST api.qatouch.com/api/v1/requirement
Headers Description
domain Your QA Touch domain.
api-token Your secret api-token.
Parameters Description
projectKey Project Key under which the Requirement has to be created
documentKey Provide the document key under which Requirement has to be created
title Title of the Requirement
desc Description of the Requirement

Example request

curl --location --request POST "api.qatouch.com/api/v1/requirement?projectKey={projectKey}&documentKey={documentKey}&title={title}&desc={desc} \
  --header "api-token: {your-api-token}" \
  --header "domain: {your-domain}" \
  --data ""
Show examples in:
QA Touch API Documentation