Relationship
HTTP API schema
← HTTP API referenceView source specification ↗
A typed relationship between port resources. Provider discovery and group membership operations manage relationships; the REST collection is read-only.
Relationship fields
- id
stringRequired The Port OS relationship ID.
- ownerId
stringRequired The owner of the relationship.
- associatedPluginId
string The plugin that reported the relationship.
- typeRelationshipTypeRequired
type: Reference RelationshipType
- sourceRelationshipVertexRequired
source: Reference RelationshipVertex
- targetRelationshipVertexRequired
target: Reference RelationshipVertex
- interfaces
array<RelationshipInterface> Interface applicability, when declared.
- ItemRelationshipInterface
interfaces[]: Reference RelationshipInterface