A relation represents direct links between entities.

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.


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/<shared_space_id>/workspaces/1003/defects/1001?fields=detected_in_release

     "type": "defect",
     "id": "1026"
              "id": "1001",
              type: "release"

Note the following:

See also: