ActionResult
CDIFCore::Classes::ActionResult
Definition
Documentation
Original
Reference
schema:Thing
Definition
The most generic type of item.
CDIF
Definition
Action result - the expected representation of an Action response (schema:DataDownload): encoding format and conformance, but no contentUrl/contentSize (generated per request). From the actionResult building block.
Diagram
Inheritance
No generalization relationships.
Attributes
| Name | Type | Multiplicity | Description |
|---|---|---|---|
| name | string | [0..1] | DocumentationOriginalReferenceschema:name DefinitionThe name of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text). CDIFDefinitionA descriptive name of a dataset (e.g., 'Snow depth in Northern Hemisphere'). The name should uniquely identify the described resource for human use, in the scope of the metadata catalog containing this metadata record. Scopeschema:name - label for the result/response format. |
| description | string | [0..1] | DocumentationOriginalReferenceschema:description DefinitionA description of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject). CDIFDefinitionA short summary describing a dataset. This text will be indexed by search applications, so the more information here, the better. Scopeschema:description - description of the result representation. |
| encodingFormat | string | [0..*] | DocumentationOriginalReferenceschema:encodingFormat DefinitionMedia type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc. In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. ScopeDomain: CreativeWork (https://schema.org/CreativeWork), MediaObject (https://schema.org/MediaObject). Range: Text (https://schema.org/Text), URL (https://schema.org/URL). CDIFDefinitionMIME type with extension; should indicate the serialization scheme in sufficient detail that machine can know how to parse. Scopeschema:encodingFormat - MIME type(s) of the response serialization. |
| conformsTo | XsdAnyUri | [0..*] | DocumentationOriginalReferencedcterms:conformsTo DefinitionAn established standard to which the described resource conforms. CDIFDefinitionAn identifier for a standard or specification that the distribution conforms to. Recommended to enable machine-actionable data access. Scopedcterms:conformsTo - identifier(s) of a standard/specification the response conforms to. |
Associations
| Role | Target | Multiplicity | Kind |
|---|---|---|---|
| result | ← Action | [0..1] | association |