DiscoveryDataDescriptionStructure

PropertyValueSpecification inherited from CDIFCore

DiscoveryDataDescriptionStructure::Classes::PropertyValueSpecification

Definition

Documentation

Original
Reference

schema:PropertyValueSpecification

Definition

A Property value specification.

Scope

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

CDIF
Definition

schema:PropertyValueSpecification - an explanation of a parameter used in the target URL template of an Action.

Diagram

Inheritance

No generalization relationships.

Attributes

NameTypeMultiplicityDescription
identifierIdentifier[0..1]

Documentation

Original
Reference

schema:identifier

Definition

The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

Scope

Domain: Thing (https://schema.org/Thing). Range: PropertyValue (https://schema.org/PropertyValue), Text (https://schema.org/Text), URL (https://schema.org/URL).

CDIF
Definition

The primary identifier for the dataset; other identifiers should be listed in the sameAs field. Schema.org has three ways of encoding identifiers-- a text description, a URL, or by using the schema:PropertyValue field. The Science on Schema.org guidance strongly recommends using the PropertyValue approach. see https://github.com/ESIPFed/science-on-schema.org .... Dataset.md#identifier. Ideally, for any given data provided they would provide identifiers either all as strings or all as identifier_type.

Scope

@id - identifier for this parameter specification.

valueNamestring[1]

Documentation

Original
Reference

schema:valueName

Definition

Indicates the name of the PropertyValueSpecification to be used in URL templates and form encoding in a manner analogous to HTML's input@name.

Scope

Domain: PropertyValueSpecification (https://schema.org/PropertyValueSpecification). Range: Text (https://schema.org/Text).

CDIF
Definition

schema:valueName - the parameter name as used in the urlTemplate.

descriptionstring[1]

Documentation

Original
Reference

schema:description

Definition

A description of the item.

Scope

Domain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject).

CDIF
Definition

A short summary describing a dataset. This text will be indexed by search applications, so the more information here, the better.

Scope

schema:description - description of the parameter.

valueRequiredboolean[0..1]

Documentation

Original
Reference

schema:valueRequired

Definition

Whether the property must be filled in to complete the action. Default is false.

Scope

Domain: PropertyValueSpecification (https://schema.org/PropertyValueSpecification). Range: Boolean (https://schema.org/Boolean).

CDIF
Definition

schema:valueRequired - whether the parameter is required.

valuePatternstring[0..1]

Documentation

Original
Reference

schema:valuePattern

Definition

Specifies a regular expression for testing literal values according to the HTML spec.

Scope

Domain: PropertyValueSpecification (https://schema.org/PropertyValueSpecification). Range: Text (https://schema.org/Text).

CDIF
Definition

schema:valuePattern - a regular expression constraining the parameter value.

Associations

RoleTargetMultiplicityKind
queryInputAction[0..*]association