Date: Fri, 29 Mar 2024 11:53:40 +0000 (UTC) Message-ID: <1347334799.12015.1711713220046@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12014_146610469.1711713220045" ------=_Part_12014_146610469.1711713220045 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Agile Run resource representing an agile run entity with Enterprise Test= er, this resource allows you to fetch, update and delete existing runs with= in an Execution Package.
This resource supports the following methods: DELETE, GET, PUT
Removes an agile run.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if agile run was successfully deleted.<= /td> |
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
Retrieves a single agile run by its GUID Identifier.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if request is completed successfully.= td> |
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 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=3Dutf-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-a045016a96= 10", "Links": [ { "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a04501= 6a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a04501= 6a9610/allrelationships", "Rel": "AllRelationships" } ] }
Status Code
200 - OK
Updates an agile run.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if request is completed successfully.= td> |
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", "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
Key | Value | Description |
---|---|---|
Location | http://localhost/api/agilerun/4bb709c2-e0e= 7-4af3-9f60-a045016a9610 | |
Content-Type | application/json; charset=3Dutf-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-a045016a96= 10", "Links": [ { "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a04501= 6a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a04501= 6a9610/allrelationships", "Rel": "AllRelationships" } ] }
Status Code
200 - OK