TM Forum · JSON Structure

Tmf637 Product Inventory Entity Relationship Structure

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

Type: object Properties: 11
TelcoTelecommunicationsBSSOSSOpen APIsStandards

EntityRelationship is a JSON Structure definition published by TM Forum, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

href name role validFor associationSpec @baseType @schemaLocation relationshipType id @referredType @type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-structure/tmf637-product-inventory-entity-relationship-structure.json",
  "name": "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"
    }
  }
}