142 lines
4.2 KiB
Plaintext
142 lines
4.2 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: timeseries
|
|
Version: 3.3.2
|
|
Summary: IoT Time Series API
|
|
Home-page: UNKNOWN
|
|
Author: UNKNOWN
|
|
Author-email: UNKNOWN
|
|
License: UNKNOWN
|
|
Keywords: Mindsphere-Python-sdk,IoT Time Series API
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 2 - Pre-Alpha
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Natural Language :: English
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Requires-Dist: urllib3 (>=1.15)
|
|
Requires-Dist: six (>=1.10)
|
|
Requires-Dist: certifi
|
|
Requires-Dist: python-dateutil
|
|
|
|
# timeseries
|
|
Store and query time series data with a precision of 1 millisecond.
|
|
|
|
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
|
|
- API version: 3.3.0
|
|
- Package version: 3.3.2
|
|
- Build package: com.siemens.mindsphere.sdk.PythonClientCodegen
|
|
|
|
## Requirements.
|
|
|
|
Python 2.7 and 3.4+
|
|
|
|
## Installation & Usage
|
|
### pip install
|
|
|
|
If the python package is hosted on Github, you can install directly from Github
|
|
|
|
```sh
|
|
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
```
|
|
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
|
|
Then import the package:
|
|
```python
|
|
import timeseries
|
|
```
|
|
|
|
### Setuptools
|
|
|
|
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
|
|
```sh
|
|
python setup.py install --user
|
|
```
|
|
(or `sudo python setup.py install` to install the package for all users)
|
|
|
|
Then import the package:
|
|
```python
|
|
import timeseries
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import timeseries
|
|
from timeseries.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure OAuth2 access token for authorization: timeseries
|
|
configuration = timeseries.Configuration()
|
|
configuration.access_token = 'YOUR_ACCESS_TOKEN'
|
|
|
|
# create an instance of the API class
|
|
api_instance = timeseries.TimeSeriesClient(timeseries.ApiClient(configuration))
|
|
entity = 'entity_example' # str | unique identifier of the entity
|
|
propertysetname = 'propertysetname_example' # str | name of the propertyset
|
|
_from = '2013-10-20T19:20:30+01:00' # datetime | beginning of the timerange to delete (exclusive)
|
|
to = '2013-10-20T19:20:30+01:00' # datetime | end of the timerange to delete (inclusive)
|
|
|
|
try:
|
|
# delete time series
|
|
api_instance.delete_timeseries(entity, propertysetname, _from, to)
|
|
except ApiException as e:
|
|
print("Exception when calling TimeSeriesClient->delete_timeseries: %s\n" % e)
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://localhost/api/iottimeseries/v3*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*TimeSeriesClient* | [**delete_timeseries**](docs/TimeSeriesClient.md#delete_timeseries) | **DELETE** /timeseries/{entity}/{propertysetname} | delete time series
|
|
*TimeSeriesClient* | [**get_timeseries**](docs/TimeSeriesClient.md#get_timeseries) | **GET** /timeseries/{entity}/{propertysetname} | read time series
|
|
*TimeSeriesClient* | [**put_timeseries**](docs/TimeSeriesClient.md#put_timeseries) | **PUT** /timeseries/{entity}/{propertysetname} | write or update time series
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [Badrequest](docs/Badrequest.md)
|
|
- [DeleteTimeseriesRequest](docs/DeleteTimeseriesRequest.md)
|
|
- [Error](docs/Error.md)
|
|
- [GetTimeseriesRequest](docs/GetTimeseriesRequest.md)
|
|
- [Notfound](docs/Notfound.md)
|
|
- [PutTimeseriesRequest](docs/PutTimeseriesRequest.md)
|
|
- [Timeseries](docs/Timeseries.md)
|
|
- [Toomanyrequests](docs/Toomanyrequests.md)
|
|
- [Unauthorized](docs/Unauthorized.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
## timeseries
|
|
|
|
- **Type**: OAuth
|
|
- **Flow**: accessCode
|
|
- **Authorization URL**: https://oauth.simple.api/authorization
|
|
- **Scopes**:
|
|
- **iot.tim.r**: read timeseries
|
|
- **iot.tim.w**: write timeseries
|
|
- **iot.tim.d**: delete timeseries
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|
|
Store and query time series data with a precision of 1 millisecond.
|
|
|
|
|