CharacteristicSpecification
CharacteristicSpecification
Data type: Extensible
| Name | Type | Description | Example |
|---|---|---|---|
| @type (1) | string | When sub-classing, this defines the sub-class Extensible name | |
| @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 | |
| id | string | Unique ID for the characteristic | 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5 |
| name | string | A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications. | characteristic specification name |
| valueType | string | A kind of value that the characteristic can take on, such as numeric, text and so forth | Lorem ipsum dolor |
| description | string | A narrative that explains the CharacteristicSpecification. | Lorem ipsum dolor |
| configurable | boolean | If true, the Boolean indicates that the target Characteristic is configurable | true |
| validFor | TimePeriod | ||
| minCardinality | integer | 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. | 2 |
| maxCardinality | integer | 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. | 5 |
| isUnique | boolean | Specifies if the value of this characteristic is unique across all entities instantiated from the specification that uses this characteristc. For example, consider a ProductSpecification for a set-top box, with a CharacteristicSpecification cardID. Each set-top box must have a different value for cardID, so this isUnique attribute would be set to true for the characteristic. | false |
| regex | string | A rule or principle represented in regular expression used to derive the value of a characteristic value. | |
| extensible | boolean | An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource. | false |
| @valueSchemaLocation | string | This (optional) field provides a link to the schema describing the value type. | https://schemas.example.com/example/schema |
| characteristicValueSpecification | CharacteristicValueSpecification [n..m] | A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on. |