entities
Create relationship
Creates a relationship between two Entities.
Specify the source entity via the URL path ({id}), and the target entity and relationship type in the request body.
The type field determines the direction and nature of the relationship.
Supported values:
- parent – declare the target as the parent of the source
- child – declare the target as the child of the source
- link – create a non-hierarchical connection between entities
- isBlockedBy – create a dependency between entities
- isBlocking – create a dependency between entities
Limitations
- Only valid combinations of source and target entities are allowed for each relationship type.
- The target entity must exist and be accessible.
post/entities/{id}/relationships
Path parameters
idstring uuid required
A universally unique identifier (UUID).
Example:123e4567-e89b-12d3-a456-426614174000
Entity identifier.
Request body
Example request
{
"data": {
"target": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
}Response
Relationship created successfully
Example response
{
"data": {
"target": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
}