Iterations - List

Reference

Service:: Test

API Version:: 7.1-preview.3

Get iterations for a result

GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/iterations?api-version=7.1-preview.3

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/iterations?includeActionResults={includeActionResults}&api-version=7.1-preview.3

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
runId	path	True	integer int32	ID of the test run that contains the result.
testCaseResultId	path	True	integer int32	ID of the test result that contains the iterations.
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.3' to use this version of the api.
includeActionResults	query		boolean	Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

Responses

Name	Type	Description
200 OK	TestIterationDetailsModel[]	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.test	Grants the ability to read test plans, cases, results and other test management related artifacts.

Examples

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/results/Results/{testCaseResultId}/iterations?api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "id": 1,
      "outcome": "Passed",
      "errorMessage": "",
      "startedDate": "2014-05-04T13:00:38.697Z",
      "completedDate": "2014-05-04T13:00:44.567Z",
      "durationInMs": 5871,
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/4/Results/100000?iterationId=1"
    },
    {
      "id": 2,
      "outcome": "Passed",
      "errorMessage": "",
      "startedDate": "2014-05-04T13:00:38.7Z",
      "completedDate": "2014-05-04T13:00:56.637Z",
      "durationInMs": 17938,
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/4/Results/100000?iterationId=2"
    }
  ]
}

Definitions

Name	Description
SharedStepModel	Reference to shared step workitem.
TestActionResultModel	Represents a test step result.
TestCaseResultAttachmentModel	Test attachment information in a test iteration.
TestIterationDetailsModel	Represents a test iteration result.
TestResultParameterModel	Test parameter information in a test iteration.

SharedStepModel

Reference to shared step workitem.

Name	Type	Description
id	integer	WorkItem shared step ID.
revision	integer	Shared step workitem revision.

TestActionResultModel

Represents a test step result.

Name	Type	Description
actionPath	string	Path identifier for test step in test case workitem. Note: 1) It is represented in Hexadecimal format with 8 digits for a step. 2) Internally, the step ID value for first step starts with 2 so actionPath = 00000002 step 9, will have an ID = 10 and actionPath = 0000000a step 15, will have an ID =16 and actionPath = 00000010 3) actionPath of shared step is concatenated with the parent step of test case. Example, it would be something of type - 0000000300000001 where 00000003 denotes action path of test step and 00000001 denotes action path for shared step
comment	string	Comment in result.
completedDate	string	Time when execution completed(UTC).
durationInMs	number	Duration of execution.
errorMessage	string	Error message in result.
iterationId	integer	Iteration ID of test action result.
outcome	string	Test outcome of result.
sharedStepModel	SharedStepModel	Reference to shared step workitem.
startedDate	string	Time when execution started(UTC).
stepIdentifier	string	This is step Id of test case. For shared step, it is step Id of shared step in test case workitem; step Id in shared step. Example: TestCase workitem has two steps: 1) Normal step with Id = 1 2) Shared Step with Id = 2. Inside shared step: a) Normal Step with Id = 1 Value for StepIdentifier for First step: "1" Second step: "2;1"
url	string	Url of test action result. Deprecated in hosted environment.

TestCaseResultAttachmentModel

Test attachment information in a test iteration.

Name	Type	Description
actionPath	string	Path identifier test step in test case workitem.
id	integer	Attachment ID.
iterationId	integer	Iteration ID.
name	string	Name of attachment.
size	integer	Attachment size.
url	string	Url to attachment.

TestIterationDetailsModel

Represents a test iteration result.

Name	Type	Description
actionResults	TestActionResultModel[]	Test step results in an iteration.
attachments	TestCaseResultAttachmentModel[]	Reference to attachments in test iteration result.
comment	string	Comment in test iteration result.
completedDate	string	Time when execution completed(UTC).
durationInMs	number	Duration of execution.
errorMessage	string	Error message in test iteration result execution.
id	integer	ID of test iteration result.
outcome	string	Test outcome if test iteration result.
parameters	TestResultParameterModel[]	Test parameters in an iteration.
startedDate	string	Time when execution started(UTC).
url	string	Url to test iteration result.

TestResultParameterModel

Test parameter information in a test iteration.

Name	Type	Description
actionPath	string	Test step path where parameter is referenced.
iterationId	integer	Iteration ID.
parameterName	string	Name of parameter.
stepIdentifier	string	This is step Id of test case. For shared step, it is step Id of shared step in test case workitem; step Id in shared step. Example: TestCase workitem has two steps: 1) Normal step with Id = 1 2) Shared Step with Id = 2. Inside shared step: a) Normal Step with Id = 1 Value for StepIdentifier for First step: "1" Second step: "2;1"
url	string	Url of test parameter. Deprecated in hosted environment.
value	string	Value of parameter.

Share via