Share this page

# Relations

A relation represents direct links between entities.

In this topic:

## Overview

A relation is defined using a reference field for each of the linked entities, in the format <relation_alias>.

You can filter entities based on their relations to other entities.

You can perform basic CRUD operations on the reference fields to update relations between the entities.

Back to top

## Example

The following demonstrates a GET request for the relations between a defect and the release in which it is detected, and then the corresponding response.

                    GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/1001?fields=detected_in_release

    {

         "type": "defect",

         "id": "1026"

         "detected_in_release":

               {

                  "id": "1001",

                  type: "release"

               }

    }

Note the following:

- type and id are native fields that are returned by default in all responses.

- detected in release returns the release for the defect we are querying.

Back to top

See also:

- Entry points
- Instances (Entities)
- Collections

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 23.4-24.3 All View Local Help Center View Online Help Center Version: