Schema

Product

Type: Blank Node


A Product created during the Cycle.


Field Type Required Definition
term Term Yes

A reference to the Term describing the Product.

description string No

A short description of the Product.

variety string No

The variety (cultivar) of a crop or breed of animal. Standardised variety names are defined in external glossaries, such as the OECD, GEVES, PLUTO, or CPVO glossaries.

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). The units are always specified in the Term. For crops, value should always be per harvest or per year, following FAOSTAT conventions.

sd array[number|null] No

The standard deviation of value.

min array[number|null] No

The minimum of value.

max array[number|null] No

The maximum of value.

statsDefinition string No

What the descriptive statistics (sd, min, max, and value) are calculated across, or whether they are simulated or the output of a model. Spatial is descriptive statistics calculated across spatial units (e.g., pixels) within a region or country.

Possible values are: sites,cycles,replications,otherObservations,spatial,regions,simulated,modelled

observations array[number|null] No

The number of observations the descriptive statistics are calculated over, if different from the numberOfCycles specified in Cycle.

dates array[string] No

A corresponding array to value, representing the dates of the Products in ISO 8601 format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, or --MM).

startDate string No

For Products created over periods, the start date of the Product (if different from the start date of the Cycle) in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).

endDate string No

For Products created over periods, the end date of the Product (if different from the start date of the Cycle) in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).

price number No

The sale price of this Product. The price should be expressed per the units defined in the term, for example per "kg liveweight". The currency must be specified.

revenue number No

The total revenue (price x quantity) of this Product. The currency must be specified.

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 economicValueShare > 50.

properties List[Property] No

A list of Properties of the Product, which would override any default properties specified in term. For crops, dry matter is a default property of the Term and can be changed by adding dry matter here.

reliability integer No

An assessment of the reliability of these data following the pedigree matrix approach detailed by Edelen & Ingwersen (2019). (1) Verified (e.g. by on site checks, recalculation, or mass balance estimation) data based on measurements; (2) Verified data based on a calculation or non-verified data based on measurements; (3) Non-verified data based on a calculation; (4) Documented estimate; (5) Undocumented estimate. In different language, (1-2) can be considered primary data and (3-5) secondary.

methodModel Term No

A reference to the Term describing the method or model for acquiring or estimating these data.

methodModelDescription string No

A free text field, describing the method or model used for acquiring or estimating these data.

source Source No

A reference to the Source of these data, if different from the defaultSource of the Cycle.


Internal Properties

Field Type Definition
@type string Product
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.


JSON-LD Example 1