Help Contents

 

Step Result

Resource: Step Result ( /api/stepresult/{id} )

Step Result resource

This resource supports the following methods: GET

Methods

GET


Retrieves a single step result by it's unique Identifier

Required Permissions

  • TestManagement/ManageExecutions/View

Supported Expansions

For more details on expansions, please see the Expand help topic.

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 request completed successfully.
403 - ForbiddenReturned if you do not have permission to view the step result.
404 - NotFoundReturned if no step result with that identifier exists.

Example - Get step result

Retrieves a step result by it's unique identifier

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}B849F98E-62B2-460C-97EF-49E6C478A3F9Unique identifier of the step result

Response Headers

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

Response Body

{
  "RunId": "b849f98e-62b2-460c-97ef-49e6c478a3f9",
  "Id": "710885a6-da30-46ff-9dc2-7623893378cf",
  "Description": "Click the 'save' button",
  "Data": null,
  "Notes": null,
  "ExpectedResult": "Save success message displayed",
  "ActualResult": "Exception message displayed",
  "Outcome": "Failed",
  "HasIncidents": false,
  "HasAttachments": false,
  "Self": "http://localhost/api/stepresult/710885a6-da30-46ff-9dc2-7623893378cf"
}

Status Code

200 - OK