This documentation explains the list of publicly available REST API in synapseRT to perform the products own actions via programmatically.
...
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
POST /rest/synapse/latest/public/testRun/createTestRuns Note:
STATUS 200 Returned if the Test Runs are successfully created from the Test Cycle STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the testCaseKey or cycleId or attributeValues provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
...
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
POST /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/linkBugToTestRun
STATUS 200 Returned if the Bug is successfully linked to the Test Run STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the testPlanIssueKey provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
Expand | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
POST /rest/synapse/latest/public/attachmenttestRun/{runId}/testrun Please note that runId doesn't include the prefix 'TR'. Supported content type: MULTIPART_FORM_DATA step/linkBug?tpKey=?&cycleName=? Example: POST /rest/synapse/latest/public/testRun/step/linkBug?tpKey=FRS-888&cycleName=Sprint 25 Cycle 1
| Response | STATUS
|
Case 1:
Code Block | ||
---|---|---|
| ||
{
"testCaseKey":"FRS-15",
"stepOrderNumber":"2",
"bugs":["FRS-33","FRS-36"]
} |
Case 2:
Code Block | ||
---|---|---|
| ||
{
"testCaseKey":"FRS-15",
"testRunStepId":"10000",
"bugs":["FRS-33","FRS-36"]
} |
Case 3:
Code Block | ||
---|---|---|
| ||
{
"testCaseKey":"FRS-15",
"stepOrderNumber":"2",
"iterationId":"1000",
"bugs":["FRS-33","FRS-36"]
} |
Status | ||||
---|---|---|---|---|
|
STATUS 200 Returned if the attachment Bug is successfully added linked to the Test Run
STATUS 403 Returned if the user is not authorized perform the action or there is no valid license
STATUS 404 Returned if the runId testPlanIssueKey provided is not found
STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error
...
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
POST /rest/synapse/latest/public/attachment/{runId}/testrun/step/{ Please note that runId doesn't include the prefix 'TR'. Supported content type: MULTIPART_FORM_DATA
STATUS 200 Returned if the attachment is successfully added to Test Run STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the runId provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
POST /rest/synapse/latest/public/attachment/{runId}/testrun/step/{stepno} Please note that runId doesn't include the prefix 'TR'. Supported content type: MULTIPART_FORM_DATA
STATUS 200 Returned if the attachment is successfully added to Test Run Step STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the runId provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
POST: /rest/synapse/latest/public/testSuite/createTestCase
STATUS 200 Returned if the Test Case is successfully created STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
...
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
POST: /rest/synapse/latest/public/testSuite/linkTestCase
STATUS 200 Returned if the Test Case/s is successfully linked to specified Test Suite STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
POST /rest/synapse/latest/public/testCase/{testCaseIssueKey}/addSteps
STATUS 200 Returned if the Test Steps are successfully added to the Test Case STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the testCaseIssueKey provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
GET /rest/synapse/latest/public/testCase/{testCaseIssueKey}/steps
STATUS 200 Returned if the Test Steps are successfully added to retrieved from the Test Case STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the testCaseIssueKey estCaseIssueKey provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
GET /rest/synapse/latest/public/testCase/{testCaseIssueKey}/steps
Code Block | | ||||||
|
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{ "expectedResultestimate": "User logged in successfully.10m", "tcIdforecast": 15713 }, { "sequenceNumber": "2"5m", "idissueKey": 1673, "step": "Choose any ticket and click on 'Purchase' button.""FRS-15", "expectedResultissueId": "It redirects to 'Purchase' page.", "tcId": 15713 } ]16110" } |
Status | ||||
---|---|---|---|---|
|
STATUS 200 Returned if the Test Steps are Time Tracking information is successfully retrieved from the Test Case
STATUS 403 Returned if the user is not authorized perform the action or there is no valid license
STATUS 404 Returned if the testCaseIssueKey provided is not found
STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
POST /rest/synapse/latest/public/requirementSuite/create
STATUS 200 Returned if the Requirement Suite is successfully created STATUS 403 Returned if the user is not authorized perform the action or there is no valid license STATUS 404 Returned if the projectKey provided is not found STATUS 500 Returned if there is any validation error with input data or any unknown Internal Server Error |
...