TM Forum · JSON Structure

Tmf620 Product Catalog Product Specification Relationship Structure

ProductSpecificationRelationship schema from TM Forum API

Type: Properties: 0
TelcoTelecommunicationsBSSOSSOpen APIsStandards

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

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/tmf620-product-catalog-product-specification-relationship-structure.json",
  "name": "ProductSpecificationRelationship",
  "description": "ProductSpecificationRelationship schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/EntityRef"
    },
    {
      "type": "object",
      "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.",
      "properties": {
        "characteristic": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CharacteristicSpecification"
          },
          "description": "A characteristic that refines the relationship. For example, consider the relationship between broadband and TV. For a 4k TV it is important to know the minimum bandwidth to support 4k, so a characteristic Resolution might be defined on the relationship to allow capturing of this in the inventory"
        },
        "validFor": {
          "$ref": "#/components/schemas/TimePeriod"
        },
        "relationshipType": {
          "type": "string",
          "description": "type of the relationship, for example override, discount, etc."
        },
        "version": {
          "type": "string",
          "description": "Version of the referred product specification."
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "ProductSpecificationRelationship": "#/components/schemas/ProductSpecificationRelationship"
    }
  }
}