Test Plans

Get Test Plan details

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

Gets Test Plan details.

Path Parameters

Name	Type	Description
pId	string	Project ID
tcId	string	Test Case ID
tpId	string	Test Plan ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200 Cake successfully retrieved.

{
  "DataVersion": "AAAAAAAl1qM=",
  "Status": "New",
  "Variables": [],
  "InputFileId": "6253be56-384d-462e-ada4-e9f63d94a98b",
  "SupportingFilesId": null,
  "AutomationSupportingFilesId": null,
  "AutomatedTestContainerId": null,
  "TestReports": [],
  "ExecutionStatistics": [],
  "TestCaseId": "f88b1426-2b64-4e8f-927f-a9113b10d488",
  "Description": null,
  "Revision": 4,
  "TestType": "Default",
  "MinimumDurationInMin": 600,
  "MonitoringMessage": null,
  "Instances": 123,
  "Id": "502f373e-8abc-4f17-b27f-26165b2b3f5e"
}

Get Test Plan details (permanent URL)

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

Gets Test Plan details for permanent URL.

Path Parameters

Name	Type	Description
tpId	string	Test Plan ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
  "DataVersion": "AAAAAAAzieQ=",
  "Status": "New",
  "Variables": [],
  "InputFileId": null,
  "SupportingFilesId": null,
  "AutomationSupportingFilesId": null,
  "AutomatedTestContainerId": null,
  "TestReports": [],
  "ExecutionStatistics": [],
  "TestCaseId": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e",
  "Description": null,
  "Revision": 3,
  "TestType": "Performance",
  "MinimumDurationInMin": 0,
  "MonitoringMessage": null,
  "Instances": 2,
  "Id": "09105f9d-96b0-4aa8-ab8d-18802a8b7e1e"
}

Create new Test Plan

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

Creates new Test Plan

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
Instances	number	Count of Instances
MinimumDurationInMin	number	Minimum Duration in minutes
TestType	string	Test Type

200

{
  "DataVersion": "AAAAAAAzieQ=",
  "Status": "New",
  "Variables": [],
  "InputFileId": null,
  "SupportingFilesId": null,
  "AutomationSupportingFilesId": null,
  "AutomatedTestContainerId": null,
  "TestReports": [],
  "ExecutionStatistics": [],
  "TestCaseId": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e",
  "Description": null,
  "Revision": 3,
  "TestType": "Performance",
  "MinimumDurationInMin": 0,
  "MonitoringMessage": null,
  "Instances": 2,
  "Id": "09105f9d-96b0-4aa8-ab8d-18802a8b7e1e"
}

Update Test Plan

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

Updates an existing Test Plan.

Path Parameters

Name	Type	Description
pId	string	Project ID
tcId	string	Test Case ID
tpId	string	Test Plan ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Id	string	Test Plan ID
Status	string	Status
Instances	number	Count of Instances
Variables	array	Variables List
InputFileId	string	Test Case Plan Document ID
SupportingFilesId	string	Supporting Files ID
AutomationSupportingFilesId	string	Automation Supporting Files ID
AutomatedTestContainerId	string	Automated Test Case ID
TestReports	array	Test Reports List
ExecutionStatistics	array	Execution Statistics List
TestCaseId	string	Test Case ID
Description	string	Test Plan Description
Revision	number	Revision number
TestType	string	Test Type
MinimumDurationInMin	number	Minimum Duration in minutes
MonitoringMessage	string	Monitoring Message
DataVersion	string	Data Version of Test Plan

200

{
  "DataVersion": "AAAAAAAzieI=",
  "Status": "New",
  "Variables": [],
  "InputFileId": "78d201da-c6a4-499a-839b-1b7beac235e0",
  "SupportingFilesId": "c76dcb99-eddc-405d-8bcc-f654f4ce1130",
  "AutomationSupportingFilesId": null,
  "AutomatedTestContainerId": null,
  "TestReports": [],
  "ExecutionStatistics": [],
  "TestCaseId": "a0e99e4f-82b9-4ed7-9636-c2acc219af9e",
  "Description": null,
  "Revision": 2,
  "TestType": "Stability",
  "MinimumDurationInMin": 6,
  "MonitoringMessage": null,
  "Instances": 0,
  "Id": "7804c3f2-2861-4377-816a-123c103c8fdf"
}

Register Automation Steps

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

Register Automation Steps.

Path Parameters

Name	Type	Description
pId	string	Project ID
tcId	string	Test Case ID
tpId	string	Test Plan ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
comment	string	Comment
count	number	Count

200 Returns count (number)

4 

Change Test Type of the Test Case

POST https://[customer].testresults.io/api/projects/:pId/testcases/:tcId/testplans/:tpId/transfer/:newType

Sets new Test Type for Test Case. A new Plan Revision will be created.

Path Parameters

Name	Type	Description
pId	string	Project ID
tcId	string	Test Case ID
tpId	string	Test Plan ID
newType	string	New Test Type (e.g "Performance", "Stability" or "Default")

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
  "DataVersion": "AAAAAAAzic0=",
  "Status": "ReadyForExecution",
  "Variables": [],
  "InputFileId": "91b7a914-7a9b-4b1a-a707-d4cc036e624e",
  "SupportingFilesId": null,
  "AutomationSupportingFilesId": null,
  "AutomatedTestContainerId": "4a818722-3079-437f-80ba-ae778d0cdfe0",
  "TestReports": [],
  "ExecutionStatistics": [],
  "TestCaseId": "649571bc-7578-4254-a4cb-158d36c56bf5",
  "Description": null,
  "Revision": 7,
  "TestType": "Performance",
  "MinimumDurationInMin": 0,
  "MonitoringMessage": null,
  "Instances": 2,
  "Id": "c5919b52-3757-4c41-a737-b5c622e92044"
}