Resource: Agile Run ( /api/agilerun/{id} )

Agile Run resource representing an agile run entity with Enterprise Tester, this resource allows you to fetch, update and delete existing runs within an Execution Package.

Methods

DELETE

Removes an agile run.

Required Permissions

TestManagement/ManageExecution

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 agile run was successfully deleted.

Example - DELETE

Example of deleting an agile run via DELETE.

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	GUID Identifier of Agile Run to delete.

Status Code

200 - OK

GET

Retrieves a single agile run by its GUID Identifier.

Required Permissions

TestManagement/View

Supported Expansions

FieldControls
FieldValues
Steps

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 request is completed successfully.
403 - Forbidden	Returned if request can not be completed due to lack of permissions or validation problems.
404 - NotFound	Returned if agile run does not exist.

Example - GET

Example of retrieving an agile run by its unique GUID Identifier.

Request Headers

Key	Value	Description
Content-type	application/json
Accept	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	GUID Identifier of the Agile Run to fetch.

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "AssignedToId": null,
  "AssignedTo": null,
  "Description": null,
  "Name": "Creating invoice with paste due date value",
  "Notes": null,
  "Number": 1,
  "Objective": null,
  "PostCondition": null,
  "PreCondition": null,
  "PriorityId": "a79e5778-befc-4ffe-b910-873ff737296c",
  "StatusId": "f304c468-58d4-4245-a9c8-7b61a42f57f3",
  "TypeId": "27537607-6c59-4d7c-b812-d5dff13ff738",
  "SourceId": null,
  "SourceContainerId": null,
  "PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25",
  "OrderNumber": 0,
  "ProjectId": "ef7b7b88-b990-4cb9-98b5-2d89786e51f3",
  "ProjectName": "Test Project",
  "PackageName": "Execution Sets",
  "EstimatedDuration": null,
  "ActualDuration": null,
  "ExecutionStatus": "Failed",
  "AgileRunNumberReadOnly": false,
  "Expands": [
    "FieldControls",
    "FieldValues"
  ],
  "Steps": [
    {
      "Description": "Click date field",
      "ExpectedResult": "Date field get's focus",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "945c7670-dd34-4d1a-b4d6-267f7959c3be",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Enter date 2010-1-1",
      "ExpectedResult": "Date is accepted",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "2e020ac3-8013-4daf-b5a4-b9ca9323da8e",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Click save",
      "ExpectedResult": "User is prompted with warning about paste due date",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": "No prompt displayed",
      "Result": "Failed",
      "Id": "db2799e8-966d-4548-bb04-af678ba75339",
      "HasIncidents": false,
      "HasAttachments": false
    }
  ],
  "Self": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    }
  ]
}

Status Code

200 - OK

PUT

Updates an agile run.

Required Permissions

TestManagement/ExecuteTests

Supported Expansions

FieldControls
FieldValues
Steps

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 request is completed successfully.

Example - PUT

Example of updating an agile run via PUT.

Request Headers

Key	Value	Description
Content-type	application/json
Accept	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	GUID Identifier of Agile Run to update

Request Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "AssignedToId": null,
  "Description": null,
  "Steps": [
    {
      "Description": "Click date field",
      "ExpectedResult": "Date field get's focus",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "00000000-0000-0000-0000-000000000000",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Enter date 2010-1-1",
      "ExpectedResult": "Date is accepted",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "00000000-0000-0000-0000-000000000000",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Click save",
      "ExpectedResult": "User is prompted with warning about paste due date",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": "No prompt displayed",
      "Result": "Failed",
      "Id": "00000000-0000-0000-0000-000000000000",
      "HasIncidents": false,
      "HasAttachments": false
    }
  ],
  "Name": "Creating invoice with paste due date value",
  "Notes": null,
  "Number": null,
  "Objective": null,
  "PostCondition": null,
  "PreCondition": null,
  "PriorityId": null,
  "StatusId": null,
  "TypeId": null,
  "PackageId": null,
  "OrderNumber": null,
  "ProjectId": null,
  "EstimatedDuration": null,
  "ActualDuration": null,
  "FieldControlValues": null,
  "FieldValues": null
}

Response Headers

Key	Value	Description
Location	http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Type	application/json; charset=utf-8

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "AssignedToId": null,
  "AssignedTo": null,
  "Description": null,
  "Name": "Creating invoice with paste due date value",
  "Notes": null,
  "Number": 1,
  "Objective": null,
  "PostCondition": null,
  "PreCondition": null,
  "PriorityId": "a79e5778-befc-4ffe-b910-873ff737296c",
  "StatusId": "f304c468-58d4-4245-a9c8-7b61a42f57f3",
  "TypeId": "27537607-6c59-4d7c-b812-d5dff13ff738",
  "SourceId": null,
  "SourceContainerId": null,
  "PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25",
  "OrderNumber": 0,
  "ProjectId": "ef7b7b88-b990-4cb9-98b5-2d89786e51f3",
  "ProjectName": "Test Project",
  "PackageName": "Execution Sets",
  "EstimatedDuration": null,
  "ActualDuration": null,
  "ExecutionStatus": "Failed",
  "AgileRunNumberReadOnly": false,
  "Expands": [
    "FieldControls",
    "FieldValues"
  ],
  "Steps": [
    {
      "Description": "Click date field",
      "ExpectedResult": "Date field get's focus",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "945c7670-dd34-4d1a-b4d6-267f7959c3be",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Enter date 2010-1-1",
      "ExpectedResult": "Date is accepted",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": null,
      "Result": "Passed",
      "Id": "2e020ac3-8013-4daf-b5a4-b9ca9323da8e",
      "HasIncidents": false,
      "HasAttachments": false
    },
    {
      "Description": "Click save",
      "ExpectedResult": "User is prompted with warning about paste due date",
      "Notes": null,
      "Data": null,
      "OrderNumber": 0,
      "ActualResult": "No prompt displayed",
      "Result": "Failed",
      "Id": "db2799e8-966d-4548-bb04-af678ba75339",
      "HasIncidents": false,
      "HasAttachments": false
    }
  ],
  "Self": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    }
  ]
}

Status Code

200 - OK

Child pages

Agile Run

Resource: Agile Run ( /api/agilerun/{id} )

Methods

DELETE

Required Permissions

Status Codes

GET

Required Permissions

Supported Expansions

Status Codes

PUT

Required Permissions

Supported Expansions

Status Codes