TM Forum · Schema

ProductSpecificationCharacteristicValueUse

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tm-forum-productspecificationcharacteristicvalueuse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProductSpecificationCharacteristicValueUse",
  "title": "ProductSpecificationCharacteristicValueUse",
  "allOf": [
    {
      "$ref": "#/components/schemas/Extensible"
    },
    {
      "type": "object",
      "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the associated productSpecificationCharacteristic"
        },
        "id": {
          "type": "string",
          "description": "Unique ID for the characteristic"
        },
        "description": {
          "type": "string",
          "description": "A narrative that explains in detail what the productSpecificationCharacteristic is"
        },
        "valueType": {
          "type": "string",
          "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth"
        },
        "minCardinality": {
          "type": "integer",
          "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
        },
        "maxCardinality": {
          "type": "integer",
          "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
        },
        "validFor": {
          "$ref": "#/components/schemas/TimePeriod"
        },
        "productSpecCharacteristicValue": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CharacteristicValueSpecification"
          },
          "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic."
        },
        "productSpecification": {
          "$ref": "#/components/schemas/ProductSpecificationRef"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "ProductSpecificationCharacteristicValueUse": "#/components/schemas/ProductSpecificationCharacteristicValueUse"
    }
  }
}