Step Result Incident
Resource: Step Result Incident ( /api/stepresult/{stepResultId}/incident/{id} )
Allows you to manage a single incident linked to a step result.
This resource supports the following methods: DELETE, GET
Methods
DELETE
Deletes an incident link belonging to a step result.
Required Permissions
TestManagement/ManageExecutions/ExecuteAllTests
TestManagement/ManageExecutions/ExecuteOnlyMyTests
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
|---|---|
200 - OK | Returned if link was deleted successfully. |
403 - Forbidden | Returned if step result can not be deleted (normally because you don't have necessary permissions). |
404 - NotFound | Returned if step result was not found. |
Example - Remove incident link
Remove link between step result and incident.
Request Headers
Key | Value | Description |
|---|---|---|
Accept | application/json |
|
Request Parameters
Key | Value | Description |
|---|---|---|
{stepResultId} | 0F61B42D-87F9-40B8-89EE-1BC12A6B5DBA | The unique identifier (GUID) of the step result to link to the incident. |
{id} | B849F98E-62B2-460C-97EF-49E6C478A3F9 | The unique identifier (GUID) of the incident to link to the step result. |
Response Headers
Key | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 |
|
Status Code
200 - OK
GET
Retrieves an an incident link belonging to a step result.
Required Permissions
TestManagement/ManageExecutions/View
TestManagement/ManageIncidents/View
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
|---|---|
200 - OK | Returned if the request was completed successfully. |
403 - Forbidden | Returned if you do not have permission to view the link. |
404 - NotFound | Returned if step result or incident link does not exist. |
Example - Get incident link
Retrieves a single step result to incident link.
Request Headers
Key | Value | Description |
|---|---|---|
Accept | application/json |
|
Request Parameters
Key | Value | Description |
|---|---|---|
{stepResultId} | 0F61B42D-87F9-40B8-89EE-1BC12A6B5DBA | Unique identifier of the step result. |
{id} | B849F98E-62B2-460C-97EF-49E6C478A3F9 | Unique identifier of the incident. |
Response Headers
Key | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 |
|
Response Body
{
"StepResultId": "b849f98e-62b2-460c-97ef-49e6c478a3f9",
"IncidentId": "0f61b42d-87f9-40b8-89ee-1bc12a6b5dba",
"Expands": [
"Incident",
"StepResult"
],
"Self": "http://localhost/api/stepresult/b849f98e-62b2-460c-97ef-49e6c478a3f9/incident/0f61b42d-87f9-40b8-89ee-1bc12a6b5dba",
"Links": [
{
"Href": "http://localhost/api/incident/0f61b42d-87f9-40b8-89ee-1bc12a6b5dba",
"Rel": "Incident"
}
]
}
Status Code
200 - OK