metacore-obj-store-api

Metacore Object Storage - IOT Core Services

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.1
• Package version: 1
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit http://teke.li

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

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:

import metacore_api_python_cli 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import metacore_api_python_cli

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import metacore_api_python_cli
from metacore_api_python_cli.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = metacore_api_python_cli.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = metacore_api_python_cli.OplogApi(metacore_api_python_cli.ApiClient(configuration))
oplog_id = 'oplog_id_example' # str | 

try:
    # Retrieves a Oplog document
    api_response = api_instance.get_oplog_item(oplog_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OplogApi->get_oplog_item: %s\n" % e)

# Configure API key authorization: api_key
configuration = metacore_api_python_cli.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = metacore_api_python_cli.OplogApi(metacore_api_python_cli.ApiClient(configuration))
where = 'where_example' # str | the filters query parameter (ex.: {\"number\": 10}) (optional)
sort = 'sort_example' # str | the sort query parameter (ex.: \"city,-lastname\") (optional)
page = 56 # int | the pages query parameter (optional)
max_results = 56 # int | the max results query parameter (optional)

try:
    # Retrieves one or more oplog
    api_response = api_instance.getoplog(where=where, sort=sort, page=page, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OplogApi->getoplog: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.teke.li/api/v1/obs/

Class	Method	HTTP request	Description
OplogApi	get_oplog_item	GET /oplog/{oplogId}	Retrieves a Oplog document
OplogApi	getoplog	GET /oplog	Retrieves one or more oplog
DeviceTypesApi	deletedevice_types_item	DELETE /device_types/{device-typesId}	Deletes a device-types document
DeviceTypesApi	getdevice_types	GET /device_types	Retrieves one or more device_types
DeviceTypesApi	getdevice_types_item	GET /device_types/{device-typesId}	Retrieves a device-types document
DeviceTypesApi	patchdevice_types_item	PATCH /device_types/{device-typesId}	Updates a device-types document
DeviceTypesApi	postdevice_types	POST /device_types	Stores one or more device_types.
DeviceTypesApi	putdevice_types_item	PUT /device_types/{device-typesId}	Replaces a device-types document
DevicesApi	deletedevices_item	DELETE /devices/{devicesId}	Deletes a devices document
DevicesApi	getdevices	GET /devices	Retrieves one or more devices
DevicesApi	getdevices_item	GET /devices/{devicesId}	Retrieves a devices document
DevicesApi	patchdevices_item	PATCH /devices/{devicesId}	Updates a devices document
DevicesApi	postdevices	POST /devices	Stores one or more devices.
DevicesApi	putdevices_item	PUT /devices/{devicesId}	Replaces a devices document
HardwaresApi	deletehardwares_item	DELETE /hardwares/{hardwaresId}	Deletes a hardwares document
HardwaresApi	gethardwares	GET /hardwares	Retrieves one or more hardwares
HardwaresApi	gethardwares_item	GET /hardwares/{hardwaresId}	Retrieves a hardwares document
HardwaresApi	patchhardwares_item	PATCH /hardwares/{hardwaresId}	Updates a hardwares document
HardwaresApi	posthardwares	POST /hardwares	Stores one or more hardwares.
HardwaresApi	puthardwares_item	PUT /hardwares/{hardwaresId}	Replaces a hardwares document
LoraserverCoreApi	deleteloraserver_core_item	DELETE /loraserver_core/{loraserver-coreId}	Deletes a loraserver-core document
LoraserverCoreApi	getloraserver_core	GET /loraserver_core	Retrieves one or more loraserver_core
LoraserverCoreApi	getloraserver_core_item	GET /loraserver_core/{loraserver-coreId}	Retrieves a loraserver-core document
LoraserverCoreApi	patchloraserver_core_item	PATCH /loraserver_core/{loraserver-coreId}	Updates a loraserver-core document
LoraserverCoreApi	postloraserver_core	POST /loraserver_core	Stores one or more loraserver_core.
LoraserverCoreApi	putloraserver_core_item	PUT /loraserver_core/{loraserver-coreId}	Replaces a loraserver-core document
MeasurablesApi	deletemeasurables_item	DELETE /measurables/{measurablesId}	Deletes a measurables document
MeasurablesApi	getmeasurables	GET /measurables	Retrieves one or more measurables
MeasurablesApi	getmeasurables_item	GET /measurables/{measurablesId}	Retrieves a measurables document
MeasurablesApi	patchmeasurables_item	PATCH /measurables/{measurablesId}	Updates a measurables document
MeasurablesApi	postmeasurables	POST /measurables	Stores one or more measurables.
MeasurablesApi	putmeasurables_item	PUT /measurables/{measurablesId}	Replaces a measurables document
OrganizationDetailsApi	deleteorganization_details_item	DELETE /org_details/{organization-detailsId}	Deletes a organization-details document
OrganizationDetailsApi	getorg_details	GET /org_details	Retrieves one or more org_details
OrganizationDetailsApi	getorganization_details_item	GET /org_details/{organization-detailsId}	Retrieves a organization-details document
OrganizationDetailsApi	patchorganization_details_item	PATCH /org_details/{organization-detailsId}	Updates a organization-details document
OrganizationDetailsApi	postorg_details	POST /org_details	Stores one or more org_details.
OrganizationDetailsApi	putorganization_details_item	PUT /org_details/{organization-detailsId}	Replaces a organization-details document
OrganizationsApi	deleteorganizations_item	DELETE /orgs/{organizationsId}	Deletes a organizations document
OrganizationsApi	getorganizations_item	GET /orgs/{organizationsId}	Retrieves a organizations document
OrganizationsApi	getorgs	GET /orgs	Retrieves one or more orgs
OrganizationsApi	patchorganizations_item	PATCH /orgs/{organizationsId}	Updates a organizations document
OrganizationsApi	postorgs	POST /orgs	Stores one or more orgs.
OrganizationsApi	putorganizations_item	PUT /orgs/{organizationsId}	Replaces a organizations document
PreferencesApi	deletepreferences_item	DELETE /preferences/{preferencesId}	Deletes a preferences document
PreferencesApi	getpreferences	GET /preferences	Retrieves one or more preferences
PreferencesApi	getpreferences_item	GET /preferences/{preferencesId}	Retrieves a preferences document
PreferencesApi	patchpreferences_item	PATCH /preferences/{preferencesId}	Updates a preferences document
PreferencesApi	postpreferences	POST /preferences	Stores one or more preferences.
PreferencesApi	putpreferences_item	PUT /preferences/{preferencesId}	Replaces a preferences document
RegionsApi	deleteregions_item	DELETE /regions/{regionsId}	Deletes a regions document
RegionsApi	getregions	GET /regions	Retrieves one or more regions
RegionsApi	getregions_item	GET /regions/{regionsId}	Retrieves a regions document
RegionsApi	patchregions_item	PATCH /regions/{regionsId}	Updates a regions document
RegionsApi	postregions	POST /regions	Stores one or more regions.
RegionsApi	putregions_item	PUT /regions/{regionsId}	Replaces a regions document
RolesApi	deleteroles_item	DELETE /roles/{rolesId}	Deletes a roles document
RolesApi	getroles	GET /roles	Retrieves one or more roles
RolesApi	getroles_item	GET /roles/{rolesId}	Retrieves a roles document
RolesApi	patchroles_item	PATCH /roles/{rolesId}	Updates a roles document
RolesApi	postroles	POST /roles	Stores one or more roles.
RolesApi	putroles_item	PUT /roles/{rolesId}	Replaces a roles document
SensorsApi	deletesensors_item	DELETE /sensors/{sensorsId}	Deletes a sensors document
SensorsApi	getsensors	GET /sensors	Retrieves one or more sensors
SensorsApi	getsensors_item	GET /sensors/{sensorsId}	Retrieves a sensors document
SensorsApi	patchsensors_item	PATCH /sensors/{sensorsId}	Updates a sensors document
SensorsApi	postsensors	POST /sensors	Stores one or more sensors.
SensorsApi	putsensors_item	PUT /sensors/{sensorsId}	Replaces a sensors document
SignupApi	deletesignup_item	DELETE /signup/{signupId}	Deletes a signup document
SignupApi	getsignup_item	GET /signup/{signupId}	Retrieves a signup document
SignupApi	patchsignup_item	PATCH /signup/{signupId}	Updates a signup document
SignupApi	postsignup	POST /signup	Stores one signup.
SignupApi	putsignup_item	PUT /signup/{signupId}	Replaces a signup document
TenantsApi	deletetenants_item	DELETE /tenants/{tenantsId}	Deletes a tenants document
TenantsApi	gettenants	GET /tenants	Retrieves one or more tenants
TenantsApi	gettenants_item	GET /tenants/{tenantsId}	Retrieves a tenants document
TenantsApi	patchtenants_item	PATCH /tenants/{tenantsId}	Updates a tenants document
TenantsApi	posttenants	POST /tenants	Stores one or more tenants.
TenantsApi	puttenants_item	PUT /tenants/{tenantsId}	Replaces a tenants document
UsersApi	deleteusers_item	DELETE /users/{usersId}	Deletes a users document
UsersApi	getusers	GET /users	Retrieves one or more users
UsersApi	getusers_item	GET /users/{usersId}	Retrieves a users document
UsersApi	patchusers_item	PATCH /users/{usersId}	Updates a users document
UsersApi	postusers	POST /users	Stores one or more users.
UsersApi	putusers_item	PUT /users/{usersId}	Replaces a users document

Documentation For Models

• DeviceTypes
• DeviceTypesId
• Devices
• DevicesId
• DevicesInfo
• DevicesLocation
• Error
• ErrorError
• Hardwares
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20011
• InlineResponse20012
• InlineResponse20013
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• LoraserverCore
• Measurables
• Oplog
• OrganizationDetails
• Organizations
• OrganizationsId
• Preferences
• PreferencesDashboards
• PreferencesSensors
• PreferencesWidgets
• Regions
• RegionsId
• RegionsLocation
• Roles
• Sensors
• Signup
• Tenants
• TenantsId
• Users
• UsersId

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

Author