Below are the list of REST APIs we developed related to requirement.
Add Child Requirements to a Requirement
POST /rest/testray/latest/public/requirement/{requirementIssueKey}/addChildren
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/addChildren
REQUEST body
{
"requirementKeys": ["TAT-501","TAT-502"]
}
Get All Child Requirements from a Requirement
get /rest/testray/latest/public/requirement/{requirementIssueKey}/getChildren
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/getChildren
REQUEST body NULL
Get All Immediate Child Requirements from a Requirement
get /rest/testray/latest/public/requirement/{requirementIssueKey}/getOnlyImmediateChildren
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/getOnlyImmediateChildren
REQUEST body NULL
Get Requirement Suite List from a Project
get /rest/testray/latest/public/requirement/{projectKey}/requirementSuites
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT/requirementSuites
REQUEST body NULL
Delete Child Requirement Issues from a Requirement
Delete /rest/testray/latest/public/requirement/{requirementIssueKey}/removeChildren
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/removeChildren
REQUEST body
{
"requirementKeys":["TAT-501","TAT-502"]
}
Get Requirement Suite Information from a Requirement
get /rest/testray/latest/public/requirement/{requirementIssueKey}/linkedRequirementSuites
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/linkedRequirementSuites
REQUEST body NULL
Create a Requirement Suite from a Project
POST /rest/testray/latest/public/requirementSuite/create
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirementSuite/create
REQUEST body
{
"projectKey":"TAT",
"suiteName":"API - REQ Suite",
"parentSuiteId":0
}
Link a Requirement Issue to a Requirement Suite
POST /rest/testray/latest/public/requirementSuite/addMember
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirementSuite/addMember
REQUEST body
{
"memberId":80000,
"requirementSuiteId":500,
"memberProjectKeyOrId":"TAT"
}
Get Requirement Suite Members (both Sub Requirement Suites and Requirement Issues)
get /rest/testray/latest/public/requirement/{projectKey}/requirementSuite/440
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT/requirementSuite/500
REQUEST body NULL
Delete a Requirement Issue from a Requirement Suite
Delete /rest/testray/latest/public/requirementSuite/deleteMember
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirementSuite/deleteMember
REQUEST body
{
"requirementSuiteId":500,
"memberId":80000
}
Delete a Requirement Suite
Delete /rest/testray/latest/public/requirementSuite/delete
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirementSuite/delete
REQUEST body
{
"projectKeyOrId":"TAT",
"requirementSuiteId":500
}
Link Test Case Issues to a Requirement
POST /rest/testray/latest/public/requirement/{requirementIssueKey}/linkTestCase
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/linkTestCase
REQUEST body
{
"testCaseKeys": ["TAT-100","TAT-101"]
}
Get Linked Test Case Issues from a Requirement
get /rest/testray/latest/public/requirement/{requirementIssueKey}/linkedTestCases
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/linkedTestCases
REQUEST body NULL
Delete Test Case Issues from a Requirement
Delete /rest/testray/latest/public/requirement/{requirementIssueKey}/deleteLinkedTestCases
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/deleteLinkedTestCases
REQUEST body
{
"testCaseKeys": ["TAT-100","TAT-101"]
}
Get Linked Defect Issues from a Requirement
get /rest/testray/latest/public/requirement/{requirementIssueKey}/getDefects
SAMPLE http://testray.goldfingerholdings.onl/rest/testray/latest/public/requirement/TAT-500/getDefects
REQUEST body NULL