Help Contents
-
System Administration
-
User Guide & Application Administration Guide
-
Using Enterprise Tester
-
Application Administration
-
Searching & TQL
-
API
-
API / Permissions
-
Features
-
Resources
-
Agile Run
-
Agile Run All Relationships
-
Agile Run Relationships
-
Agile Runs
-
Agile Run Step Attachments
-
Agile Run Step Incident
-
Agile Run Step Incidents
-
Agile Run Step Result Attachment
-
API / Resources / Resources / Search #1
-
API / Resources / Resources / Search #2
-
Assigned To Search
-
Attachment Contents
-
Automated Test
-
Automated Test All Relationships
-
Automated Test Assignment
-
Automated Test Assignment All Relationships
-
Automated Test Assignment Relationships
-
Automated Test Assignment Runs
-
Automated Test Assignments
-
Automated Test Relationships
-
Automated Test Run
-
Automated Test Run Attachment
-
Automated Test Run Attachments
-
Automated Test Run Data
-
Automated Test Run Incident
-
Automated Test Run Incidents
-
Automated Test Run Node Attachment
-
Automated Test Run Node Attachments
-
Automated Test Run Result Children
-
Automated Test Run Result Node
-
Automated Test Run Result Root Nodes
-
Automated Test Runs
-
Automated Tests
-
Automated Test Schedule
-
Automated Test Schedule Import Configuration
-
Automated Test Schedule Import Configurations
-
Automated Test Schedules
-
Automated Test Schedule Schedule Configuration
-
Automated Test Schedule Schedule Configuration Run
-
Automated Test Schedule Schedule Configurations
-
Automated Test Type
-
Automated Test Types
-
Background Task
-
Background Tasks
-
Custom Field
-
Custom Fields (Resources)
-
Custom Field Type
-
Custom Field Types
-
Event Types Search
-
Execution Package
-
Execution Package Children
-
Execution Packages
-
Export File
-
External Source Metadata
-
External Sources Metadata
-
External System
-
External System's Links
-
External System Link
-
External System Link Copy
-
External System Link Field Values
-
External System Links
-
External System Links Search
-
External System Link Ticket
-
External System Link Ticket Link
-
External Systems
-
External System Type
-
External System Types
-
Grid Widget Data
-
Grid Widget State
-
Grid Widget States
-
Group
-
Group Permission Projects
-
Group Permissions
-
Groups
-
Groups Search
-
Group Users
-
Incident
-
Incident All Relationships
-
Incident Attachment
-
Incident Attachments
-
Incident Comments
-
Incident Relationships
-
Incident Relationships All Relationships
-
Incidents
-
Latest Performance Measurement
-
Mail Queue Messages
-
Mail Sender Settings
-
Notification
-
Notification Entity Type Search
-
Notifications (Resources)
-
Organisation (Resources)
-
Organisation Picklist
-
Organisation Picklist Search
-
Organisation Relationship Types
-
Organisations
-
Permission
-
Permissions (Resources)
-
Project (Resources)
-
Project Assignees
-
Project Categories
-
Project Category
-
Project Category Children
-
Project Group Permissions
-
Project Picklist
-
Project Picklist Search
-
Projects
-
Projects Search
-
Project Templates
-
Project Tickets
-
Project User Permissions
-
Relationship (Resources)
-
Relationships (Resources)
-
Relationship Type (Resources)
-
Relationship Types
-
Requirement
-
Requirement All Relationships
-
Requirement Attachment
-
Requirement Attachments
-
Requirement Children
-
Requirement Comments
-
Requirement Package
-
Requirement Package Children
-
Requirement Packages
-
Requirement Relationships
-
Requirements (Resources)
-
Resources / Custom Fields
-
Resources / Notifications
-
Resources / Organisation
-
Resources / Permissions
-
Resources / Project
-
Resources / Relationship
-
Resources / Relationships
-
Resources / Relationship Type
-
Resources / Requirements
-
Resources / Script
-
Resources / Search
-
Resources / Widgets
-
Root
-
Rover Execution Tree
-
Rover Licensing Info
-
Script's Assignments
-
Script (Resources)
-
Script All Relationships
-
Script Assignment
-
Script Assignment All Relationships
-
Script Assignment Relationships
-
Script Assignment Runs
-
Script Assignments
-
Script Attachment
-
Script Attachments
-
Script Package
-
Script Package Children
-
Script Packages
-
Script Relationships
-
Script Run
-
Script Runs
-
Scripts
-
Search (Resources)
-
Search Index
-
Search Indexes
-
Step Result
-
Step Result Attachment
-
Step Result Attachments
-
Step Result Incident
-
Step Result Incidents
-
Swagger API
-
Swagger API List
-
Synchronizer Schedule
-
Synchronizer Schedule Run
-
Synchronizer Schedules
-
System Event
-
System Events
-
System Info
-
Temporary Attachment Set
-
Temporary Attachment Set Attachment
-
Temporary Attachments Set
-
Test Automated Test Assignments
-
Time Zone
-
User
-
User Groups
-
User Mail
-
User Password
-
User Permission Projects
-
User Permissions
-
Users
-
Users and Group Search
-
Users Search
-
Agile Run
-
Swagger
-
API / Permissions
-
Using Enterprise Tester
-
Platform Plugins
-
Troubleshooting
-
Earlier Versions of this Documentation
-
Support & Bug Fixes
-
NextGen
-
Enterprise Tester 6.7.1
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).
Status | Description |
---|---|
200 - OK | Returned if agile run was successfully deleted. |
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/ManageExecutions/View
Supported Expansions
- Widgets
- FieldValues
- Steps
- Project
- Status
- Priority
- Type
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 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", "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
- Widgets
- FieldValues
- Steps
- Project
- Status
- Priority
- Type
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 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-e0e7-4af3-9f60-a045016a9610 | |
Content-Type | application/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