Rest API
- 1 General information
- 1.1 Root URL
- 1.2 Get a JWT token:
- 1.3 Get Jira issue ID:
- 1.4 Get Jira project ID:
- 2 Test cases
- 2.1 GET test steps
- 2.2 POST test step
- 2.3 PUT test step
- 3 Statuses
- 3.1 GET
- 4 Test Executions
- 4.1 GET history
- 4.2 GET execution
- 4.3 Post execution
- 4.4 PUT execution
- 5 Test Cycles
General information
Root URL
https://apps-qalityplus.soldevelo.com
All requests should be made there.
Get a JWT token:
You will need this token to make any request. The token is valid for ~5m.
If you need the token for a one-time use you can skip step 1 and paste the URL from step 2 into your browser.
You need an Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens
Make a GET request with authorization:
username
= your emailpassword
= API token from step 1https://<your_instance>.atlassian.net/plugins/servlet/ac/com.soldevelo.apps.test_management_premium/test-cycles?classifier=json
Copy the
contextJwt
property from the result.
Get Jira issue ID:
QAlity is integrated with Jira. This means test cases are represented as Issues of “QAlity test“ type. Often you will need their ID to make a request.
You need an Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens
Make a GET request with authorization:
username
= your emailpassword
= API token from step 1https://<your_instance>.atlassian.net/rest/api/3/issue/<ISSUE KEY or ID>
Copy the
id
property from the response.
Get Jira project ID:
You need an Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens
Make a GET request with authorization:
username
= your emailpassword
= API token from step 1https://<your_instance>.atlassian.net/rest/api/3/project/<PROJECT KEY or ID>
Copy the
id
property from the response.
Test cases
GET test steps
/testStep/<ISSUE_ID>?jwt=<JWT>
Params:
ISSUE_ID
- id of the test case - Id of Jira issue
JWT
- the authentication token
Response:
POST test step
/testStep?jwt=<JWT>
Body:
PUT test step
/testStep/<STEP_ID>?jwt=<JWT>
Params:
STEP_ID
- id of the step
JWT
- the authentication token
Body:
Statuses
Status model
GET
/statuses?jwt=<JWT>
Response
Test Executions
GET history
/testExecution?jwt=<JWT>&testCaseId=<TEST_CASE_ID>&page=<PAGE>
Params:
TEST_CASE_ID
- id of the test case - Id of Jira issue
JWT
- the authentication token
PAGE
- page number, starts from 0
Response:
LIst of executions for provided page. max 10 results.
GET execution
/testExecution/<TEST_EXECUTION_ID>?jwt=<JWT>
Params:
TEST_EXECUTION_ID
- id of the execution
JWT
- the authentication token
Response:
Post execution
/testExecution?jwt=<JWT>
Params:
JWT
- the authentication token
Body:
Response:
PUT execution
It is recommended to fetch test execution and edit existing data. To create an execution see POST.
/testExecution?jwt=<JWT>
Params:
JWT
- the authentication token
Body:
Response:
Updated Execution
Test Cycles
GET all
Fetch all test cycles available for the user (based on the JWT token).
/testCycles?jwt=<JWT>
Params:
Response (paginated):
POST Add Test Case To Cycle
/testCasesInCycle?jwt=<JWT>
Params:
JWT - the authentication token
Body:
Response: