Test Cases

Get Test Cases

GET https://[customer].testresults.io/api/projects/:pId/testcases

Gets all active (without archive) Test Cases.

Path Parameters

Name
Type
Description

pId

string

Project ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "Identifier": "00",
    "Name": "dummy test",
    "Description": "",
    "LastPlanStatus": "ReadyForExecution",
    "LastReportStatus": "EngineExecutionFailure",
    "LastResult": "Error",
    "LastSwName": "no installer",
    "LastSwIdentifier": "dummy",
    "ExecutionStatistics": [
      {
        "ExecutionNumber": 10,
        "Result": "Passed",
        "AverageDurationInSec": 33
      },
      {
        "ExecutionNumber": 11,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 12,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 13,
        "Result": "Error",
        "AverageDurationInSec": 0
      },
      {
        "ExecutionNumber": 14,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 15,
        "Result": "Passed",
        "AverageDurationInSec": 66
      },
      {
        "ExecutionNumber": 16,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 17,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 18,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 19,
        "Result": "Error",
        "AverageDurationInSec": 0
      }
    ],
    "Id": "199a14c4-b6f2-4526-afd4-69c115bfbfe8"
  }
]

Get archive Test Cases

GET https://[customer].testresults.io/api/projects/:pId/testcases/archive

Gets all archive Test Cases.

Path Parameters

Name
Type
Description

pId

string

Project ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "Identifier": "00",
    "Name": "dummy test",
    "Description": "",
    "LastPlanStatus": "ReadyForExecution",
    "LastReportStatus": "EngineExecutionFailure",
    "LastResult": "Error",
    "LastSwName": "no installer",
    "LastSwIdentifier": "dummy",
    "ExecutionStatistics": [
      {
        "ExecutionNumber": 10,
        "Result": "Passed",
        "AverageDurationInSec": 33
      },
      {
        "ExecutionNumber": 11,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 12,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 13,
        "Result": "Error",
        "AverageDurationInSec": 0
      },
      {
        "ExecutionNumber": 14,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 15,
        "Result": "Passed",
        "AverageDurationInSec": 66
      },
      {
        "ExecutionNumber": 16,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 17,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 18,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 19,
        "Result": "Error",
        "AverageDurationInSec": 0
      }
    ],
    "Id": "199a14c4-b6f2-4526-afd4-69c115bfbfe8"
  }
]

Get recent Test Cases

GET https://[customer].testresults.io/api/projects/:pId/testcases/recent

Gets all recently opened Test Cases.

Path Parameters

Name
Type
Description

pId

string

Project ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "Identifier": "00",
    "Name": "dummy test",
    "Description": "",
    "LastPlanStatus": "ReadyForExecution",
    "LastReportStatus": "EngineExecutionFailure",
    "LastResult": "Error",
    "LastSwName": "no installer",
    "LastSwIdentifier": "dummy",
    "ExecutionStatistics": [
      {
        "ExecutionNumber": 10,
        "Result": "Passed",
        "AverageDurationInSec": 33
      },
      {
        "ExecutionNumber": 11,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 12,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 13,
        "Result": "Error",
        "AverageDurationInSec": 0
      },
      {
        "ExecutionNumber": 14,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 15,
        "Result": "Passed",
        "AverageDurationInSec": 66
      },
      {
        "ExecutionNumber": 16,
        "Result": "Passed",
        "AverageDurationInSec": 61
      },
      {
        "ExecutionNumber": 17,
        "Result": "Passed",
        "AverageDurationInSec": 69
      },
      {
        "ExecutionNumber": 18,
        "Result": "Passed",
        "AverageDurationInSec": 63
      },
      {
        "ExecutionNumber": 19,
        "Result": "Error",
        "AverageDurationInSec": 0
      }
    ],
    "Id": "199a14c4-b6f2-4526-afd4-69c115bfbfe8"
  }
]

Get Test Cases by Test Set

GET https://[customer].testresults.io/api/projects/:pId/testsets/:tsId/testcases

Gets Test Cases included in Test Set.

Path Parameters

Name
Type
Description

pId

string

Project ID

tsId

string

Test Set ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "DataVersion": null,
    "Archived": false,
    "TestPlanList": null,
    "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
    "Identifier": "222",
    "Name": "test case 2",
    "Description": "",
    "LastPlanStatus": "New",
    "LastReportStatus": null,
    "LastResult": null,
    "LastSwName": null,
    "LastSwIdentifier": null,
    "ExecutionStatistics": [],
    "Id": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e"
  },
  {
    "DataVersion": null,
    "Archived": false,
    "TestPlanList": null,
    "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
    "Identifier": "001",
    "Name": "new test case",
    "Description": "asasdads",
    "LastPlanStatus": "ReadyForExecution",
    "LastReportStatus": null,
    "LastResult": null,
    "LastSwName": null,
    "LastSwIdentifier": null,
    "ExecutionStatistics": [],
    "Id": "a0202dbd-6515-4a75-89dd-ca62e5c92403"
  }
]

Include Test Cases in Test Set

POST https://[customer].testresults.io/api/projects/:pId/testsets/:tsId/testcases

Include Test Cases in Test Set.

Path Parameters

Name
Type
Description

pId

string

Project ID

tsId

string

Test Set ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Id

string

Test Case ID

{
  "TestCases": [
    {
      "DataVersion": null,
      "Archived": false,
      "TestPlanList": null,
      "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
      "Identifier": "222",
      "Name": "test case 2",
      "Description": "",
      "LastPlanStatus": "New",
      "LastReportStatus": null,
      "LastResult": null,
      "LastSwName": null,
      "LastSwIdentifier": null,
      "ExecutionStatistics": [],
      "Id": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e"
    },
    {
      "DataVersion": null,
      "Archived": false,
      "TestPlanList": null,
      "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
      "Identifier": "001",
      "Name": "new test case",
      "Description": "asasdads",
      "LastPlanStatus": "ReadyForExecution",
      "LastReportStatus": null,
      "LastResult": null,
      "LastSwName": null,
      "LastSwIdentifier": null,
      "ExecutionStatistics": [],
      "Id": "a0202dbd-6515-4a75-89dd-ca62e5c92403"
    }
  ],
  "SelectedSubjectId": "00000000-0000-0000-0000-000000000000",
  "SelectedEnvironmentId": "fbeb9e8f-d469-4e99-a182-93234cff1273",
  "Priority": null,
  "LastRunDuration": "00:00:00",
  "Tags": "",
  "StopOnFailure": false,
  "TimeOut": 0,
  "DataVersion": "AAAAAAAyxPw=",
  "Archived": false,
  "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Name": "111",
  "Description": null,
  "LastExecuted": null,
  "LastSubjectId": null,
  "LastSwIdentifier": null,
  "LastSwName": null,
  "LastExecutionStatistic": null,
  "Id": "13475656-c685-4379-8a56-caf146435e0c"
}

Include Test Case in Test Sets

PUT https://[customer].testresults.io/api/projects/:pId/testsets/:tsId/testcases

Include Test Case in Test Sets. (!) Request payload should be an array of objects (e.g [ { Id; your_test_case_ID } ]).

Path Parameters

Name
Type
Description

pId

string

Project ID

tsId

string

Test Set ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Id

string

Test Case ID

{
  "TestCases": [
    {
      "DataVersion": null,
      "Archived": false,
      "TestPlanList": null,
      "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
      "Identifier": "222",
      "Name": "test case 2",
      "Description": "",
      "LastPlanStatus": "New",
      "LastReportStatus": null,
      "LastResult": null,
      "LastSwName": null,
      "LastSwIdentifier": null,
      "ExecutionStatistics": [],
      "Id": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e"
    },
    {
      "DataVersion": null,
      "Archived": false,
      "TestPlanList": null,
      "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
      "Identifier": "001",
      "Name": "new test case",
      "Description": "asasdads",
      "LastPlanStatus": "ReadyForExecution",
      "LastReportStatus": null,
      "LastResult": null,
      "LastSwName": null,
      "LastSwIdentifier": null,
      "ExecutionStatistics": [],
      "Id": "a0202dbd-6515-4a75-89dd-ca62e5c92403"
    }
  ],
  "SelectedSubjectId": "00000000-0000-0000-0000-000000000000",
  "SelectedEnvironmentId": "fbeb9e8f-d469-4e99-a182-93234cff1273",
  "Priority": null,
  "LastRunDuration": "00:00:00",
  "Tags": "",
  "StopOnFailure": false,
  "TimeOut": 0,
  "DataVersion": "AAAAAAAyxPw=",
  "Archived": false,
  "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Name": "111",
  "Description": null,
  "LastExecuted": null,
  "LastSubjectId": null,
  "LastSwIdentifier": null,
  "LastSwName": null,
  "LastExecutionStatistic": null,
  "Id": "13475656-c685-4379-8a56-caf146435e0c"
}

Exclude Test Case

DELETE https://[customer].testresults.io/api/projects/:pId/testsets/:tsId/testcases

Exclude Test Case from Test Set. (!) Request payload should be an array of objects (e.g [ { Id: your_test_case_ID } ]).

Path Parameters

Name
Type
Description

pId

string

Project ID

tsId

string

Test Set ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Id

string

Test Case ID

Get Test Case details

GET https://[customer].testresults.io/api/projects/:pId/testcases/:tcId

Gets Test Case details.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "DataVersion": "AAAAAAAIgo8=",
  "Archived": false,
  "TestPlanList": [
    {
      "Description": null,
      "Revision": 4,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": "",
      "Instances": 1,
      "Id": "5e522f7b-ee28-4834-bf7b-bd1d4fa1024e"
    },
    {
      "Description": null,
      "Revision": 3,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 1,
      "Id": "a6b8f76e-87fc-43ce-88d0-6e23f981ff69"
    },
    {
      "Description": null,
      "Revision": 2,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 1,
      "Id": "2b866ad3-dd1c-4c9e-96e9-919473655c9b"
    },
    {
      "Description": null,
      "Revision": 1,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 1,
      "Id": "e4bc3050-d951-4add-a643-f2cdd168042d"
    }
  ],
  "ProjectId": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
  "Identifier": "01",
  "Name": "ExecutionRegression",
  "Description": "",
  "LastPlanStatus": "ReadyForExecution",
  "LastReportStatus": "InReview",
  "LastResult": "Passed",
  "LastSwName": "TestResults.io",
  "LastSwIdentifier": "1.0",
  "ExecutionStatistics": [
    {
      "ExecutionNumber": 289,
      "Result": "Error",
      "AverageDurationInSec": 0
    },
    {
      "ExecutionNumber": 290,
      "Result": "Passed",
      "AverageDurationInSec": 67
    },
    {
      "ExecutionNumber": 291,
      "Result": "Error",
      "AverageDurationInSec": 0
    },
    {
      "ExecutionNumber": 292,
      "Result": "Passed",
      "AverageDurationInSec": 72
    },
    {
      "ExecutionNumber": 293,
      "Result": "Passed",
      "AverageDurationInSec": 73
    },
    {
      "ExecutionNumber": 294,
      "Result": "Passed",
      "AverageDurationInSec": 73
    },
    {
      "ExecutionNumber": 295,
      "Result": "Passed",
      "AverageDurationInSec": 71
    },
    {
      "ExecutionNumber": 296,
      "Result": "Passed",
      "AverageDurationInSec": 73
    },
    {
      "ExecutionNumber": 297,
      "Result": "Passed",
      "AverageDurationInSec": 73
    },
    {
      "ExecutionNumber": 298,
      "Result": "Passed",
      "AverageDurationInSec": 74
    }
  ],
  "Id": "ce787fd7-dc6d-4a6f-917b-7e62625555e0"
}

Get Test Case details (permanent URL)

GET https://[customer].testresults.io/api/projects/0/testcases/:tcId

Gets Test Case details for permanent URL.

Path Parameters

Name
Type
Description

tcId

string

Test Case ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "DataVersion": "AAAAAAAltTo=",
  "Archived": false,
  "TestPlanList": [
    {
      "Description": null,
      "Revision": 3,
      "TestType": "Performance",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 2,
      "Id": "09105f9d-96b0-4aa8-ab8d-18802a8b7e1e"
    },
    {
      "Description": null,
      "Revision": 2,
      "TestType": "Stability",
      "MinimumDurationInMin": 6,
      "MonitoringMessage": null,
      "Instances": 0,
      "Id": "7804c3f2-2861-4377-816a-123c103c8fdf"
    },
    {
      "Description": null,
      "Revision": 1,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 1,
      "Id": "f276e758-7565-48f9-ac9f-5fd035b54ec9"
    }
  ],
  "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Identifier": "222",
  "Name": "test case 2",
  "Description": "",
  "LastPlanStatus": "New",
  "LastReportStatus": null,
  "LastResult": null,
  "LastSwName": null,
  "LastSwIdentifier": null,
  "ExecutionStatistics": [],
  "Id": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e"
}

Create new Test Case

POST https://[customer].testresults.io/api/projects/:pId/testcases

Creates new Test Case.

Path Parameters

Name
Type
Description

pId

string

Project ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Name

string

Name of Test Case

Description

string

Description of Test Case

Identifier

string

Identifier of Test Case

{
  "Identifier": "555666",
  "Name": "new tc",
  "Description": "asdasdasdasd",
  "LastPlanStatus": null,
  "LastReportStatus": null,
  "LastResult": null,
  "LastSwName": null,
  "LastSwIdentifier": null,
  "ExecutionStatistics": [],
  "Id": "12243f6d-db89-4dee-b765-34e2f09c7a7b"
}

Update Test Case

PUT https://[customer].testresults.io/api/projects/:pId/testcases/:tcId

Updates an existing Test Case.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

Name

string

Name of Test Case

Description

string

Description of Test Case

Archived

boolean

Archive flag

{
  "DataVersion": "AAAAAAAziYA=",
  "Archived": false,
  "TestPlanList": [
    {
      "Description": null,
      "Revision": 14,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": null,
      "Instances": 1,
      "Id": "12293311-7e81-41af-ac90-d5aca7eb19f9"
    },
    {
      "Description": null,
      "Revision": 13,
      "TestType": "Default",
      "MinimumDurationInMin": 0,
      "MonitoringMessage": "",
      "Instances": 1,
      "Id": "a5f78699-e3ab-46df-b037-b866074ef68c"
    }
  ],
  "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Identifier": "8888",
  "Name": "888",
  "Description": "",
  "LastPlanStatus": "New",
  "LastReportStatus": null,
  "LastResult": null,
  "LastSwName": null,
  "LastSwIdentifier": null,
  "ExecutionStatistics": [],
  "Id": "69738e2f-7665-4871-bae1-0c76e416de93"
}

Delete Test Case

DELETE https://[customer].testresults.io/api/projects/:pId/testcases/:tcId

Removes an existing Test Case.

Path Parameters

Name
Type
Description

pId

string

Project ID

tcId

string

Test Case ID

Headers

Name
Type
Description

Authentication

string

Authentication token
PreviousTest SetsNextTest Plans

Last updated