IAMC Data REST API
Submodules
ixmp4.server.rest.iamc.datapoint module
ixmp4.server.rest.iamc.region module
- ixmp4.server.rest.iamc.region.query(filter: ~ixmp4.data.db.region.filter.IamcRegionFilter = Body(id=None name=None hierarchy=None id__in=None name__in=None name__like=None name__ilike=None name__notlike=None name__notilike=None hierarchy__in=None hierarchy__like=None hierarchy__ilike=None hierarchy__notlike=None hierarchy__notilike=None variable=None unit=None run=sqla_model(id=None, version=None, default_only=True, is_default=True, model=None, scenario=None, id__in=None, version__in=None, version__gt=None, version__lt=None, version__gte=None, version__lte=None)), table: bool | None = Query(False), pagination: ~ixmp4.server.rest.base.Pagination = Depends(NoneType), backend: ~ixmp4.data.backend.db.SqlAlchemyBackend = Depends(get_managed_backend))
ixmp4.server.rest.iamc.timeseries module
- class ixmp4.server.rest.iamc.timeseries.TimeSeriesInput(*, run__id: int, parameters: dict[str, Any])
Bases:
BaseModel- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'parameters': FieldInfo(annotation=dict[str, Any], required=True), 'run__id': FieldInfo(annotation=int, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- ixmp4.server.rest.iamc.timeseries.bulk_upsert(df: DataFrame, create_related: bool | None = Query(False), backend: SqlAlchemyBackend = Depends(get_managed_backend))
- ixmp4.server.rest.iamc.timeseries.create(timeseries: TimeSeriesInput, backend: SqlAlchemyBackend = Depends(get_managed_backend))
- ixmp4.server.rest.iamc.timeseries.get_by_id(id: int, backend: SqlAlchemyBackend = Depends(get_managed_backend))