Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

Latest commit

 

History

History
108 lines (72 loc) · 3.41 KB

File metadata and controls

108 lines (72 loc) · 3.41 KB

esp_sdk.ServicesApi

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

Method HTTP request Description
list PUT /api/v2/services.json_api Get a list of Services
show GET /api/v2/services/{id}.json_api Show a single Service

list

PaginatedCollection list(filter=filter, page=page)

Get a list of Services

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.ServicesApi()
filter = {'key': 'filter_example'} # dict(str, str) | Filter Params for Searching.  Equality Searchable Attributes: [id, name, policy_name] Matching Searchable Attributes: [name, policy_name] Limited Searchable Attribute: [provider_eq]   (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 Services
    api_response = api_instance.list(filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->list: %s\n" % e)

Parameters

Name Type Description Notes
filter dict(str, str) Filter Params for Searching. Equality Searchable Attributes: [id, name, policy_name] Matching Searchable Attributes: [name, policy_name] Limited Searchable Attribute: [provider_eq] [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

Service show(id)

Show a single Service

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.ServicesApi()
id = 56 # int | Service ID

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

Parameters

Name Type Description Notes
id int Service ID

Return type

Service

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]