DataSource

Package: InfrastructureCoreOpenAPIModels · Source: Core/SupplementalAttributes/DataSource.json

Records data provenance for a component’s field values: which organization or dataset the data came from, the URL it was retrieved from, and when it was retrieved. Mirrors the DataSource supplemental attribute from the upstream data layer, with two deliberate divergences: organization is optional here although it is required upstream, and extra is narrowed from an any-valued map to a string-valued one. Linked to the entity it describes through Core/Associations/SupplementalAttributeAssociation.json with attribute_type: “DataSource”.

Properties

Property Type Required Unit Description
id integer yes
organization string Publishing organization, e.g. ‘U.S. Energy Information Administration’.
retrieved_at string yes When the data was obtained.
dataset string Dataset identifier within the publishing organization, e.g. ‘EIA-860 2023, Schedule 3’.
url string URL the data was retrieved from.
version string Data version or vintage, e.g. ‘2023 final’.
published_at string or null When the source published the data; null if unknown.
confidence string Confidence qualifier, e.g. ‘high’, ‘medium’.
recorded_by string or null User or agent that recorded the value.
fields array of string yes Names of the component fields this provenance record applies to.
extra object Additional string-valued provenance metadata.

This site uses Just the Docs, a documentation theme for Jekyll.