Breadcrumbs

Test Plan Resource

Below are the list of REST APIs we developed related to test plan.

Add a Test Cycle to a Test Plan

POST /rest/testray/latest/public/testPlan/{testPlanIssueKey}/addCycle

SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/addCycle

REQUEST body

JSON
{
    "name":"REST API Cycle 1",
    "environment":"Firefox",
    "build":"v9.0",
    "plannedStartDate":"2021-10-10",
    "plannedEndDate":"2025-11-11"
}
Get Test Cycles from a Test Plan

get /rest/testray/latest/public/testPlan/{testPlanIssueKey}/cycles

SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/cycles

REQUEST body NULL

Update Test Cycle Status

Put /rest/testray/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/wf/{action}

SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/cycle/Cycle 1/wf/Start

If there is no test run created from ‘Assign Configurations’ option, please use following to start test cycle with ‘No Configuration’ assigned for test runs:

http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/cycle/Cycle 1/wf/Start?forceStart=true

REQUEST body NULL

actions

  • Start

  • Complete

  • Abort

  • Resume

Delete a Test Cycle from a Test Plan by Cycle ID

delete /rest/testray/latest/public/testPlan/{testPlanIssueKey}/deleteCycleById

SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/deleteCycleById

REQUEST body

JSON
{ 
    "id": "1000"
}
Get Defects Reported from a Test Plan

get /rest/testray/latest/public/testPlan/{testPlanIssueKey}/defects

SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/testPlan/TAT-200/defects

REQUEST body NULL