Skip to content

yuregir/ObjectStrorage-Api-dotnetcore

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Org.OpenAPITools - the C# library for the Metacore IOT Object Storage API

Metacore IOT Core Services

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.2
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit http://teke.li

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
Install-Package CompareNETObjects

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.ApiKey.Add("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DashboardApiLogsApi(Configuration.Default);
            var where = where_example;  // string | the filters query parameter (ex.: {\"number\": 10}) (optional) 
            var sort = sort_example;  // string | the sort query parameter (ex.: \"city,-lastname\") (optional) 
            var page = 1;  // int? | the pages query parameter (optional) 
            var maxResults = 25;  // int? | the max results query parameter (optional) 

            try
            {
                // Retrieves one or more dashboard_api_logs
                InlineResponse200 result = apiInstance.GetdashboardApiLogs(where, sort, page, maxResults);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DashboardApiLogsApi.GetdashboardApiLogs: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
DashboardApiLogsApi GetdashboardApiLogs GET /dashboard_api_logs Retrieves one or more dashboard_api_logs
DashboardApiLogsApi GetdashboardApiLogsItem GET /dashboard_api_logs/{dashboard-api-logsId} Retrieves a dashboard-api-logs document
DashboardApiLogsApi PatchdashboardApiLogsItem PATCH /dashboard_api_logs/{dashboard-api-logsId} Updates a dashboard-api-logs document
DashboardApiLogsApi PostdashboardApiLogs POST /dashboard_api_logs Stores one or more dashboard_api_logs.
DashboardApiLogsApi PutdashboardApiLogsItem PUT /dashboard_api_logs/{dashboard-api-logsId} Replaces a dashboard-api-logs document
DeviceShadowApi GetdeviceShadow GET /device_shadow Retrieves one or more device_shadow
DeviceShadowApi GetdeviceShadowItem GET /device_shadow/{device-shadowId} Retrieves a device-shadow document
DeviceShadowApi PatchdeviceShadowItem PATCH /device_shadow/{device-shadowId} Updates a device-shadow document
DeviceShadowApi PostdeviceShadow POST /device_shadow Stores one or more device_shadow.
DeviceShadowApi PutdeviceShadowItem PUT /device_shadow/{device-shadowId} Replaces a device-shadow document
DeviceTypesApi GetdeviceTypes GET /device_types Retrieves one or more device_types
DeviceTypesApi GetdeviceTypesItem GET /device_types/{device-typesId} Retrieves a device-types document
DeviceTypesApi PatchdeviceTypesItem PATCH /device_types/{device-typesId} Updates a device-types document
DeviceTypesApi PostdeviceTypes POST /device_types Stores one or more device_types.
DeviceTypesApi PutdeviceTypesItem PUT /device_types/{device-typesId} Replaces a device-types document
DevicesApi Getdevices GET /devices Retrieves one or more devices
DevicesApi GetdevicesItem GET /devices/{devicesId} Retrieves a devices document
DevicesApi PatchdevicesItem PATCH /devices/{devicesId} Updates a devices document
DevicesApi Postdevices POST /devices Stores one or more devices.
DevicesApi PutdevicesItem PUT /devices/{devicesId} Replaces a devices document
GraphSettingsApi GetgraphSettings GET /graph_settings Retrieves one or more graph_settings
GraphSettingsApi GetgraphSettingsItem GET /graph_settings/{graph-settingsId} Retrieves a graph-settings document
GraphSettingsApi PatchgraphSettingsItem PATCH /graph_settings/{graph-settingsId} Updates a graph-settings document
GraphSettingsApi PostgraphSettings POST /graph_settings Stores one or more graph_settings.
GraphSettingsApi PutgraphSettingsItem PUT /graph_settings/{graph-settingsId} Replaces a graph-settings document
MeasurablesApi Getmeasurables GET /measurables Retrieves one or more measurables
MeasurablesApi GetmeasurablesItem GET /measurables/{measurablesId} Retrieves a measurables document
MeasurablesApi PatchmeasurablesItem PATCH /measurables/{measurablesId} Updates a measurables document
MeasurablesApi Postmeasurables POST /measurables Stores one or more measurables.
MeasurablesApi PutmeasurablesItem PUT /measurables/{measurablesId} Replaces a measurables document
OplogApi GetOplogItem GET /oplog/{oplogId} Retrieves a Oplog document
OplogApi Getoplog GET /oplog Retrieves one or more oplog
OrganizationDetailsApi GetorgDetails GET /org_details Retrieves one or more org_details
OrganizationDetailsApi GetorganizationDetailsItem GET /org_details/{organization-detailsId} Retrieves a organization-details document
OrganizationDetailsApi PatchorganizationDetailsItem PATCH /org_details/{organization-detailsId} Updates a organization-details document
OrganizationDetailsApi PostorgDetails POST /org_details Stores one or more org_details.
OrganizationDetailsApi PutorganizationDetailsItem PUT /org_details/{organization-detailsId} Replaces a organization-details document
OrganizationsApi GetorganizationsItem GET /orgs/{organizationsId} Retrieves a organizations document
OrganizationsApi Getorgs GET /orgs Retrieves one or more orgs
OrganizationsApi PatchorganizationsItem PATCH /orgs/{organizationsId} Updates a organizations document
OrganizationsApi Postorgs POST /orgs Stores one or more orgs.
OrganizationsApi PutorganizationsItem PUT /orgs/{organizationsId} Replaces a organizations document
RegionsApi Getregions GET /regions Retrieves one or more regions
RegionsApi GetregionsItem GET /regions/{regionsId} Retrieves a regions document
RegionsApi PatchregionsItem PATCH /regions/{regionsId} Updates a regions document
RegionsApi Postregions POST /regions Stores one or more regions.
RegionsApi PutregionsItem PUT /regions/{regionsId} Replaces a regions document
RoleSettingsApi GetroleSettings GET /role_settings Retrieves one or more role_settings
RoleSettingsApi GetroleSettingsItem GET /role_settings/{role-settingsId} Retrieves a role-settings document
RoleSettingsApi PatchroleSettingsItem PATCH /role_settings/{role-settingsId} Updates a role-settings document
RoleSettingsApi PostroleSettings POST /role_settings Stores one or more role_settings.
RoleSettingsApi PutroleSettingsItem PUT /role_settings/{role-settingsId} Replaces a role-settings document
RolesApi Getroles GET /roles Retrieves one or more roles
RolesApi GetrolesItem GET /roles/{rolesId} Retrieves a roles document
RolesApi PatchrolesItem PATCH /roles/{rolesId} Updates a roles document
RolesApi Postroles POST /roles Stores one or more roles.
RolesApi PutrolesItem PUT /roles/{rolesId} Replaces a roles document
SensorsApi Getsensors GET /sensors Retrieves one or more sensors
SensorsApi GetsensorsItem GET /sensors/{sensorsId} Retrieves a sensors document
SensorsApi PatchsensorsItem PATCH /sensors/{sensorsId} Updates a sensors document
SensorsApi Postsensors POST /sensors Stores one or more sensors.
SensorsApi PutsensorsItem PUT /sensors/{sensorsId} Replaces a sensors document
ShownWidgetSettingsApi GetshownWidgetSettings GET /shown_widget_settings Retrieves one or more shown_widget_settings
ShownWidgetSettingsApi GetshownWidgetSettingsItem GET /shown_widget_settings/{shown-widget-settingsId} Retrieves a shown-widget-settings document
ShownWidgetSettingsApi PatchshownWidgetSettingsItem PATCH /shown_widget_settings/{shown-widget-settingsId} Updates a shown-widget-settings document
ShownWidgetSettingsApi PostshownWidgetSettings POST /shown_widget_settings Stores one or more shown_widget_settings.
ShownWidgetSettingsApi PutshownWidgetSettingsItem PUT /shown_widget_settings/{shown-widget-settingsId} Replaces a shown-widget-settings document
TenantsApi Gettenants GET /tenants Retrieves one or more tenants
TenantsApi GettenantsItem GET /tenants/{tenantsId} Retrieves a tenants document
TenantsApi PatchtenantsItem PATCH /tenants/{tenantsId} Updates a tenants document
TenantsApi Posttenants POST /tenants Stores one or more tenants.
TenantsApi PuttenantsItem PUT /tenants/{tenantsId} Replaces a tenants document
UsersApi Getusers GET /users Retrieves one or more users
UsersApi GetusersItem GET /users/{usersId} Retrieves a users document
UsersApi PatchusersItem PATCH /users/{usersId} Updates a users document
UsersApi Postusers POST /users Stores one or more users.
UsersApi PutusersItem 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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published