Import Results using Rest API

Working Sample

Please look at Sample Projects for Automation sections for a more concrete end-to-end example.

1. Use API Key for Importing Results

Please Generate API Key if you don't have it for your selected project.

2. Import test results

The import process is divided into 3 sections.

Get Upload file URL: This API gets all required test automation details from the user and responds with a URL to upload the results.
Upload your test result file to generated URL: This API is used to upload the automation results file and import test results.
Check Progress: This API is used to check the progress of automation result import.

2.1 Get Upload file URL

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 :

Content-Type : application/json
apiKey : {generated-api-key}
Authorization :Basic ZnJlZDpmcmVk

Authorization

This Automation REST API is protected by the restrictions provided by JIRA. You need to log in to Jira using the Basic Auth header. Follow the below steps to generate basic Auth and pass it to the 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

zip file must contain files of same format given in the 'format' param.
Request must be contains json raw body payload, form-data is not supported.

Request Parameters

Parameter	Type	Required	Description	Default
`format`	string	Yes	Format of result file to be imported. Supported formats: CUCUMBER TESTNG JUNIT QAF HPUFT SPECFLOW	NA
testCycleToReuse	string	No	Issue Key of the test cycle to be reused	NA
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 cycle 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 to automation help documents. This parameter is supported only for- QAF Cucumber	false
fields	JSON	No	Provide additional fields to be added on a test case or test cycle level. Refer to the following table for more. Note : If the cycle is reused, fields of the test cycle will be ignored. If the Test case version is reused, fields of the test cases will be ignored. The Test case fields provided via automation will be added to ALL the Test cases getting created via automation.	NA

Supported Fields

Supported Fields	Type	Test Cycle	Test Case	Default	Comment
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
description	string	Yes	Yes	null
assignee	string	Yes	Yes	Account Key of current User	Valid User Account Key (Refer to Get account key of the user section below) For example - "JIRAUSER11801"
reporter	string	Yes	Yes	Account Key of current User	Valid User Account Key (Refer to Get account key of the user section below) For example - "JIRAUSER11801"
estimatedTime	string	No	Yes	null	Pass time in ‘HH:mm’ format
plannedStartDate	string	Yes	No	null	Pass date in 'dd/MMM/yyyy HH:mm' format
plannedEndDate	string	Yes	No	null	Pass date in 'dd/MMM/yyyy HH:mm' format
customFields	array	Yes	Yes	null	This array contains JSON object which has name and value property. name property represents name of custom field, user can get it from custom fields screen inside configuration menu. value property represents value of custom field. For Date type custom field, pass value in 'dd/MMM/yyyy' format. For DateTime type custom field, pass value in 'dd/MMM/yyyy HH:mm' format. For Number type custom field, pass any numeric value For Single option custom field like Radio button, Single Dropdown etc, pass option value as string. Ex. 'high' For Multi options custom field like Checkbox, Multi Dropdown etc, pass the value as a comma-separated string. Ex. 'high,medium,low' For Single User picker type custom field, pass Jira Account Key of the user and For Multi-User picker, pass a comma-separated Jira Account Key of users. For Labels type custom field pass value as comma separated string. Ex. 'tag1,tag2' For Cascade type custom field, Pass two level of values. "value" node represents Level 1 dropdown option and cascadeValue node represents Level 2 dropdown option. Ex. "value": "option1", "cascadeValue": "option1_A"

Get the account key of a User

Log in to your Jira Server instance.
Browse http://{BASE_URL}/rest/api/2/user/search?username={username}
You will get the userkey in the output.

Sample Request

{
    "format": "cucumber",
    "attachFile": true,
    "isZip": false,
    "environment": "Chrome",
    "build": "4.1.0",
    "fields": {
        "testCycle": {
            "labels": [
                "label1",
                "label2"
            ],
            "components": [
                "component1"
            ],
            "priority": "High",
            "status": "To Do",
            "summary": "Test Cycle Summary Automation with custom fields",
            "description": "Test Cycle Automation Description",
            "assignee": "JIRAUSER11801",
            "reporter": "JIRAUSER11600",
            "plannedStartDate": "20/May/2021 00:00",
            "plannedEndDate": "30/May/2021 00:00",
            "customFields": [{
                    "name": "Check Boxes",
                    "value": "MCB 1,MCB 2"
                },
                {
                    "name": "Date picker",
                    "value": "29/May/2021"
                },
                {
                    "name": "Date time picker",
                    "value": "29/May/2021 14:55"
                },
                {
                    "name": "Multi DropDown",
                    "value": "MDD 2,MDD 1"
                },
                {
                    "name": "Multi line text field",
                    "value": "QMetry Automation Testing using cucumber framework "
                },
                {
                    "name": "Number field",
                    "value": 1234567890
                },
                {
                    "name":"Cascade Drop down",
                    "value":"User Details", "cascadeValue": "Email"
                },
                {
                    "name": "Single DropDown",
                    "value": "DD2"
                },
                {
                    "name": "Single line Textbox",
                    "value": "QMetry Automation Testing using cucumber framework"
                },
                {
                    "name": "Custom Radio Button",
                    "value": "Test C"
                },
                {
                    "name":"Single User Picker",
                    "value":"JIRAUSER11600"
                },
                {
                    "name":"Multiple user picker field",
                    "value":"JIRAUSER11801,JIRAUSER11800,JIRAUSER11702"
                },
                 {
                    "name":"Custom field type Label for Test Cycle",
                    "value":"TestLabel"
                }
            ]
        },
        "testCase": {
            "labels": [
                "label1",
                "label2"
            ],
            "components": [
                "component1"
            ],
            "priority": "High",
            "status": "To Do",
            "sprintId": "1000",
            "fixVersionId": "10000",
            "description": "Automated generated Test Case",
            "assignee": "JIRAUSER11702",
            "reporter": "JIRAUSER11800",
            "estimatedTime": "10:10",
            "customFields": [{
                    "name": "Check Boxes",
                    "value": "MCB 1,MCB 2"
                },
                {
                    "name": "Date Picker",
                    "value": "29/May/2021"
                },
                {
                    "name": "Date Time Picker",
                    "value": "29/May/2021 14:55"
                },
                {
                    "name": "Multi DropDown",
                    "value": "MDD 2,MDD 1"
                },
                {
                    "name": "Multi line text field",
                    "value": "QMetry Automation Testing using cucumber framework "
                },
                {
                    "name": "Number field",
                    "value": 1234567890
                },
                {
                    "name":"Cascade Drop down",
                    "value":"User Details", "cascadeValue": "Email"
                },
                {
                    "name": "Single DropDown",
                    "value": "DD2"
                },
                {
                    "name": "Single Line Textbox",
                    "value": "QMetry Automation Testing using cucumber framework"
                },
                {
                    "name": "Radio Buttons",
                    "value": "Test C"
                },
                {
                    "name":"Single User Picker",
                    "value":"JIRAUSER11600"
                },
                {
                    "name":"Multiple User Picker",
                    "value":"JIRAUSER11801,JIRAUSER11800,JIRAUSER11702"
                },
                {
                    "name":"Custom Labels for Test Case",
                    "value":"TestLabel"
                }
            ]
        }
    }
}

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

{
    "url": "https://{{jira base url}}/rest/qmetry/automation/latest/importresult/submitFile?trackingId=3d19c19d-935c-4d08-b3de-74a38b5042a0",
    "trackingId": "3d19c19d-935c-4d08-b3de-74a38b5042a0"
}

STATUS 400

Returned if import fails

If unsupported framework is sent in request

{
  "status":400,
  "errorMessage":"Framework ‘xyz’ is not supported.",
  "timestamp":"28/May/2019 04:58"
}

If zip file is not sent in QAF framework request

{  
  "status":400,
  "errorMessage":"Zip file format is required for QAF framework.",
  "timestamp":"28/May/2019 05:00"
}

If one or more fields have invalid value

{
      "status":400,
      "errorMessage": "The supplied fields are invalid",
      "errors":[
        "Provided Component Name(s) xyz not found ",
        "Provided Label Name(s) xyz not found"
      ],
      "timestamp":"29/May/2019 12:44"
}

2.2 Upload test result file

This API is used to upload the automation results file and import test results.

URL : {{URL generated from step 1}}

Method : POST

Request Header

Content-Type : multipart/form-data
apiKey: {generated-api-key}
Authorization :Basic ZnJlZDpmcmVk

Request Body - Binary : Your 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 204	Returned if the file is uploaded successfully.

2.3 See Progress

This API is used to check the progress of automation result import.

URL: https://{{Jira base url}}/rest/qmetry/automation/latest/importresult/track?trackingId={{trackingId from import result step}}

Methood:GET

Content-Type:application/json
apiKey : {generated-api-key}
Authorization : Basic ZnJlZDpmcmVk

Responses

Response Description

STATUS 200

Returned if parameters are validated successfully.

Example

{  
    "format":"QAF",
    "fileName":"1558945546874_840ba1e3-bf14-4f08-b19c-e5de6447711b.zip",
    "processStatus":"VALIDATION/PARSING/CREATING_ASSETS/SUCCESS",
    "importStatus":"SUCCESS/INPROCESS/FAILED",
    "startTime":"2019-05-27T08:25:47.000+0000",
    "endTime":null,
    "fileSize":1500,
    "trackingId":"840ba1e3-bf14-4f08-b19c-e5de6447711b",
    "files":[]
}

STATUS 400

Returned in invalid trackingId

If trackingId is invalid

Example

{
  "status":404,
  "errorMessage":"No import details found for given tracking id '840ba1e3-bf14-4f08-b19c-e5de6447711b'",
  "timestamp":"02/Apr/2020 16:19"
}

3. View imported test results

Please refer to View Imported Test Results section to view imported test results.