Resource: Agile Run Relationships ( /api/agilerun/{id}/relationships )
A resource representing the set of relationships belonging to the Agile Run.
This resource supports the following methods: GET
Methods
GET
Retrieves all relationships
Required Permissions
- TestManagement/ManageExecutions/View
- TestManagement/ManageRequirements/View
- TestManagement/ManageScripts/View
- TestManagement/ManageIncidents/View
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 the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to view the relationships associated with this entity. |
| 404 - NotFound | Returned if the entity does not exist. |
Example - Retrieve Relationships
Retrieve relationships (the response is a generic example, and does not necessarily represent the type of relationships that would be returned for this Entity Type).
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 5E2814AF-1800-4C8F-B7C8-2ED9FADF98D0 | The ID of the entity to retrieve the relationships for |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"EntityId": "8F00D2CE-6243-4956-AF89-60B7B9755A9B",
"Number": "1",
"Name": "Some Script",
"EntityType": "TestScript",
"AssignedTo": "joeb",
"Status": "Draft",
"Priority": "High",
"Type": "Functional",
"PackageId": "c232382b-0c66-475b-b59b-8753d4c5377b",
"PackageName": "Cycle 1",
"PackageEntityType": "ScriptPackage",
"PackagePath": "/Script Library/Cycle 1",
"RelationshipId": null,
"RelationshipTypeKey": "ScriptToRequirementCoverage",
"RelationshipType": "Coverage",
"Relation": "Covered By",
"RelationshipDirection": "Source -> Destination",
"CanDelete": true,
"CanEdit": false,
"Children": [
{
"EntityId": "4155F037-B778-4E9D-B942-0CC237D51038",
"Number": "2",
"Name": "Some Requirement",
"EntityType": "Requirement",
"AssignedTo": "janed",
"Status": "Draft",
"Priority": "Medium",
"Type": "Functional",
"PackageId": "454bc5ca-3496-4abb-a69a-919bf5f3ca0b",
"PackageName": "Cycle 1",
"PackageEntityType": "RequirementPackage",
"PackagePath": "/Requirements/Cycle 1",
"RelationshipId": null,
"RelationshipTypeKey": "ScriptToRequirementCoverage",
"RelationshipType": "Coverage",
"Relation": "Covered By",
"RelationshipDirection": "Destination -> Source",
"CanDelete": false,
"CanEdit": true,
"Children": [],
"Links": [
{
"Href": "http://localhost/api",
"Rel": "Entity"
}
]
}
],
"Links": [
{
"Href": "http://localhost/api",
"Rel": "Entity"
}
]
}
Status Code
200 - OK