Skip to content
/ ObjectStrorage-Api Public

Metacore IOT Object Storage REST API Python Client

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

metacore-io/ObjectStrorage-Api

BranchesTags

Repository files navigation

metacore-obs-api

Metacore IOT Core Services

  • API version: 0.2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.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

pip install git+https://github.com/yuregir/ObjectStrorage-Api.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/yuregir/ObjectStrorage-Api.git)

Then import the package:

import metacore_obs_api

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_obs_api

Getting Started

Please follow the installation procedure and then run the following:

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

configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
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'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.OplogApi(metacore_obs_api.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)

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
DashboardApiLogsApi getdashboard_api_logs GET /dashboard_api_logs Retrieves one or more dashboard_api_logs
DashboardApiLogsApi getdashboard_api_logs_item GET /dashboard_api_logs/{dashboard-api-logsId} Retrieves a dashboard-api-logs document
DashboardApiLogsApi patchdashboard_api_logs_item PATCH /dashboard_api_logs/{dashboard-api-logsId} Updates a dashboard-api-logs document
DashboardApiLogsApi postdashboard_api_logs POST /dashboard_api_logs Stores one or more dashboard_api_logs.
DashboardApiLogsApi putdashboard_api_logs_item PUT /dashboard_api_logs/{dashboard-api-logsId} Replaces a dashboard-api-logs document
DeviceShadowApi getdevice_shadow GET /device_shadow Retrieves one or more device_shadow
DeviceShadowApi getdevice_shadow_item GET /device_shadow/{device-shadowId} Retrieves a device-shadow document
DeviceShadowApi patchdevice_shadow_item PATCH /device_shadow/{device-shadowId} Updates a device-shadow document
DeviceShadowApi postdevice_shadow POST /device_shadow Stores one or more device_shadow.
DeviceShadowApi putdevice_shadow_item PUT /device_shadow/{device-shadowId} Replaces a device-shadow 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 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
GraphSettingsApi getgraph_settings GET /graph_settings Retrieves one or more graph_settings
GraphSettingsApi getgraph_settings_item GET /graph_settings/{graph-settingsId} Retrieves a graph-settings document
GraphSettingsApi patchgraph_settings_item PATCH /graph_settings/{graph-settingsId} Updates a graph-settings document
GraphSettingsApi postgraph_settings POST /graph_settings Stores one or more graph_settings.
GraphSettingsApi putgraph_settings_item PUT /graph_settings/{graph-settingsId} Replaces a graph-settings 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 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 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
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
RoleSettingsApi getrole_settings GET /role_settings Retrieves one or more role_settings
RoleSettingsApi getrole_settings_item GET /role_settings/{role-settingsId} Retrieves a role-settings document
RoleSettingsApi patchrole_settings_item PATCH /role_settings/{role-settingsId} Updates a role-settings document
RoleSettingsApi postrole_settings POST /role_settings Stores one or more role_settings.
RoleSettingsApi putrole_settings_item PUT /role_settings/{role-settingsId} Replaces a role-settings 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 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
ShownWidgetSettingsApi getshown_widget_settings GET /shown_widget_settings Retrieves one or more shown_widget_settings
ShownWidgetSettingsApi getshown_widget_settings_item GET /shown_widget_settings/{shown-widget-settingsId} Retrieves a shown-widget-settings document
ShownWidgetSettingsApi patchshown_widget_settings_item PATCH /shown_widget_settings/{shown-widget-settingsId} Updates a shown-widget-settings document
ShownWidgetSettingsApi postshown_widget_settings POST /shown_widget_settings Stores one or more shown_widget_settings.
ShownWidgetSettingsApi putshown_widget_settings_item PUT /shown_widget_settings/{shown-widget-settingsId} Replaces a shown-widget-settings 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 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

Documentation For Authorization

ApiKeyHeaderAuth

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

ApiKeyQueryAuth

  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

Author

Yuregir TEKELI

About

Metacore IOT Object Storage REST API Python Client

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages