Skip to content

DefaultApi.md

Latest commit

 

History

History
494 lines (333 loc) · 14.5 KB

DefaultApi.md

File metadata and controls

494 lines (333 loc) · 14.5 KB

swagger_client.DefaultApi

All URIs are relative to https://localhost:8290/primecore

Method HTTP request Description
access_point_count_get GET /AccessPoint/Count
access_point_get GET /AccessPoint
access_point_id_get GET /AccessPoint/{id}
access_point_name_device_type_count_get GET /AccessPoint/{name}/DeviceTypeCount
access_point_name_total_usernames_get GET /AccessPoint/{name}/TotalUsernames
building_get GET /Building
network_metric_building_get GET /NetworkMetric/{building}
rogue_access_point_alarm_count_get GET /RogueAccessPointAlarm/Count
rogue_access_point_alarm_get GET /RogueAccessPointAlarm
rogue_access_point_alarm_id_get GET /RogueAccessPointAlarm/{id}

access_point_count_get

InlineResponse2001 access_point_count_get()

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    api_response = api_instance.access_point_count_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->access_point_count_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2001

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

access_point_get

InlineResponse200 access_point_get(max_result=max_result, first_result=first_result)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
max_result = 3.4 # float | max number of results returned (limited to 1000 by the backend) (optional)
first_result = 3.4 # float | first result index to be returned (optional)

try: 
    api_response = api_instance.access_point_get(max_result=max_result, first_result=first_result)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->access_point_get: %s\n" % e)

Parameters

Name Type Description Notes
max_result float max number of results returned (limited to 1000 by the backend) [optional]
first_result float first result index to be returned [optional]

Return type

InlineResponse200

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

access_point_id_get

AccessPointObject access_point_id_get(id)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
id = 'id_example' # str | id

try: 
    api_response = api_instance.access_point_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->access_point_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str id

Return type

AccessPointObject

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

access_point_name_device_type_count_get

InlineResponse2002 access_point_name_device_type_count_get(name)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | name

try: 
    api_response = api_instance.access_point_name_device_type_count_get(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->access_point_name_device_type_count_get: %s\n" % e)

Parameters

Name Type Description Notes
name str name

Return type

InlineResponse2002

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

access_point_name_total_usernames_get

InlineResponse2001 access_point_name_total_usernames_get(name)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | name

try: 
    api_response = api_instance.access_point_name_total_usernames_get(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->access_point_name_total_usernames_get: %s\n" % e)

Parameters

Name Type Description Notes
name str name

Return type

InlineResponse2001

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

building_get

InlineResponse2004 building_get()

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    api_response = api_instance.building_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->building_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2004

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

network_metric_building_get

MetricsObject network_metric_building_get(building, metric, time_interval=time_interval)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
building = 'building_example' # str | building
metric = 'metric_example' # str | metric to fetch (tx or rx)
time_interval = 3.4 # float | time interval, integer (hours) (optional)

try: 
    api_response = api_instance.network_metric_building_get(building, metric, time_interval=time_interval)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->network_metric_building_get: %s\n" % e)

Parameters

Name Type Description Notes
building str building
metric str metric to fetch (tx or rx)
time_interval float time interval, integer (hours) [optional]

Return type

MetricsObject

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

rogue_access_point_alarm_count_get

InlineResponse2001 rogue_access_point_alarm_count_get()

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    api_response = api_instance.rogue_access_point_alarm_count_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rogue_access_point_alarm_count_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2001

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

rogue_access_point_alarm_get

InlineResponse2003 rogue_access_point_alarm_get(max_result=max_result, first_result=first_result)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
max_result = 3.4 # float | max number of results returned (limited to 1000 by the backend) (optional)
first_result = 3.4 # float | first result index to be returned (optional)

try: 
    api_response = api_instance.rogue_access_point_alarm_get(max_result=max_result, first_result=first_result)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rogue_access_point_alarm_get: %s\n" % e)

Parameters

Name Type Description Notes
max_result float max number of results returned (limited to 1000 by the backend) [optional]
first_result float first result index to be returned [optional]

Return type

InlineResponse2003

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

rogue_access_point_alarm_id_get

RogueAccessPointAlarmObject rogue_access_point_alarm_id_get(id)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
id = 'id_example' # str | id

try: 
    api_response = api_instance.rogue_access_point_alarm_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rogue_access_point_alarm_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str id

Return type

RogueAccessPointAlarmObject

Authorization

default

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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