Automated Test Run Result Children

Automated Test Run Result Children

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

A collection resource representing the child result ndes of an Automated Test Run Result node.

This resource supports the following methods: GET

 

Methods

GET


Retrieves the children of a particular automated test run result node. This collection can optionally be filtered by outcome/status. Passing an empty GUID for the node ID will return the root nodes in a run.

Required Permissions

  • TestManagement/ManageExecutions/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).

Status

Description

200 - OK

Returned if the request was completed successfully.

400 - BadRequest

Returned if the status filter included an invalid status.

403 - Forbidden

Returned 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 - NotFound

Returned if the ID for the run or the node was not found in the database.

 

Example - GET

 

Retrieves run result children by parent node ID.

Request Headers

Key

Value

Description

Accept

application/json

 

Request Parameters

Key

Value

Description

{runId}

1459858c-9526-412e-afdd-09415593c2d3

The unique identifier (GUID) of the run to get results for.

{nodeId}

b8166143-c269-4bd8-876e-d2584edc4e2e

The parent node unique identifier (GUID) to find children for (or an empty GUID to find root nodes).

Response Headers

Key

Value

Description

Content-Type

application/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", "Parameters" ], "Self": "http://localhost/api/automatedtestrun/1459858c-9526-412e-afdd-09415593c2d3/node/a1d456c4-3713-4f5e-906b-8d56fd977aa2" }, { "HasAttachments": false, "HasIncidents": false, "HasChildren": false, "Id": "8b34026c-260e-4a8c-8bc5-60df88cf1c27", "Name": "Failed test run node", "Description": "A node that's failed", "Notes": null, "Status": "Failed", "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/8b34026c-260e-4a8c-8bc5-60df88cf1c27" }, { "HasAttachments": false, "HasIncidents": false, "HasChildren": false, "Id": "12a4c6ad-5c99-4f61-974b-723543cb167c", "Name": "Not run test run node", "Description": "A node that's not been run", "Notes": null, "Status": "NotRun", "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/12a4c6ad-5c99-4f61-974b-723543cb167c" } ]

Status Code

200 - OK

 

Example - GET with statuses filter

 

Retrieves run result children by parent node ID, including only nodes that have (or with descendants that have) one of the specified statuses.

Request Headers

Key

Value

Description

Accept

application/json

 

Request Parameters

Key

Value

Description

{runId}

1459858c-9526-412e-afdd-09415593c2d3

The unique identifier (GUID) of the run to get results for.

{nodeId}

b8166143-c269-4bd8-876e-d2584edc4e2e

The parent node unique identifier (GUID) to find children for (or an empty GUID to find root nodes).

statuses

Passed,Done

A comma separated list of statuses to filter by. Valid statuses are: Passed, Failed, Done, Warning, Information, Skipped, Error and NotRun.

Response Headers

Key

Value

Description

Content-Type

application/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", "Parameters" ], "Self": "http://localhost/api/automatedtestrun/1459858c-9526-412e-afdd-09415593c2d3/node/a1d456c4-3713-4f5e-906b-8d56fd977aa2" } ]

Status Code

200 - OK