Association operations

Creating an association

POST /v3/associations endpoint can be used to create an association between codeBeamer entities.

An example request body:

{
  "name": "Example Association",
  "description": "Example desc",
  "descriptionFormat": "PlainText",
  "from": {
    "id": 2864366,
    "name": "Item 1",
    "type": "TrackerItemReference"
  },
  "to": {
    "id": 2864386,
    "name": "Item 2",
    "type": "TrackerItemReference"
  },
  "type": {
    "id": 1,
    "name": "depends",
    "descriptionFormat": "PlainText"
  },
  "propagatingSuspects": true,
  "biDirectionalPropagation": true,
  "propagatingDependencies": true
}

This will create a depends on type association between two tracker items.

Checking out the Association API documentation you can notice that the from and to properties are AbstractReference models:

It means that not only tracker items, but any reference type can be provided or an optional url parameter can be created for general URL type associations.

Please check our Inheritance and abstract models page for more detailed information.

Getting the association types

GET /v3/associations/types can be used to acquire the available types of an association.

Example response:

[
  {
    "id": 1,
    "name": "depends",
    "descriptionFormat": "PlainText"
  },
  {
    "id": 2,
    "name": "parent",
    "descriptionFormat": "PlainText"
  },
  {
    "id": 3,
    "name": "child",
    "descriptionFormat": "PlainText"
  },
  ...
]