TM Forum · Schema

EntityRelationship

A uni-directionmal relationship from this entity to a target entity instance

TelcoTelecommunicationsBSSOSSOpen APIsStandards

Properties

Name	Type	Description
href	string
name	string
role	string	The association role for this entity
validFor	object
associationSpec	object
@baseType	string	When sub-classing, this defines the super-class
@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships
relationshipType	string	Type of relationship such as migration, substitution, dependency, exclusivity
id	string
@referredType	string
@type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf637-product-inventory-entity-relationship-schema.json",
  "title": "EntityRelationship",
  "description": "A uni-directionmal relationship from this entity to a target entity instance",
  "type": "object",
  "properties": {
    "href": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "description": "The association role for this entity"
    },
    "validFor": {
      "$ref": "#/components/schemas/TimePeriod"
    },
    "associationSpec": {
      "$ref": "#/components/schemas/EntityRef"
    },
    "@baseType": {
      "type": "string",
      "description": "When sub-classing, this defines the super-class"
    },
    "@schemaLocation": {
      "type": "string",
      "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
    },
    "relationshipType": {
      "type": "string",
      "description": "Type of relationship such as migration, substitution, dependency, exclusivity"
    },
    "id": {
      "type": "string"
    },
    "@referredType": {
      "type": "string"
    },
    "@type": {
      "type": "string"
    }
  }
}