A Product created during a Cycle or Transformation. Each Product must be unique, and the fields which determine uniqueness are defined in the products field of the Cycle or Transformation.
| Field | Type | Required | Definition |
|---|---|---|---|
term | Term | Yes | A reference to the Term describing the Product. This field has additional validation rules when set:
|
description | string | No | A short description of the Product. |
variety | string | No | |
value | array[number|null] | No | The quantity of the Product. If an average, it should always be the mean. Can be a single number (array of length one) or an array of numbers with associated dates (e.g., for multiple harvests in one Cycle. For crops, value should always be per harvest or per year, following FAOSTAT conventions. |
distribution | array[number]|array[array[number]] | No | |
sd | array[number|null] | No | The standard deviation of This field has additional validation rules when set:
|
min | array[number|null] | No | The minimum of This field has additional validation rules when set:
|
max | array[number|null] | No | The maximum of This field has additional validation rules when set:
|
statsDefinition | string | No | What the descriptive statistics ( Possible values are: This field has additional validation rules when set:
|
observations | array[number|null] | No | The number of observations the descriptive statistics are calculated over. |
dates | array[string] | No | |
startDate | string | No | |
endDate | string | No | |
methodClassification | string | No | A classification of the method used to acquire or estimate the
Possible values are: This field has additional validation rules when set:
|
methodClassificationDescription | string | No | A justification of the |
model | Term | No | |
modelDescription | string | No | A free text field, describing the model used to estimate these data. |
fate | string | No | The fate of the Product. Use Transformations where possible to represent the conversion of one Product into another. Possible values are: |
price | number | No | |
priceSd | number | No | The standard deviation of This field has additional validation rules when set:
|
priceMin | number | No | The minimum of This field has additional validation rules when set:
|
priceMax | number | No | The maximum of This field has additional validation rules when set:
|
priceStatsDefinition | string | No | What the descriptive statistics for Possible values are: |
revenue | number | No | |
revenueSd | number | No | The standard deviation of This field has additional validation rules when set:
|
revenueMin | number | No | The minimum of This field has additional validation rules when set:
|
revenueMax | number | No | The maximum of This field has additional validation rules when set:
|
revenueStatsDefinition | string | No | What the descriptive statistics for Possible values are: |
currency | string | No | The three letter currency code in ISO 4217 format. |
economicValueShare | number | No | The economic value (typically revenue) of this Product, divided by the total economic value of all Products, expressed as a percentage. |
primary | boolean | No | Where the are multiple products, whether this product is the primary product. Defaults to true if there is only one product or if |
source | Source | No | A reference to the Source of these data, if different from the |
otherSources | List[Source] | No | A list of references to any other sources of these data. |
properties | List[Property] | No | A list of Properties of the Product, which would override any default properties specified in the
properties
cannot be duplicated.
The following fields determine whether a
Property is unique:
|
transport | List[Transport] | No | A list of Transport stages to take this Product to the final location within the Site. For example, the Transport required to take harvested crops from the field to the barn where they are stored before being sold.
transport
cannot be duplicated.
The following fields determine whether a
Transport is unique:
|
Internal Properties
The following properties are automatically set when data are uploaded to the HESTIA platform. If they are included in a file which is uploaded, they will be overwritten.
| Field | Type | Definition |
|---|---|---|
@context | The location of the JSON-LD context file. | |
@id | The unique ID assigned to the Node by HESTIA. | |
@type | Product | |
percentile10th | number | The 10th percentile of |
percentile90th | number | The 90th percentile of |
schemaVersion | string | The version of the schema when these data were created. |
added | array[string] | A list of fields that have been added to the original dataset. |
addedVersion | array[string] | A list of versions of the model used to add these fields. |
updated | array[string] | A list of fields that have been updated on the original dataset. |
updatedVersion | array[string] | A list of versions of the model used to update these fields. |
aggregated | array[string] | A list of fields that have been 'aggregated' using data from multiple Cycles. |
aggregatedVersion | array[string] | A list of versions of the aggregation engine corresponding to each aggregated field. |
revenueRatio | number |
Example 1
{
"@type": "Product",
"term": {
"@id": "wheatGrain",
"@type": "Term",
"name": "Wheat, grain",
"units": "kg",
"termType": "crop"
},
"value": [
7282
],
"economicValueShare": 94.8,
"properties": [
{
"@type": "Property",
"term": {
"@id": "dryMatter",
"@type": "Term",
"name": "Dry matter",
"units": "%",
"termType": "property"
},
"value": 80
}
]
}