...
Agile Runs collection resource
Root Relation: AgileRuns
This resource supports the following methods: GET, POST
Methods
GET
...
Retrieves all (or a subset) of agile runs that are visible to the user.
...
Supported Expansions
- FieldControls
- FieldValues
- Steps
- Project
For more details on expansions, please see the Expand help topic.
...
Retrieves agile runs matching a TQL query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'Report' | The TQL query to execute. |
$top | 5 | Maximum number of results to return (defaults to 25). |
$skip | 0 | Number of results to skip before return the $top number of results matching the query. |
$expands | Steps | The aditional fields to expand |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Skip": 0, "Top": 5, "Total": 1, "Items": [ { "Id": "e7a8ade8-2452-4856-9f7d-6296b3b82fc8", "AssignedToId": null, "AssignedTo": null, "Description": null, "Name": "Report pagination", "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": 1, "ProjectId": "ef7b7b88-b990-4cb9-98b5-2d89786e51f3", "ProjectName": "Test Project", "PackageName": "Execution Sets", "EstimatedDuration": null, "ActualDuration": null, "ExecutionStatus": "Not Run", "AgileRunNumberReadOnly": false, "Expands": [ "FieldControls", "FieldValues" ], "Steps": [ { "Description": null, "View report with more then 25 rows of "ExpectedResult": nulldata", "NotesExpectedResult": null, "Next page button "Data": nullis displayed", "OrderNumberNotes": 0 "Use HTML report mode", "ActualResultOrderNumber": null0, "Result": "NotRun", "Id": "23d16899-703f-4e4a-84af-6b87e3bd3adb", }, "HasIncidents": false, { "HasAttachmentsDescription": false"Click next page button", } "ExpectedResult": "Page 2 is ]displayed", "SelfNotes": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8Use HTML report mode", "LinksOrderNumber": [1, { "Href"Result": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/relationshipsNotRun", "RelId": "Relationshipsca5a155d-7c4b-4876-bebe-c6bf8649465d" }, { "HrefDescription": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/allrelationships", Click last page button", "RelExpectedResult": "AllRelationships"Final page of results is displayed, next page button is disabled.", } "Notes": "Use HTML report ]mode", } ] } |
Status Code
200 - OK
Example - GET (no filter)Retrieves agile runs matching a TQL query.
Request Headers
Request Parameters
Key | Value | Description |
---|---|---|
$top | 5 | Maximum number of results to return (defaults to 25). |
$skip | 0 | Number of results to skip before return the $top number of results matching the query. |
$expands | Steps | The aditional fields to expand |
Response Headers
Response Body
Code Block | ||
---|---|---|
| ||
{ "Skip": 0, "Top": 5, "Total": 2, "Items": [ { "Data": "Use the large sample data set", "OrderNumber": 2, "Result": "NotRun", "Id": "b37d130a-98b9-4b2a-9b79-af9fcfae6177" } ], "IdSelf": "4bb709c2-e0e7-4af3-9f60-a045016a9610http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8", "AssignedToIdLinks": null,[ "AssignedTo": null, { "Description": null, "NameHref": "Agile Run Started At 2-05-2012 10:00:08 p.m.", http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/relationships", "NotesRel": null,"Relationships" "Number": 1}, "Objective": null, { "PostCondition": null, "PreConditionHref": null, "PriorityId": "a79e5778-befc-4ffe-b910-873ff737296chttp://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/allrelationships", "StatusIdRel": "f304c468-58d4-4245-a9c8-7b61a42f57f3", AllRelationships" "TypeId": "27537607-6c59-4d7c-b812-d5dff13ff738", } "SourceId": null,] "SourceContainerId": null,} ] } |
Status Code
200 - OK
Retrieves agile runs matching a TQL query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
$top | 5 | Maximum number of results to return (defaults to 25). |
$skip | 0 | Number of results to skip before return the $top number of results matching the query. |
$expands | Steps | The aditional fields to expand |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Skip": 0,
"Top": 5,
"Total": 2,
"Items": [
{
"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": [
"FieldControls",
"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"
}
]
},
{
"Id": "e7a8ade8-2452-4856-9f7d-6296b3b82fc8",
"Description": null,
"Name": "Report pagination",
"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": 1,
"ProjectId": "ef7b7b88-b990-4cb9-98b5-2d89786e51f3",
"ProjectName": "Test Project",
"PackageName": "Execution Sets",
"EstimatedDuration": null,
"ActualDuration": null,
"ExecutionStatus": "Not Run",
"AgileRunNumberReadOnly": false,
"Expands": [
"FieldControls",
"FieldValues"
],
"Steps": [
{
"Description": "View report with more then 25 rows of data",
"ExpectedResult": "Next page button is displayed",
"Notes": "Use HTML report mode",
"OrderNumber": 0,
"Result": "NotRun",
"Id": "23d16899-703f-4e4a-84af-6b87e3bd3adb"
},
{
"Description": "Click next page button",
"ExpectedResult": "Page 2 is displayed",
"Notes": "Use HTML report mode",
"OrderNumber": 1,
"Result": "NotRun",
"Id": "ca5a155d-7c4b-4876-bebe-c6bf8649465d"
},
{
"Description": "Click last page button",
"ExpectedResult": "Final page of results is displayed, next page button is disabled.",
"Notes": "Use HTML report mode",
"Data": "Use the large sample data set",
"OrderNumber": 2,
"Result": "NotRun",
"Id": "b37d130a-98b9-4b2a-9b79-af9fcfae6177"
}
],
"Self": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8",
"Links": [
{
"Href": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/relationships",
"Rel": "Relationships"
},
{
"Href": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/allrelationships",
"Rel": "AllRelationships"
}
]
}
]
}
|
Status Code
200 - OK
POST
...
Creates a new agile run.
Required Permissions
- TestManagement/ExecuteTests
Supported Expansions
- FieldControls
- FieldValues
- Steps
- Project
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 |
---|---|
201 - Created | Returned if agile run is created successfully. |
Example of creating a new agile run with the bare minimum of information (supplying only the package where the agile run should be created).
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25" }
|
Response Headers
Key | Value | Description |
---|---|---|
Location | http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610 | |
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "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": [ "FieldControls", "FieldValues", "Steps" ], "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": [ "FieldControls", "FieldValues" ], "Steps": [ { "Description": null, "ExpectedResult": null, "Notes": null, "Data": null, "OrderNumber": 0, "ActualResult": null, "Result": "NotRun", "Id": "b85cea17-60ce-48ba-923f-f7c332c99cda", "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" } ] }, { "Id": "e7a8ade8-2452-4856-9f7d-6296b3b82fc8", "AssignedToId": null, "AssignedTo": null, "Description": null, "Name": "Report pagination",} ] } |
Status Code
201 - Created
Example of creating a new agile run with all inbuilt fields populated.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "AssignedToId": "f508eb90-445e-41ba-9921-b1740ae930f8", "Description": "Attempting to login with an invalid password should not allow access to the application", "Steps": [ { "NotesDescription": null, "Enter login and press "Number": 1tab", "ObjectiveExpectedResult": null, "PostCondition": null"Focus moves to password field", "PreConditionOrderNumber": null0, "PriorityIdResult": "a79e5778-befc-4ffe-b910-873ff737296c", Passed" }, "StatusId": "f304c468-58d4-4245-a9c8-7b61a42f57f3", { "TypeIdDescription": "27537607-6c59-4d7c-b812-d5dff13ff738", "SourceId": nullEnter invalid password and press enter", "SourceContainerIdExpectedResult": null, "PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25"Error message displayed stating that username or password is invalid.", "OrderNumberNotes": 1, "Invalid passwords must be longer then "ProjectId": "ef7b7b88-b990-4cb9-98b5-2d89786e51f3", "ProjectName": "Test Projectminimum length for a valid password e.g. 6 characters", "PackageNameData": "Execution Sets", "EstimatedDuration": nullExample passwords: 'invalid', 'unkonwn', '$$$$$'", "ActualDurationOrderNumber": null1, "ExecutionStatusActualResult": "Not RunWas logged in successfully", "AgileRunNumberReadOnlyResult": false, "Expands": ["Failed" } ], "FieldControlsName", : "Login using invalid password", "FieldValuesNotes" : "Some notes about the ]script", "Number": 123, "StepsObjective": [ "To determine if app password validation is working {correctly", "PostCondition": "Access must "Description": nullbe denied", "PreCondition": "User must exist, but with a different "ExpectedResult": null, "Notes": nullpassword to what we will attempt to login with", "PriorityId": "a79e5778-befc-4ffe-b910-873ff737296c", "Data": null, "OrderNumber": 0, "ActualResult": null, "Result": "NotRun", "Id": "23d16899-703f-4e4a-84af-6b87e3bd3adb", "HasIncidents": false, "HasAttachments": false } ], "Self": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8", "Links": [ { "Href": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/agilerun/e7a8ade8-2452-4856-9f7d-6296b3b82fc8/allrelationships", "Rel": "AllRelationships" } ] } ] } |
Status Code
200 - OK
POST
Creates a new agile run.
Required Permissions
- TestManagement/ManageExecution
Supported Expansions
- FieldControls
- FieldValues
- Steps
- Project
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 |
---|---|
201 - Created | Returned if agile run is created successfully. |
"StatusId": "f304c468-58d4-4245-a9c8-7b61a42f57f3",
"TypeId": "27537607-6c59-4d7c-b812-d5dff13ff738",
"PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25",
"OrderNumber": 0,
"EstimatedDuration": "5m",
"ActualDuration": "5m"
}
|
Response Headers
Key | Value | Description |
---|---|---|
Location | http://localhost/api/agilerun/4bb709c2-e0e7-4af3-9f60-a045016a9610 | |
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"AssignedToId": "f508eb90-445e-41ba-9921-b1740ae930f8",
"AssignedTo": "Joe Bloggs",
"Description": "Attempting to login with an invalid password should not allow access to the application",
"Name": "Login using invalid password",
"Notes": null,
"Number": 123,
"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": [
"FieldControls",
"FieldValues"
],
"Steps": [
{
"Description": "Enter login and press tab",
"ExpectedResult": "Focus moves to password field",
"OrderNumber": 0,
"Result": "Passed",
"Id": "7c1d0d2d-aa32-4655-b08a-b95367a1b631"
},
{
"Description": "Enter invalid password and press enter",
"ExpectedResult": "Error message displayed stating that username or password is invalid.",
"Notes": "Invalid passwords must be longer then minimum length for a valid password e.g. 6 characters",
"Data": "Example passwords: 'invalid', 'unkonwn', '$$$$$'",
"OrderNumber": 1,
"ActualResult": "Was logged in successfully",
"Result": "Failed",
"Id": "ea8bc4de-cfaf-4db8-811b-f88449e1e675"
} |
Example of creating a new agile run with the bare minimum of information (supplying only the package where the agile run should be created).
Request Headers
Request Body
Code Block | ||
---|---|---|
| ||
{ "PackageId": "a5c52dc7-e849-4af9-ab99-a01401130d25" }
|
Response Headers
Response Body
Code Block | ||
---|---|---|
| ||
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"AssignedToId": null,
"AssignedTo": null,
"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",
"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": "Not Run",
"AgileRunNumberReadOnly": false,
"Expands": [
"FieldControls",
"FieldValues",
"Steps"
],
"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
201 - Created
...