Resource: Relationship Type ( /api/organisation/{id}/relationshiptype/{key} )

Allows retrieving of details for a single relationship type belonging to an organisation.

This resource supports the following methods: GET

Methods

GET

Retrieves all relationship types

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Required Permissions

  • TestManagement/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).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Retrieve a single relationship type by key

Retrieves all the relationship types

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}e12cce32-7029-4083-99dd-51aed6fd8adbID of the Organisation to fetch the relationship type for.
{key}RequirementToRequirementAssociationThe key of the relationship type to retrieve

Response Headers

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

Response Body

{
  "CanCreateRelationshipsOfThisType": true,
  "CanDeleteRelationshipsOfThisType": true,
  "CanEditRelationshipsOfThisType": true,
  "DestinationToSourceLabel": "Associated",
  "SourceToDestinationLabel": "Associated",
  "OrganisationId": "e12cce32-7029-4083-99dd-51aed6fd8adb",
  "Key": "RequirementToRequirementAssociation",
  "Name": "Association (Requirement <-> Requirement)",
  "SourceEntityType": "Requirement",
  "DestinationEntityType": "Requirement",
  "AllowableDirections": [
    {
      "Id": "0",
      "Name": "None"
    },
    {
      "Id": "1",
      "Name": "Source -> Destination"
    },
    {
      "Id": "2",
      "Name": "Destination -> Source"
    },
    {
      "Id": "3",
      "Name": "Source <-> Destination"
    }
  ],
  "Self": "http://localhost/api/organisation/e12cce32-7029-4083-99dd-51aed6fd8adb/relationshiptype/RequirementToRequirementAssociation",
  "Links": [
    {
      "Href": "http://localhost/api/organisation/e12cce32-7029-4083-99dd-51aed6fd8adb",
      "Rel": "Organisation"
    },
    {
      "Href": "http://localhost/api/organisation/e12cce32-7029-4083-99dd-51aed6fd8adb/relationshiptype/RequirementToRequirementAssociation/relationships",
      "Rel": "CreateRelationship"
    }
  ]
}

Status Code

200 - OK

  • No labels