Resource: Automated Test Run Result Node ( /api/automatedtestrun/{runId}/node/{nodeId} )

Represents a single automated test result node, which can be either retrieved or updated.

This resource supports the following methods: GET, PATCH

Methods

GET

Retrieves a result node of an automated test run by node ID.

Required Permissions

  • TestManagement/View

Supported Expansions

  • Metadata
  • Parameters
  • Children

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 the request was completed successfully.
403 - ForbiddenReturned if ET could not complete the request (normally due to a validation failure or the necessary permissions to complete the request have not been met).
404 - NotFoundReturned if the ID for the run or the node was not found in the database.

Example - GET

Retrieves run result nodes by ID.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{runId}1459858c-9526-412e-afdd-09415593c2d3The unique identifier (GUID) of the run to get results for.
{nodeId}a1d456c4-3713-4f5e-906b-8d56fd977aa2The node unique identifier (GUID) to find.

Response Headers

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

Response Body

[
  {
    "HasAttachments": false,
    "HasIncidents": false,
    "HasChildren": true,
    "Id": "a1d456c4-3713-4f5e-906b-8d56fd977aa2",
    "Name": "Passing test run node",
    "Description": "A node that passes",
    "Notes": null,
    "Status": "Passed",
    "Iteration": 5,
    "StartedAt": "2008-12-25T01:24:00Z",
    "FinishedAt": "2008-12-25T01:29:00Z",
    "DurationInSeconds": 300.0,
    "Expands": [
      "Children"
    ],
    "Metadata": {
      "ApplicationDir": "C:\\Program Files (x86)\\HP\\QuickTest Professional",
      "ApplicationPath": "\\samples\\flight\\app\\flight4a.exe"
    },
    "Parameters": {
      "Disp": "OpenApplication [FlightLib] Summary",
      "ElementName": "Action"
    },
    "Self": "http://localhost/api/automatedtestrun/1459858c-9526-412e-afdd-09415593c2d3/node/a1d456c4-3713-4f5e-906b-8d56fd977aa2"
  }
]

Status Code

200 - OK

PATCH

Patches a result node of an automated test run by node ID (allows updating of the Notes field associated with a result node).

Required Permissions

  • TestManagement/ExecuteTests

Supported Expansions

  • Metadata
  • Parameters
  • Children

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 the request was completed successfully.
403 - ForbiddenReturned if ET could not complete the request (normally due to a validation failure or the necessary permissions to complete the request have not been met).
404 - NotFoundReturned if the ID for the run or the node was not found in the database.

Example - PATCH

Update the Notes field of an existing result node.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{runId}1459858c-9526-412e-afdd-09415593c2d3The unique identifier (GUID) of the run to get results for.
{nodeId}a1d456c4-3713-4f5e-906b-8d56fd977aa2The node unique identifier (GUID) to find.

Request Body

{
  "Notes": "This test fails if run after 3pm"
}

Response Headers

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

Response Body

[
  {
    "HasAttachments": false,
    "HasIncidents": false,
    "HasChildren": true,
    "Id": "a1d456c4-3713-4f5e-906b-8d56fd977aa2",
    "Name": "Passing test run node",
    "Description": "A node that passes",
    "Notes": "This test fails if run after 3pm",
    "Status": "Passed",
    "Iteration": 5,
    "StartedAt": "2008-12-25T01:24:00Z",
    "FinishedAt": "2008-12-25T01:29:00Z",
    "DurationInSeconds": 300.0,
    "Expands": [
      "Children",
      "Metadata",
      "Parameters"
    ],
    "Self": "http://localhost/api/automatedtestrun/1459858c-9526-412e-afdd-09415593c2d3/node/a1d456c4-3713-4f5e-906b-8d56fd977aa2"
  }
]

Status Code

200 - OK

  • No labels