Please look at Sample Projects for Automation sections for a more concrete end-to-end example. |
Please Generate API Key if you don't have for your selected project.
Import process is divided into 3 sections.
This API gets all required test automation details from the user and responds with a URL to upload the results.
URL : https://{{Jira base URL}}/rest/qmetry/automation/latest/importresult
Method : POST
REQUEST HEADER :
Authorization
This Automation REST API is protected by the restrictions provided by JIRA. You need to log in Jira using the basic Auth header. Follow below steps to generate basic Auth and pass it to request header :
1. Build a string of the form username:password
2. Encode the string in Base64 format.
3. Pass an "Authorization" header with content "Basic " followed by the encoded string. For example, the string "fred:fred" encodes to "ZnJlZDpmcmVk" in base64, so you would make the request as follows.
Authorization: Basic ZnJlZDpmcmVk |
Notes
Request Parameters
Parameter | Type | Required | Description | Default |
---|---|---|---|---|
format | string | Yes | Format of result file to be imported. Supported formats:
| NA |
testCycleToReuse | string | No | Issue Key of the test cycle to be reused | New Test Cycle will be created. |
environment | string | No | Name of the environment on which test cycle has to be executed | No Environment |
build | string | No | Name of the build for test case execution | Blank |
isZip | boolean | No (Yes for QAF) | Pass true for ZIP upload or pass false for single file upload | false |
attachFile | boolean | No | Pass true to upload attachments in execution. For more details, Refer automation help documents. This parameter is supported only for-
| false |
fields | JSON | No | Provide additional fields to be added on test case or test cycle level. Refer to following table for more. Note : If cycle is reused, fields of test cycle will be ignored. | Blank |
Supported Fields
Supported Fields | Type | Test Cycle | Test Case | Default |
---|---|---|---|---|
labels | array | Yes | Yes | null |
components | array | Yes | Yes | null |
status | string | Yes | Yes | TO DO |
priority | string | Yes | Yes | Medium |
fixVersionId | number | Yes | Yes | null |
sprintId | number | Yes | Yes | null |
summary | string | Yes | No | Automated Test Cycle |
Sample Request
{ "format":"cucumber", "testCycleToReuse":"TR-PRJ-1", "attachFile":true, "isZip":false, "environment":"Chrome", "build":"1.0.0 beta", "fields":{ "testCycle":{ "labels":[ "label1", "label2" ], "components":[ "component1" ], "priority":"High", "status":"To Do", "sprintId":10000, "fixVersionId":10000, "summary":"Test Cycle Summary" }, "testCase":{ "labels":[ "label1", "label2" ], "components":[ "component1" ], "priority":"High", "status":"To Do", "sprintId":10000, "fixVersionId":10000 } } } |
Responses
Response | Description | |||
---|---|---|---|---|
STATUS 200 | Returned if results file is uploaded successfully. The import process might take a while and you would be notified (by email or checking the status of the created test run) once the process completed. Example
| |||
| Returned if import fails If unsupported framework is sent in request
If zip file is not sent in QAF framework request
If one or more fields have invalid value
|
This API is used to upload the automation results file and imports test results.
URL : {{URL generated from step 1}}
Method : POST
Request Header
multipart/form-data
Request Body - Result file to be uploaded. Supported file extensions: .json, .xml and .zip (zip file must contain files of the format given in the 'format' param).
Note: File Attachment must be passed in form-data.
Responses
Response | Description | |
---|---|---|
STATUS 200 | Returned if file is uploaded successfully. | |
STATUS 400 | Returned if file upload happens after URL expiration time or if Content-type=multipart/form-data header is not passed Example URL Expiry
| |
STATUS 204 | Returned if file format is not valid. No Content |
This API is used to check the progress of automation result import.
GET
application/json
apiKey : {generated-api-key}
Responses
Response | Description | |
---|---|---|
SUCCESS | Returned if parameters are validated successfully. Example
| |
FAILED | Returned if any validation fails Example
|
Please refer to View Imported Test Results section to view imported test results.