metacore_obs_api.RegionsApi

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

Method	HTTP request	Description
getregions	GET /regions	Retrieves one or more regions
getregions_item	GET /regions/{regionsId}	Retrieves a regions document
patchregions_item	PATCH /regions/{regionsId}	Updates a regions document
postregions	POST /regions	Stores one or more regions.
putregions_item	PUT /regions/{regionsId}	Replaces a regions document

getregions

InlineResponse2009 getregions(where=where, sort=sort, page=page, max_results=max_results)

Retrieves one or more regions

Example

Api Key Authentication (ApiKeyHeaderAuth):

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.RegionsApi(metacore_obs_api.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 = 1 # int | the pages query parameter (optional)
max_results = 25 # int | the max results query parameter (optional)

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

Api Key Authentication (ApiKeyQueryAuth):

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.RegionsApi(metacore_obs_api.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 = 1 # int | the pages query parameter (optional)
max_results = 25 # int | the max results query parameter (optional)

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

Parameters

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

Return type

InlineResponse2009

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 regions	-
0	An error message	-

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

getregions_item

Regions getregions_item(regions_id)

Retrieves a regions document

Example

Api Key Authentication (ApiKeyHeaderAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 

try:
    # Retrieves a regions document
    api_response = api_instance.getregions_item(regions_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->getregions_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 

try:
    # Retrieves a regions document
    api_response = api_instance.getregions_item(regions_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->getregions_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
regions_id	str

Return type

Regions

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

patchregions_item

patchregions_item(regions_id, if_match, regions)

Updates a regions document

Example

Api Key Authentication (ApiKeyHeaderAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Updates a regions document
    api_instance.patchregions_item(regions_id, if_match, regions)
except ApiException as e:
    print("Exception when calling RegionsApi->patchregions_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Updates a regions document
    api_instance.patchregions_item(regions_id, if_match, regions)
except ApiException as e:
    print("Exception when calling RegionsApi->patchregions_item: %s\n" % e)

Parameters

Name	Type	Description
regions_id	str
if_match	str	Current value of the _etag field
regions	Regions	A regions or list of regions 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	regions document updated successfully	-
0	An error message	-

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

postregions

postregions(regions)

Stores one or more regions.

Example

Api Key Authentication (ApiKeyHeaderAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Stores one or more regions.
    api_instance.postregions(regions)
except ApiException as e:
    print("Exception when calling RegionsApi->postregions: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Stores one or more regions.
    api_instance.postregions(regions)
except ApiException as e:
    print("Exception when calling RegionsApi->postregions: %s\n" % e)

Parameters

Name	Type	Description	Notes
regions	Regions	A regions or list of regions 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]

putregions_item

putregions_item(regions_id, if_match, regions)

Replaces a regions document

Example

Api Key Authentication (ApiKeyHeaderAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Replaces a regions document
    api_instance.putregions_item(regions_id, if_match, regions)
except ApiException as e:
    print("Exception when calling RegionsApi->putregions_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

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.RegionsApi(metacore_obs_api.ApiClient(configuration))
regions_id = 'regions_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
regions = metacore_obs_api.Regions() # Regions | A regions or list of regions documents

try:
    # Replaces a regions document
    api_instance.putregions_item(regions_id, if_match, regions)
except ApiException as e:
    print("Exception when calling RegionsApi->putregions_item: %s\n" % e)

Parameters

Name	Type	Description
regions_id	str
if_match	str	Current value of the _etag field
regions	Regions	A regions or list of regions 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	regions document replaced successfully	-
0	An error message	-

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

Files

RegionsApi.md

Latest commit

History

RegionsApi.md

File metadata and controls

metacore_obs_api.RegionsApi

getregions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getregions_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchregions_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postregions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

putregions_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details