Help Contents

 

Agile Run

updated by Catch Admin (Sep 12, 2018)

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.

This resource supports the following methods: DELETE, GET, PUT

Methods

DELETE

Removes an agile run.

Required Permissions

  • TestManagement/ManageExecutions/Delete

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

Example - DELETE

Example of deleting an agile run via DELETE.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}4bb709c2-e0e7-4af3-9f60-a045016a9610GUID Identifier of Agile Run to delete.

Status Code

200 - OK

GET

Retrieves a single agile run by its GUID 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 is completed successfully.
403 - ForbiddenReturned if request can not be completed due to lack of permissions or validation problems.
404 - NotFoundReturned if agile run does not exist.

Example - GET

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

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}4bb709c2-e0e7-4af3-9f60-a045016a9610GUID Identifier of the Agile Run to fetch.

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Description": null,
  "Name": "Agile Run Started At 2-05-2012 10:00:08 p.m.",
  "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",
  "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": "Not Run",
  "AgileRunNumberReadOnly": false,
  "Expands": [
    "Widgets",
    "FieldValues"
  ],
  "Steps": [
    {
      "Description": null,
      "ExpectedResult": null,
      "OrderNumber": 0,
      "Result": "NotRun",
      "Id": "b85cea17-60ce-48ba-923f-f7c332c99cda"
    }
  ],
  "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/ManageExecutions/ExecuteAllTests
  • TestManagement/ManageExecutions/ExecuteOnlyMyTests

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

Example - PUT

Example of updating an agile run via PUT.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}4bb709c2-e0e7-4af3-9f60-a045016a9610GUID Identifier of Agile Run to update

Request Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Steps": [
    {
      "Description": "Click date field",
      "ExpectedResult": "Date field get's focus",
      "OrderNumber": 0,
      "Result": "Passed"
    },
    {
      "Description": "Enter date 2010-1-1",
      "ExpectedResult": "Date is accepted",
      "OrderNumber": 1,
      "Result": "Passed"
    },
    {
      "Description": "Click save",
      "ExpectedResult": "User is prompted with warning about paste due date",
      "OrderNumber": 2,
      "ActualResult": "No prompt displayed",
      "Result": "Failed"
    }
  ],
  "Name": "Creating invoice with paste due date value"
}

Response Headers

KeyValueDescription
Locationhttp://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Description": "Creating invoices for past dates is allowed, but we want a warning to be displayed to the user.",
  "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",
  "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": [
    "Widgets",
    "FieldValues",
    "Project"
  ],
  "Steps": [
    {
      "Description": "Click date field",
      "ExpectedResult": "Date field get's focus",
      "OrderNumber": 0,
      "Result": "Passed",
      "Id": "945c7670-dd34-4d1a-b4d6-267f7959c3be"
    },
    {
      "Description": "Enter date 2010-1-1",
      "ExpectedResult": "Date is accepted",
      "OrderNumber": 1,
      "Result": "Passed",
      "Id": "2e020ac3-8013-4daf-b5a4-b9ca9323da8e"
    },
    {
      "Description": "Click save",
      "ExpectedResult": "User is prompted with warning about paste due date",
      "OrderNumber": 2,
      "ActualResult": "No prompt displayed",
      "Result": "Failed",
      "Id": "db2799e8-966d-4548-bb04-af678ba75339"
    }
  ],
  "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