Help Contents

 

Agile Run Step Incident

Resource: Agile Run Step Incident ( /api/agilerun/{runId}/step/{stepId}/incident/{incidentId} )

Allows you to manage a single incident linked to a agile run step.

This resource supports the following methods: DELETE, GET

Methods

DELETE


Removes an incident link belonging to a agile run step.

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).

StatusDescription
200 - OKReturned if link was removed successfully.
403 - ForbiddenReturned if incident link can not be removed (normally because you don't have necessary permissions).
404 - NotFoundReturned if agile run, step or incident do not exist.

Example - Remove incident link

Remove link between agile run step and incident.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{runId}b716ac5e-61a3-4394-9b50-a13014129864The unique identifier (GUID) of the agile run.
{stepId}cbd88178-5e33-43b4-8172-01beaf5bdb75The unique identifier (GUID) of the agile run step.
{incidentId}15759d66-ae69-476e-be2a-d1a5eb59ab5eThe unique identifier (GUID) of the incident.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Status Code

200 - OK

GET


Retrieves an an incident link belonging to a agile run step.

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).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if you do not have permission to view the link.
404 - NotFoundReturned if agile run, step or incident do not exist.

Example - Get incident link

Retrieves a single agile run step to incident link.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{runId}b716ac5e-61a3-4394-9b50-a13014129864The unique identifier (GUID) of the agile run.
{stepId}cbd88178-5e33-43b4-8172-01beaf5bdb75The unique identifier (GUID) of the agile run step.
{incidentId}15759d66-ae69-476e-be2a-d1a5eb59ab5eThe unique identifier (GUID) of the incident.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "StepId": "cbd88178-5e33-43b4-8172-01beaf5bdb75",
  "RunId": "b716ac5e-61a3-4394-9b50-a13014129864",
  "IncidentId": "15759d66-ae69-476e-be2a-d1a5eb59ab5e",
  "Expands": [
    "Incident",
    "Run"
  ],
  "Self": "http://localhost/api/agilerun/b716ac5e-61a3-4394-9b50-a13014129864/step/cbd88178-5e33-43b4-8172-01beaf5bdb75/incident/15759d66-ae69-476e-be2a-d1a5eb59ab5e",
  "Links": [
    {
      "Href": "http://localhost/api/incident/15759d66-ae69-476e-be2a-d1a5eb59ab5e",
      "Rel": "Incident"
    }
  ]
}

Status Code

200 - OK