/results

You may use the REST API to upload test results data to Tesults.

Use the /results API to upload results:

API

https://www.tesults.com/results
Method: 'POST'

Headers

"Content-Type": "application/json"

Body

Submit test results data in JSON format in the request POST body:

{
  "target": "token",
  "results": {<results>}
}

Both 'target' and 'results' values are required.

The "token" placeholder should be replaced with the target token string provided to you on creation of your project. If you did not note down the token when you created your project you can regenerate a token for the target in the configuration menu.

<results> must be replaced with your test results. Test results are formatted as an array of test case objects.

"results": { "cases": [
  {
    "name" : <name>,
    "desc" : <desc>,
    "suite" : <suite>,
    "result" : <result>,
    "reason" : <reason>,
    "params" : <params>
  },
  ...more test cases here
  ]
}

In each test case object "name" and "result" are required, "desc", "suite", "reason" and "params" are optional.

<name> should be replaced with the name of the test case. (Required)

<desc> should be replaced with the description of the test case. (Optional)

<suite> should be replaced with the suite of the test case. (Optional)

<result> should be replaced with the result of the test case. (Required)

<reason> should be replaced with the reason for the failure of the test case. (Optional)

<params> should be replaced with the parameters of the test case if it is a parameterized test. (Optional)

To report a build pass or failure add a case with the suite value set to '[build]'. If a case has suite set to '[build]' it will be treated as build data rather than as a test case. Use the name or description to report a build number, version or revision.

Here is a complete example:

{
  "target": "0123456789",
  "results": { "cases": [ 
    {
        "name": "Test A",
        "desc": "Test A description",
        "suite": "Suite X",
        "result": "pass"
    },
    {
        "name": "Test B",
        "desc": "Test B description",
        "suite": "Suite X",
        "result": "fail",
        "reason": "Assert in line 203, example.cpp.",
        "_CustomField": "Custom field value"
    },
    {
        "name": "Test C",
        "desc": "Test C description",
        "suite": "Suite Y",
        "result": "pass",
        "params": {
          "param1": "value1",
          "param2": "value2"
        }
    }
    ]
  }
}

Within 'results' the 'cases' array is required. If you are only uploading one test result you must still send it as one element in the array.

"0123456789" should be replaced with the target token string provided to you once you on creation of your project. If you did not note down the token when you created your project you can regenerate a token for the target in the configuration menu.

If the the request is successful the response will have a status code of 200 and include a JSON response as shown below.

status code 200 with JSON response:

{
  "data": {
     "code": 200,
     "message": "Success"
  }
}

If there is an error there will be a status code other than 200 with JSON response as shown below.

status code other than 200, for example 400, 401, 403, 429, 500 with JSON response:

{
  "error": {
     "code": 400,
     "message": "Missing required parameters - target and results are required"
  }
}

The error message will provide detail as to the specific reason for the failed request.

Fix the error displayed in the error message and try again to get a successful response.

Your team members will be able to view your uploaded test results immediately after a successful response. Any notificiation recipients you have configured will be notified about the availability of the new results by email.