AdditionalProperty inherited from CDIFCore

CDIFProvenance::Classes::AdditionalProperty

Definition

Documentation

Original

Reference

schema:PropertyValue

Definition

A property-value pair, e.g. representing a feature of a product or place. Use the 'name' property for the name of the property. If there is an additional human-readable version of the value, put that into the 'description' property.\n\n Always use specific schema.org properties when a) they exist and b) you can populate them. Using PropertyValue as a substitute will typically not trigger the same effect as using the original, specific property.

Scope

Parent class(es): StructuredValue (https://schema.org/StructuredValue).

CDIF

Definition

PropertyValue values required to define a soft-typed property with a value.

Scope

schema:PropertyValue in the AdditionalProperty role - a key/value extension property carrying a propertyID (property name) and a value, optionally with a unit. Used wherever schema:additionalProperty appears. See CDIFDiscoveryImplementationGuide.md (Polymorphism of PropertyValue) for the distinction from Identifier.

JSON serialization: In a JSON instance, a property typed as AdditionalProperty may also be supplied as an object reference ({"@id": ...}); a plain string is not sufficient because both the property name and its value are required.

Diagram

Inheritance

No generalization relationships.

Attributes

Name	Type	Multiplicity	Description
propertyID	string	[1]	Documentation Original Reference schema:propertyID Definition A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be (1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific ID of the property), or (3) a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry). Standards bodies should promote a standard prefix for the identifiers of properties from their standards. Scope Domain: PropertyValue (https://schema.org/PropertyValue). Range: Text (https://schema.org/Text), URL (https://schema.org/URL). CDIF Definition identifier or name for the property concept quantified by the values in this variable slot. Multiple values can specify the property at different levels of granularity. Scope schema:propertyID - identifier of the property being asserted (e.g. 'horsepower', 'serialNumber'). Either a literal string or a URI from a known vocabulary.
name	string	[0..1]	Documentation Original Reference schema:name Definition The name of the item. Scope Domain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text). CDIF Definition Human-readable name for the activity Scope schema:name - human-readable label for the property (often equal to propertyID).
value	string	[1]	Documentation Original Reference schema:value Definition The value of a [[QuantitativeValue]] (including [[Observation]]) or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Scope Domain: MonetaryAmount (https://schema.org/MonetaryAmount), PropertyValue (https://schema.org/PropertyValue), QuantitativeValue (https://schema.org/QuantitativeValue). Range: Boolean (https://schema.org/Boolean), Number (https://schema.org/Number), StructuredValue (https://schema.org/StructuredValue), Text (https://schema.org/Text). CDIF Definition the identifier string. E.g. 10.5066/F7VX0DMQ Scope schema:value - the property value (literal).
unitText	string	[0..1]	Documentation Original Reference schema:unitText Definition A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for <a href='unitCode'>unitCode</a>. Scope Domain: PropertyValue (https://schema.org/PropertyValue), QuantitativeValue (https://schema.org/QuantitativeValue), TypeAndQuantityNode (https://schema.org/TypeAndQuantityNode), UnitPriceSpecification (https://schema.org/UnitPriceSpecification). Range: Text (https://schema.org/Text). CDIF Definition schema:unitText - unit of measure for the value (textual).
unitCode	XsdAnyUri	[0..1]	Documentation Original Reference schema:unitCode Definition The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. Scope Domain: PropertyValue (https://schema.org/PropertyValue), QuantitativeValue (https://schema.org/QuantitativeValue), TypeAndQuantityNode (https://schema.org/TypeAndQuantityNode), UnitPriceSpecification (https://schema.org/UnitPriceSpecification). Range: Text (https://schema.org/Text), URL (https://schema.org/URL). CDIF Definition schema:unitCode - unit of measure for the value (URI from a known vocabulary, e.g. UCUM, QUDT).

Associations

No associations.