Result Reporting API

The result reporting API can be used to upload test results to Squish Test Center. You can use it to upload results from test tools for which we do not yet support the result format. You can also use it to increase the detail level of your results, as this API allows reporting results on the same level of detail as Squish result reports, including screenshots, attachments, and even screenshot verification points.

Conceptually report creation and creation of test elements happen implicitly. Reports are created by the suites endpoint. If you don't provide an existing report id, or a set of labels that match a previously created report, a new report will be created. For test elements (suites, testcases, features, scenarios, steps, sections) all endpoints report an execution of the specified Test and return a Run, which represents the execution of the test. If the test that is specified is unknown, it implicitly gets created.

To help you get started with using the result reporting API a Python example implementation can be found in the testcenter/examples folder.

Authorization

All endpoints use one of the following authorization methods described below, using the HTTP Authorization header.

POST /suites - Create Test Suites

When reporting a test suite execution, you also need to provide information about which project the test suite belongs to. You also need to specify whether you want the test suite execution to be part of a specific report in a specific batch, or if a new report or batch should be created. The following rules apply:

• If no batch, report id or labels are provided, then a new batch and report will be created.
• If a batch is given but no report id or labels, then the suite will be added to the first report of the given batch.
• If a report id is given, then the suite will be added to the report with this id.
• If both batch and labels are given, Squish Test Center will try to find a report within the given batch that has the exact same set of labels and reuse it. If no matching report can be found a new report is created.

Suite Request Body

Content-Type: application/json

Suite Responses

Suite Examples

Create a suite with project and name

Sample Request

POST http://testcenter.example.com/upload/suites

{
    "project": "MyProject",
    "test": {
        "name": "MyTest"
    }
}

Sample Response

Status code: 201

{
    "project": "MyProject",
    "batch": "MyBatch",
    "reportId": 25,
    "runId": 12
}

Create a suite with reportId and fully detailed test

Sample Request

POST http://testcenter.example.com/upload/suites

{
    "reportId": 25,
    "test": {
        "name": "MyTest",
        "summary": "MySummary",
        "description": "MyDescription"
    }
}

Sample Response

Status code: 201

{
    "project": "MyProject",
    "batch": "MyBatch",
    "reportId": 25,
    "runId": 12
}

POST /cases - Create Test Cases

You can use this endpoint to report a test case execution.

Case Request Body

Content-Type: application/json

Case Responses

Case Examples

Create a test case with all details

Sample Request

POST http://testcenter.example.com/upload/cases

{
    "runId": 12,
    "test": {
        "name": "My Test Case",
        "summary": "My Test Case Summary",
        "description": "My Test Case Description"
    }
}

Sample Response

Status code: 201

{
    "runId": 13
}

POST /features - Create Features

You can use this endpoint to report a test feature execution.

Feature Request Body

Content-Type: application/json

Feature Responses

Feature Examples

Create a feature with all details

Sample Request

POST http://testcenter.example.com/upload/features

{
    "runId": 13,
    "test": {
        "name": "My Feature",
        "summary": "My Feature Summary",
        "description": "My Feature Description"
    }
}

Sample Response

Status code: 201

{
    "runId": 14
}

POST /scenarios - Create Scenarios

You can use this endpoint to report a scenario execution.

Scenario Request Body

Content-Type: application/json

Scenario Responses

Scenario Examples

Create a scenario with all details

Sample Request

POST http://testcenter.example.com/upload/scenarios

{
    "runId": 14,
    "test": {
        "name": "My Scenario",
        "summary": "My Scenario Summary",
        "description": "My Scenario Description"
    }
}

Sample Response

Status code: 201

{
    "runId": 15
}

POST /steps - Create Step

You can use this endpoint to report a step execution.

Step Request Body

Content-Type: application/json

Step Responses

Step Examples

Create a step with all details

Sample Request

POST http://testcenter.example.com/upload/steps

{
    "runId": 16,
    "test": {
        "name": "My Step",
        "summary": "My Step Summary",
        "description": "My Step Description"
    }
}

Sample Response

Status code: 201

{
    "runId": 17
}

POST /sections - Create Section

You can use this endpoint to report a section execution.

Section Request Body

Content-Type: application/json

Section Responses

Section Examples

Create a section with all details

Sample Request

POST http://testcenter.example.com/upload/sections

{
    "runId": 17,
    "test": {
        "name": "My Section",
        "summary": "My Section Summary",
        "description": "My Section Description"
    }
}

Sample Response

Status code: 201

{
    "runId": 18
}

POST /events - Create Event

The events endpoint can be used to report test events like succeeded or failed verifications, log messages, warnings, or screenshots and other attachments.

Event Request Body

Content-Type: application/json

Content-Type: multipart/form-data

Event Responses

Event Examples

Create a simple PASS event

Sample Request

POST http://testcenter.example.com/upload/events

{
    "runId": 18,
    "type": "PASS",
    "message": "My First Pass",
    "detail": "My First Pass Description"
}

Sample Response

Status code: 201

{
}

Create a FAIL event with a screenshot on failure

Sample Request

POST http://testcenter.example.com/upload/events
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="eventData"

[{"runId": 18, "type": "FAIL", "screenshot": "My Image.jpg"}]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[]"; filename="My Image.jpg"
Content-Type: image/jpeg

(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Sample Response

Status code: 207

[
    {
        "code": 201,
        "body": ""
    }
]

Definitions

Test object

Label object

Trace object

Location object

VP object

Suite response

Run response

Event Response

Error Response