Org.OpenAPITools.Api.MeasurablesApi

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

Method	HTTP request	Description
Getmeasurables	GET /measurables	Retrieves one or more measurables
GetmeasurablesItem	GET /measurables/{measurablesId}	Retrieves a measurables document
PatchmeasurablesItem	PATCH /measurables/{measurablesId}	Updates a measurables document
Postmeasurables	POST /measurables	Stores one or more measurables.
PutmeasurablesItem	PUT /measurables/{measurablesId}	Replaces a measurables document

Getmeasurables

InlineResponse2005 Getmeasurables (string where = null, string sort = null, int? page = null, int? maxResults = null)

Retrieves one or more measurables

Example

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

namespace Example
{
    public class GetmeasurablesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api_key", "Bearer");

            var apiInstance = new MeasurablesApi(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 measurables
                InlineResponse2005 result = apiInstance.Getmeasurables(where, sort, page, maxResults);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MeasurablesApi.Getmeasurables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
where	string	the filters query parameter (ex.: {"number": 10})	[optional]
sort	string	the sort query parameter (ex.: "city,-lastname")	[optional]
page	int?	the pages query parameter	[optional]
maxResults	int?	the max results query parameter	[optional]

Return type

InlineResponse2005

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	An array of measurables	-
0	An error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetmeasurablesItem

Measurables GetmeasurablesItem (string measurablesId)

Retrieves a measurables document

Example

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

namespace Example
{
    public class GetmeasurablesItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api_key", "Bearer");

            var apiInstance = new MeasurablesApi(Configuration.Default);
            var measurablesId = measurablesId_example;  // string | 

            try
            {
                // Retrieves a measurables document
                Measurables result = apiInstance.GetmeasurablesItem(measurablesId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MeasurablesApi.GetmeasurablesItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
measurablesId	string

Return type

Measurables

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	measurables document fetched successfully	-
0	An error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchmeasurablesItem

void PatchmeasurablesItem (string measurablesId, string ifMatch, Measurables measurables)

Updates a measurables document

Example

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

namespace Example
{
    public class PatchmeasurablesItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api_key", "Bearer");

            var apiInstance = new MeasurablesApi(Configuration.Default);
            var measurablesId = measurablesId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var measurables = new Measurables(); // Measurables | A measurables or list of measurables documents

            try
            {
                // Updates a measurables document
                apiInstance.PatchmeasurablesItem(measurablesId, ifMatch, measurables);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MeasurablesApi.PatchmeasurablesItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
measurablesId	string
ifMatch	string	Current value of the _etag field
measurables	Measurables	A measurables or list of measurables documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	measurables document updated successfully	-
0	An error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Postmeasurables

void Postmeasurables (Measurables measurables)

Stores one or more measurables.

Example

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

namespace Example
{
    public class PostmeasurablesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api_key", "Bearer");

            var apiInstance = new MeasurablesApi(Configuration.Default);
            var measurables = new Measurables(); // Measurables | A measurables or list of measurables documents

            try
            {
                // Stores one or more measurables.
                apiInstance.Postmeasurables(measurables);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MeasurablesApi.Postmeasurables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
measurables	Measurables	A measurables or list of measurables documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	operation has been successful	-
0	An error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutmeasurablesItem

void PutmeasurablesItem (string measurablesId, string ifMatch, Measurables measurables)

Replaces a measurables document

Example

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

namespace Example
{
    public class PutmeasurablesItemExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.teke.li/api/v1/obs";
            // Configure API key authorization: ApiKeyHeaderAuth
            Configuration.Default.AddApiKey("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-Api-Key", "Bearer");
            // Configure API key authorization: ApiKeyQueryAuth
            Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api_key", "Bearer");

            var apiInstance = new MeasurablesApi(Configuration.Default);
            var measurablesId = measurablesId_example;  // string | 
            var ifMatch = ifMatch_example;  // string | Current value of the _etag field
            var measurables = new Measurables(); // Measurables | A measurables or list of measurables documents

            try
            {
                // Replaces a measurables document
                apiInstance.PutmeasurablesItem(measurablesId, ifMatch, measurables);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MeasurablesApi.PutmeasurablesItem: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
measurablesId	string
ifMatch	string	Current value of the _etag field
measurables	Measurables	A measurables or list of measurables documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	measurables document replaced successfully	-
0	An error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MeasurablesApi.md

Latest commit

History

MeasurablesApi.md

File metadata and controls

Org.OpenAPITools.Api.MeasurablesApi

Getmeasurables

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetmeasurablesItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PatchmeasurablesItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Postmeasurables

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PutmeasurablesItem

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details