RegionsApi.md

esp_sdk.RegionsApi

All URIs are relative to https://api.evident.io

Method	HTTP request	Description
list	PUT /api/v2/regions.json_api	Get a list of Regions
show	GET /api/v2/regions/{id}.json_api	Show a single Region

list

PaginatedCollection list(filter=filter, page=page)

Get a list of Regions

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.RegionsApi()
filter = {'key': 'filter_example'} # dict(str, str) | Filter Params for Searching.  Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq]  Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. (optional)
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of Regions
    api_response = api_instance.list(filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	dict(str, str)	Filter Params for Searching. Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq] Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[optional]
page	str	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

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

show

Region show(id)

Show a single Region

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.RegionsApi()
id = 56 # int | Region ID

try: 
    # Show a single Region
    api_response = api_instance.show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->show: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Region ID

Return type

Region

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

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