Module macrobond_data_api.web.web_types.in_house_series_methods
Classes
class InHouseSeriesMethods (session: Session)-
Additional operations for in-house series
Methods
def delete_series(self, entitie_name: str) ‑> None-
Delete an in-house time series. The name typically starts with 'ih:mb:'.
OAuth scope: macrobond_web_api.write_ih
Codes
200 The operation was successful.
400 The operation failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
404 The series could not be found.
def get_series_storage_locations(self) ‑> List[SeriesStorageLocationResponse]-
Get a list of locations where in-house series can be stored.
OAuth scope: macrobond_web_api.read_structure and macrobond_web_api.write_ih
Codes
200 The operation was successful.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
def get_used_inhouse_categories(self) ‑> List[str]-
Get a list of values of the IHCategory attribute that has previously been used. This can be used to suggest values to the user when creating in-house series.
OAuth scope: macrobond_web_api.read_structure and macrobond_web_api.write_ih
Codes
200 The operation was successful.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
def upload_series(self, series_request: SeriesRequest)-
Upload an in-house time series. In the metadata, PrimName, Frequency, IHCategory, Region and Description must be set. If no vector of dates is specified, the StartDate must be includeded in the metadata. For daily series, DayMask must also be included.
OAuth scope: macrobond_web_api.write_ih
Codes
200 The operation was successful.
400 The operation failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.