Requirement Resource

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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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