TestResults.io
  • What is TestResults.io
  • System Architecture
  • Regulated Markets
    • Health Care Industry
    • Financial Services Industry
  • What's new?
    • Update Instruction
      • Update of the Designer extension in Visual Studio
      • Update the Execution Engine
      • Update the Base- and Environment Models
    • Migration to new project file
  • Designer
    • Overview
    • First Steps
    • Installation
    • TestResults.io solution
    • The development environment
      • Tool Window Overview
        • Test Environments
          • Steps to configure a SUT VM
          • How to access files on the system under test
        • Remote Viewer
          • Control Mode
          • Capture Mode
          • Screen Editor
          • Capture Single Image
        • Screen Explorer
        • Test Case Designer
        • Image Explorer
        • API Testing
        • TestResults.io options
          • Engines
          • Servers
    • Test Cases
      • Adding Test Cases
      • Test Case structure
      • Simple Test Case (Example)
      • Executing your Test Case
      • Generating Test Containers
      • Publishing Test Cases
      • Execution Variables
    • Software Models
      • Adding SW Models
      • Referencing the Model in the Test Case
      • Generating Test Containers
      • Publishing SW Models
      • Screens and Screen Elements
        • Tables
        • Visual Sense
        • Custom Screen Elements
    • Installers
      • Adding Installers
      • Generating Test Containers
      • Publishing Installers
    • Automation Framework Reference
      • Attributes
      • Enumerations
      • Filters
        • IImageFilter Interface
        • Select
        • Resize
      • GlobalEngineParameters
      • ImageDetectionParameters
      • ImageReference
      • Interfaces
        • ITester Interface
          • ITester Methods
          • ITester Properties
        • ITestee Interface
          • ITestee Methods
        • IConnections Interface
          • IConnections Methods
          • IConnections Properties
        • IDebug Interface
        • IEngineResult
        • IHelpers Interface
        • IImageHelper Interface
          • IImageHelper Methods
        • IKeyboard Interface
          • IKeyboard Methods
        • IMouse Interface
          • IMouse Methods
          • IMouse Properties
        • IReport Interface
          • IReport Methods
        • ISUTConnection Interface
      • OcrEngineParameters
        • Best practise
        • IronOcrEngineParameters
        • LEADOcrEngineParameters
        • OcrEngineRelatedCharacters
        • OcrPreprocessingParameters
      • ResultRectangle
      • SutNotReadyException
      • TestStepAbortedException
    • FAQ
      • Two-factor authentication (2FA) and One Time Passwords (OTP)
      • Receive and verify Emails
      • Using Excel as test data source
      • Verify PDF Content
  • Portal
    • Overview
    • First Steps
    • User's Guide
      • Login
      • Projects
      • Dashboard
      • Test Cases
      • Software & Environments
      • Test Sets
      • Job Queue
      • Management
      • Notifications Summary
    • Automation Engineer's Guide
      • Test Automation Workflow
      • Automating a test case
      • Enabling Software & Environments
    • REST API Reference
      • Authentication
      • Projects
      • Test Sets
      • Test Cases
      • Test Plans
      • Test Reports
      • Files
      • Software
      • Environments
      • Untitled
      • Executions
      • Favorites
      • Statistics
      • User Management
      • Customer Management
      • Notifications
      • Configurations
      • Invoicing
  • Models
    • Overview
    • Base Model
      • BaseScreen
        • BaseScreen Properties
        • BaseScreen Methods
      • OnScreenElement
        • OnScreenElement Methods
        • OnScreenElement Properties
      • Primitives
        • Button
          • Button Methods
          • Button Properties
        • Checkbox
          • Checkbox Methods
        • ContextMenu
          • ContextMenu Methods
          • ContextMenu Properties
        • Dropdown
          • Dropdown Methods
          • Dropdown Properties
        • DropdownMenu
          • DropdownMenu Methods
          • DropdownMenu Properties
        • GenericScroller
          • GenericScroller Methods
          • GenericScroller Properties
        • HorizontalScroller
        • IconButton
          • IconButton Properties
        • Label
        • LabelWithButton
          • LabelWithButton Properties
        • LabelWithCheckbox
          • LabelWithCheckbox Properties
        • LabelWithValue
          • LabelWithValue Methods
          • LabelWithValue Properties
        • PwTextBox
          • PwTextBox Methods
        • TextBox
          • TextBox Methods
          • TextBox Properties
        • Tables and lists
          • Column
            • Column Methods
            • Column Properties
          • ItemList
            • ItemList Methods
            • ItemList Properties
          • Row
            • Row Methods
            • Row Properties
          • TableBase
            • TableBase Methods
            • TableBase Properties
        • LabelWithElementBase
          • LabelWithElementBase Properties
      • Enumerations
      • Extensions
        • EngineResultExtensions Methods
        • EnumExtensions Methods
        • ReportExtensions Methods
        • StringExtensions Methods
        • TesterConnectionExtensions Methods
        • TesterDebugExtensions Methods
        • TesterHelperExtensions Methods
        • TesterMouseExtensions Methods
        • TesterOnScreenElementExtensions
        • TesterSelectExtensions Methods
      • Helper Classes
        • BaseModelHelpers
          • BaseModelHelpers Methods
          • BaseModelHelpers Properties
        • Attributes for Designer
        • ListHelpers
      • Exceptions
        • ElementNotFoundException
        • InteractionFailedException
        • ScreenNotFoundException
      • Interfaces
        • IAppBasics Interface
          • IAppBasics Methods
          • IAppBasics Properties
        • IBrowser
        • ICommandLineWindow
        • IScroller Interface
          • IScroller Methods
          • IScroller Properties
        • ISutLocale Interface
          • ISutLocale Methods
          • ISutLocale Properties
        • ISystemHelpers
        • ISystemInteractions
        • IWindow
    • Environment Model
      • Windows
        • Screens
          • CmdWindow
            • CmdWindow Methods
            • CmdWindow Properties
          • FileDialog
            • FileDialog Methods
            • FileDialog Properties
          • FileExplorer
            • FileExplorer Properties
          • RunWindow
            • RunWindow Methods
            • RunWindow Properties
          • Window
            • Window Methods
            • Window Properties
        • SutLocale
          • SutLocale Methods
          • SutLocale Properties
        • SystemHelpers
          • SystemHelpers Methods
          • SystemHelpers Properties
        • SystemInteractions
        • WebBrowser
          • Browser
            • Browser Methods
            • Browser Properties
          • BrowserScroller
            • BrowserScroller Methods
            • BrowserScroller Properties
          • AuthenticationDialog
            • AuthenticationDialog Methods
            • AuthenticationDialog Properties
          • DownloadDialog
            • DownloadDialog Methods
            • DownloadDialog Properties
        • EnvironmentModel Enumerations
        • Interfaces
          • IWebAppBasics
            • IWebAppBasics Property
Powered by GitBook
On this page
  • Get Test Report details
  • Get Test report details (permanent URL)
  • Update Test Report
  • Get Instances
  • Get Instance details
  • Get debug info

Was this helpful?

  1. Portal
  2. REST API Reference

Test Reports

Get Test Report details

GET https://[customer].testresults.io/api/projects/:pId/testcases/:tcId/testplans/:tpId/testreports/:trId

Gets Test Report details.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

tpId

string

Test Plan ID

trId

string

Test Report ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "Comment": "",
  "EnvironmentId": "98bab3a6-9079-49ca-ba28-c8a50bfec5ee",
  "SubjectId": "fe36cc18-87dc-4b02-969a-1559641c8a9c",
  "TestPlanId": "e53ec211-3c3f-456b-ace8-ff8f5951b90e",
  "Variables": null,
  "RequestedInstancesCount": 0,
  "DataVersion": "AAAAAAAl760=",
  "TestType": "Stability",
  "ExecutionNumber": 2,
  "StartDateTime": "2018-09-07T13:53:27.0700000Z",
  "FinishDateTime": "2018-09-07T15:28:29.9100000Z",
  "Result": "Passed",
  "Status": "Accepted",
  "TotalDurationInSec": 5526,
  "AverageDurationInSec": 921,
  "TestCaseId": "4f30bd0e-347c-4ace-9654-d81476cbc0b0",
  "TestCaseIdentifier": "12_S",
  "TestCaseName": "Project Management (Stability)",
  "Tags": "stability projectManagement;ie",
  "SubjectName": "TestResults.io",
  "SubjectIdentifier": "1.0",
  "EnvironmentName": "Windows 10 Pro - IE",
  "TestPlanRevision": 2,
  "Id": "64f29a80-719d-47ee-8d1c-3962abaaf41b"
}

Get Test report details (permanent URL)

GET https://[customer].testresults.io/api/projects/0/testcases/0/testplans/0/testreports/:trId

Path Parameters

Name
Type
Description

trId

string

Test Report ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "Comment": "",
  "EnvironmentId": "98bab3a6-9079-49ca-ba28-c8a50bfec5ee",
  "SubjectId": "fe36cc18-87dc-4b02-969a-1559641c8a9c",
  "TestPlanId": "e53ec211-3c3f-456b-ace8-ff8f5951b90e",
  "Variables": null,
  "RequestedInstancesCount": 0,
  "DataVersion": "AAAAAAAl760=",
  "TestType": "Stability",
  "ExecutionNumber": 2,
  "StartDateTime": "2018-09-07T13:53:27.0700000Z",
  "FinishDateTime": "2018-09-07T15:28:29.9100000Z",
  "Result": "Passed",
  "Status": "Accepted",
  "TotalDurationInSec": 5526,
  "AverageDurationInSec": 921,
  "TestCaseId": "4f30bd0e-347c-4ace-9654-d81476cbc0b0",
  "TestCaseIdentifier": "12_S",
  "TestCaseName": "Project Management (Stability)",
  "Tags": "stability projectManagement;ie",
  "SubjectName": "TestResults.io",
  "SubjectIdentifier": "1.0",
  "EnvironmentName": "Windows 10 Pro - IE",
  "TestPlanRevision": 2,
  "Id": "64f29a80-719d-47ee-8d1c-3962abaaf41b"
}

Update Test Report

PUT https://[customer].testresults.io/api/projects/:pId/testcases/:tcId/testplans/:tpId/testreports/:trId

Updates an existing Test Report.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

tpId

string

Test Plan ID

trId

string

Test Report ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Status

string

new Status

Comment

string

Comment (for "Investigation" status)

{
  "Comment": "test",
  "EnvironmentId": "c7d6fb37-4446-4531-8b35-44a90bce9586",
  "SubjectId": "18d2f13d-6192-412e-88ce-d7026808c43f",
  "TestPlanId": "90c70ae4-9700-4619-ad15-3e897b4a30ec",
  "Variables": null,
  "RequestedInstancesCount": 1,
  "DataVersion": "AAAAAAAziks=",
  "TestType": "Default",
  "ExecutionNumber": 10,
  "StartDateTime": "2019-03-08T13:47:13.7633333Z",
  "FinishDateTime": "2019-03-08T13:47:27.4733333Z",
  "Result": "NotExecuted",
  "Status": "Investigation",
  "TotalDurationInSec": 0,
  "AverageDurationInSec": 0,
  "TestCaseId": "1b0140da-a55e-4141-a174-a7bc4398bf9a",
  "TestCaseIdentifier": "10",
  "TestCaseName": "test10",
  "Tags": "return false in tc setup",
  "SubjectName": "included in TE",
  "SubjectIdentifier": "3.0",
  "EnvironmentName": "StageBox",
  "TestPlanRevision": 1,
  "Id": "4b1588cf-238f-43a3-b329-8098765d8e40"
}

Get Instances

GET https://[customer].testresults.io/api/projects/:pId/testcases/:tcId/testplans/:tpId/testreports/:trId/instances

Gets all Instances for the selected Test Report.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

tpId

string

Test Plan ID

trId

string

Test Report ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
    {
    "Id": "00654b6c-5275-4433-b2fe-66865998ac11",
    "TestReportsId": "d6a7bc03-f55b-4d1a-bba9-ab552969210b",
    "InstanceNr": 1,
    "StartDateTime": "2019-02-14T10:16:57.3366667Z",
    "FinishDateTime": "2019-02-14T10:32:39.7700000Z",
    "DurationInSec": 918,
    "Result": "Passed"
  },
  {
    "Id": "9dc27d05-05d0-411e-a223-2041269f888f",
    "TestReportsId": "d6a7bc03-f55b-4d1a-bba9-ab552969210b",
    "InstanceNr": 2,
    "StartDateTime": "2019-02-14T10:32:40.6533333Z",
    "FinishDateTime": "2019-02-14T10:48:37.2266667Z",
    "DurationInSec": 926,
    "Result": "Passed"
  },
  {
    "Id": "68a96014-dea8-4049-9dd3-b47637a3ebbb",
    "TestReportsId": "d6a7bc03-f55b-4d1a-bba9-ab552969210b",
    "InstanceNr": 3,
    "StartDateTime": "2019-02-14T10:48:38.1466667Z",
    "FinishDateTime": "2019-02-14T10:53:51.0033333Z",
    "DurationInSec": 294,
    "Result": "Aborted"
  }
]

Get Instance details

GET https://[customer].testresults.io/api/projects/:pId/testcases/:tcId/testplans/:tpId/testreports/:trId/instances/:iId

Gets Instance details.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

tpId

string

Test Plan ID

trId

string

Test Report ID

iId

string

Instance ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "ArtifactsUri": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/artifacts.zip?sv=2018-03-28&sr=b&sig=QXT0s0uCUZ3K3ExAbrt%2F%2FK69ot%2B4IT4HrlRHdeEWfkw%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
  "ReportUri": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/report.docx?sv=2018-03-28&sr=b&sig=cwcgJdpVjeYxFZ5QQVp8TYj1wn8dGVAW2XNGVBjnE48%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
  "DebugLogUri": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/testengine-debug.log?sv=2018-03-28&sr=b&sig=6S0PPoAuA65%2F4ZSci1O6uzHSdvl2NMh30bs43qo%2Ba30%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
  "ExecutionLogUri": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq0/execution.log?sv=2018-03-28&sr=b&sig=1AvtnB1svLN3CYLqVkW1TSgMBzpvF9PeUls1%2Fkb0Z6k%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
  "InstallationLogUri": "",
  "Steps": [
    {
      "StepNr": 0,
      "DurationInSec": 19,
      "TestInput": "PRECONDITION: If a user is already loged in, logout.\nLogin to portal as triouser.",
      "ActualResult": "Login was successful, Portal startpage was loaded.\r\n",
      "ExpectedResult": "Portal startpage is loaded.",
      "Result": "Passed",
      "Screenshots": [
        "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/ProjectManagement_PRECONDITIONSTEP_1_PASSED.png?sv=2018-03-28&sr=b&sig=9W6Camk0OASlwmcfqtirwq3BAoOXRm5WtqejZAggSOA%3D&se=2019-05-03T16%3A18%3A13Z&sp=r"
      ],
      "Thumbnail": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/ProjectManagement_PRECONDITIONSTEP_1_PASSED_thumb.png?sv=2018-03-28&sr=b&sig=FHo%2B0N8ZmpJdy2HAW72RJ06xqo6RaMPkWC5MS0EpQ%2FA%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
      "History": [
        {
          "ExecutionNumber": -1,
          "StepNr": 0,
          "Result": "Aborted",
          "DurationInSec": 19
        }
      ],
      "SoftVerification": [],
      "Id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "StepNr": 1,
      "DurationInSec": 32,
      "TestInput": "CREATE PROJECT DIALOG:\nOn start page open the New Project Dialog, enter any name and description and cancel the dialog.",
      "ActualResult": "The project was not created after cancellation.\r\n",
      "ExpectedResult": "The project is not created.",
      "Result": "Passed",
      "Screenshots": [
        "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/ProjectManagement_STEP1_1_PASSED.png?sv=2018-03-28&sr=b&sig=IyhYtzzqHB8KeS2q1ojHVN5VTcFnlbm1GkegH0i8P54%3D&se=2019-05-03T16%3A18%3A13Z&sp=r"
      ],
      "Thumbnail": "https://pavestoreprogile01.blob.core.windows.net/f00d03ed-38d1-4c65-b42e-cb1ab768ff05/d6a7bc03-f55b-4d1a-bba9-ab552969210b-seq1/ProjectManagement_STEP1_1_PASSED_thumb.png?sv=2018-03-28&sr=b&sig=vkHLkZVOPYeOGXUe1qdpoHNJ6nvKkx6jn0JGRqCAStg%3D&se=2019-05-03T16%3A18%3A13Z&sp=r",
      "History": [
        {
          "ExecutionNumber": -1,
          "StepNr": 1,
          "Result": "Aborted",
          "DurationInSec": 32
        }
      ],
      "SoftVerification": [],
      "Id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "Id": "9dc27d05-05d0-411e-a223-2041269f888f",
  "TestReportsId": "d6a7bc03-f55b-4d1a-bba9-ab552969210b",
  "InstanceNr": 2,
  "StartDateTime": "2019-02-14T10:32:40.6533333Z",
  "FinishDateTime": "2019-02-14T10:48:37.2266667Z",
  "DurationInSec": 926,
  "Result": "Passed"
}

Get debug info

GET https://[customer].testresults.io/api/projects/0/testcases/0/testplans/0/testreports/:trId/debug

Gets debug data by Test Report.

Path Parameters

Name
Type
Description

trId

string

Test Report ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "Customer": {
      "Id": "00000000-0000-0000-0000-000000000010",
      "Name": "Test & Demo GmbH",
      "Subdomain": "stage",
      "StorageAccount": "pavestoreprogile01",
      "Appliances": "Development (Oleg):oleglocal,Dummy:dummyProbe,Stage Box:b8aeed7fa02a",
      "Archived": false,
      "Deleted": false
    },
    "Project": {
      "Id": "24E5D483-7356-400E-B19E-FC0A0FDCAE81",
      "Name": "API TestProject2",
      "Description": "",
      "Archived": false,
      "Deleted": false
    },
    "TestCase": {
      "Id": "598FA20E-2FA3-4568-83B2-3A56775DCCF1",
      "Identifier": "1234",
      "Name": "myFirstTestCase",
      "Description": "Verify that\n- the work area can be zoomed in;\n- the image can be resized;\n- the resizing can be undone.",
      "Archived": false,
      "Deleted": false
    },
    "TestPlan": {
      "Id": "861B7D43-F862-42A6-9644-24D56E57F273",
      "Revision": 2,
      "TestType": "Default",
      "Status": "Ready for execution",
      "MinimumDurationInMin": 0,
      "Instances": 1,
      "Archived": false,
      "Deleted": false
    },
    "TestReport": {
      "Id": "BDC169CC-4302-4B40-8F7D-6BDE002AEDF6",
      "Status": "InReview",
      "Result": "Passed",
      "ExecutionNumber": 2,
      "InstanceCount": 1,
      "IsFinished": true,
      "StartedAt": "2019-03-01T11:04:19.8000000",
      "FinishedAt": "2019-03-01T11:04:24.9800000",
      "Comment": "",
      "Archived": false,
      "Deleted": false
    },
    "Results": [
      {
        "Id": "5B082829-C835-4F5C-A076-505115FB3CA2",
        "InstanceNr": 1,
        "Result": "Passed",
        "DurationInSec": 87,
        "StartDateTime": "2019-03-01T11:04:19.8266667",
        "FinishDateTime": "2019-03-01T11:04:23.6533333"
      }
    ],
    "Schedules": [
      {
        "Id": "92A75C9B-AEAE-4D34-86C5-8A76F796FE0F",
        "ReportSequenceNr": 0,
        "Status": "Completed",
        "InitialQueuedTime": "2019-03-01T10:57:27.5766667",
        "ScheduleSentAt": "2019-03-01T11:03:31.3833333",
        "MinimumDurationInMin": 0,
        "NeedsPublicIp": false,
        "SoftwareIdentifier": "1.2.0.3",
        "StopOnFailure": true,
        "Tags": "some tag from Postman;-sim:paint",
        "TargetGroup": "azure",
        "TestEnvironmentIdentifier": "Windows 10"
      }
    ]
  }
]
PreviousTest PlansNextFiles

Last updated 6 years ago

Was this helpful?