RootEntity
A RootEntity is a stand-alone data set (like a Flow or Process).
Properties
@type
Inherited from Entity.@type
- Type:
string(external doc) - Proto-Index: 1
@id
Inherited from RefEntity.@id
- Type:
string(external doc) - Proto-Index: 2
name
Inherited from RefEntity.name
- Type:
string(external doc) - Proto-Index: 3
description
Inherited from RefEntity.description
- Type:
string(external doc) - Proto-Index: 4
category
A full path of the category. Forward slashes are used to separate the segments of this path, e.g. Elementary flows/emissions/air/unspecified.
- Type:
string(external doc) - Proto-Index: 5
lastChange
The timestamp when the entity was changed the last time.
- Type:
dateTime(external doc) - Proto-Index: 6
tags
A list of optional tags. A tag is just a string which should not contain commas (and other special characters).
- Type:
Listofstring(external doc) - Proto-Index: 7
version
A version number in MAJOR.MINOR.PATCH format where the MINOR and PATCH fields are optional and the fields may have leading zeros (so 01.00.00 is the same as 1.0.0 or 1).
- Type:
string(external doc) - Proto-Index: 8
library
An identifier of a data library. This field should be only used in service APIs (like IPC, REST, gRPC, etc.) and of course only, if the respective dataset is part of a library. For datasets in data packages, the location of the package defines if the datasets are part of a library. It has then practical reasons to not tag all datasets with the library, e.g. renaming a library would require to change all datasets otherwise.
- Type:
string(external doc) - Proto-Index: 9
Python class stub
The snippet below shows the names of the properties of the corresponding Python class of the olca-schema package. Note that this is not the full class definition but just shows the names of the class and its properties.
@dataclass
class RootEntity:
id: str
category: str
description: str
last_change: str
library: str
name: str
tags: List[str]
version: str