Available methods

GenerateReport

The GenerateReport method triggers the generation of a report and return a unique ID to reference the file to download once generation is over.

Parameters:

  • TestResultName (optional string): Specifies the test result name to use to generate the report.
    If not specified, will work on the latest test result.

  • ComparisonReport (optional boolean): Generates test comparison reports.
    If not specified or false, will generate a single test result report.

  • OtherTestResultName (optional string): Specifies the name of the other test result. This argument requires the ComparisonReport argument.

  • TestResultLabel (optional string): Labels the test result when generating a comparison report. This argument requires the ComparisonReport argument.

  • OtherTestResultLabel (optional string): Labels the other test result when generating a comparison report. This argument requires the ComparisonReport argument.

  • CustomReportContents (optional boolean): Generates a report based on the last report contents settings defined for the project.
    If not specified or false, the report is generated with default settings.

  • Format (optional string): The format of the report, either HTML, PDF, XML, RTF, JUNIT.
    If not specified, RTF format is used (same as default format for CommandLine).
    List of format dynamically computed from com.neotys.nl.controller.report.wizard.ReportSettings.FORMAT

  • FileName (optional string): Specifies the name of the report.
    If extension specified and equals to format extension, file name is the full name of the file. Otherwise, if the extension if unspecified, or different, then the extension is added to the file name.
    If not specified, use the name of the test result, suffixed by the format extension.

  • ApiKey (optional string): Specifies the ApiKey for API authentication.
    If not specified, no authentication is performed

POST http://localhost:7400/Results/v1/Service.svc/GenerateReport HTTP/1.1
Content-Type: application/json
{ "d": { }}

The response content contains the ReportId that will allow you to download the generated report.

POST http://localhost:7400/Results/v1/Service.svc/GenerateReport HTTP/1.1
Content-Type: application/json
{   "d": {
                “ApiKey”: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”
      "TestResultName": "testA",
      "ComparisonReport": true,
      "OtherTestResultName": "testB",
      "CustomReportContents": true,
      "Format": "PDF"
}}

The response content contains the ReportId that will allow you to download the generated report.

DownloadReport

The DownloadReport method triggers the download of a report previously generated.

Parameters:

  • ReportID (required string): Specifies the ID of the report to download.

  • ApiKey (optional string): Specifies the ApiKey for API authentication.
    If not specified, no authentication is performed

POST http://localhost:7400/Results/v1/Service.svc/DownloadReport HTTP/1.1
Content-Type: application/json
{ "d": {"ReportId": "4b3cf2fb-ce93-4a67-a2ac-ff847d0dc77f", “ApiKey”: “xxxxxxxxxxxxxxxxxxxxxxx”}}

UpdateQualityStatus

The UpdateQualityStatus method sets the Quality Status of a test result.

Parameters:

  • TestResultName (optional): Specifies the test result name to update. If not specified, will update the latest test result.

  • QualityStatus (required): To force the Quality Status of a test result. Possible values are "PASSED" and "FAILED".

  • ApiKey (optional): Specifies the ApiKey for API authentication. If not specified, no authentication is performed.

POST http://localhost:7400/Results/v1/Service.svc/UpdateQualityStatus HTTP/1.1
Accept: application/json
Content-Type: application/json
Cache-Control: nocache
Pragma: nocache
Connection: keepalive
{
  "d":
    {
    "TestResultName": "14:54 - 10 Sep 2019",
        "QualityStatus": "PASSED"
    }
}