Import Results using Rest API

1. Use API Key for Importing Results

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

2. Import test results

Import process is divided into 3 sections. 

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. 
2. Upload your test result file to generated URL : This API is used to upload the automation results file and imports test results.
3. 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 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

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

Request Parameters

Supported Fields

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

{
    "url": "https://{{jira base url}}/rest/qmetry/automation/latest/importresult/submitFile?trackingId=3d19c19d-935c-4d08-b3de-74a38b5042a0",
    "message": "Generated Upload URL is valid for one time use and will expire in 5 minutes.",
    "trackingId": "3d19c19d-935c-4d08-b3de-74a38b5042a0"
}

{
  "status":400,
  "errorMessage":"Framework ‘xyz’ is not supported.",
  "timestamp":"02/Apr/2020 04:58"
}

{  
  "status":400,
  "errorMessage":"Zip file format is required for QAF framework.",
  "timestamp":"02/Apr/2020 05:00"
} 

{
    "status": 400,
    "errorMessage": "The supplied fields are invalid",
    "errors": [
        "Provided Component Name(s) xyz not found ",
        "Provided Label Name(s) xyz not found"
    ],
    "timestamp": "03/Mar/2020 15:32"
  }

2.2 Upload test result file 

This API is used to upload the automation results file and imports 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 - 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

{
    "status": 400,
    "errorMessage": "You cannot upload multiple files with same URL. Please create new upload request.",
    "timestamp": "03/Apr/2020 15:32"
}

2.3 Check Progress

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

Responses

{
    "format": "CUCUMBER",
    "fileName": "1585908845000_5fcfde02-c044-4cee-baaa-48336384ee1b.json",
    "processStatus": "SUCCESS",
    "importStatus": "SUCCESS",
    "startTime": "03/Apr/2020 15:44",
    "endTime": "03/Apr/2020 15:44",
    "fileSize": null,
    "trackingId": "5fcfde02-c044-4cee-baaa-48336384ee1b",
    "files": null,
    "detailedMessage": "File is imported successfully.",
    "extraAttributes": {
        "attachFile": false
    },
    "summary": {
        "testCycle": "9nw44F4lfp",
        "testCasesCreated": null,
        "testCaseVersionsCreated": null,
        "testCaseVersionsReused": 3,
        "testStepsCreated": 0,
        "testCycleIssueKey": "AP-TR-5"
    }
}

{
    "format": "CUCUMBER",
    "fileName": "1585909023000_dc038259-434f-4748-aaa6-a453a05d5ca1.json",
    "processStatus": "VALIDATION/PARSING/CREATING_ASSETS/SUCCESS",
    "importStatus": "SUCCESS/INPROCESS/FAILED",
    "startTime": "03/Apr/2020 15:47",
    "endTime": "03/Apr/2020 15:47",
    "fileSize": null,
    "trackingId": "dc038259-434f-4748-aaa6-a453a05d5ca1",
    "files": null,
    "detailedMessage": "The supplied file is either empty or invalid.",
    "extraAttributes": {
        "attachFile": false
    },
    "summary": {
        "testCycle": null,
        "testCasesCreated": null,
        "testCaseVersionsCreated": null,
        "testCaseVersionsReused": null,
        "testStepsCreated": null,
        "testCycleIssueKey": null
    }
}

3. View imported test results

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