swagger-client

Engine APIs

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.2.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the anprEvent model. Example:   * To find anprEvents with engineTaskId equal 5c1956e925b6b30001103eaa, use /anprEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\"}   * To find anprEvents with engineTaskId equal 5c1956e925b6b30001103eaa and sourceId equal 5c1956e925b6b30001103eab, use /anprEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\",\"eventDetails.sourceId\":\"5c1956e925b6b30001103eab\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /anprEvents?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort anprEvents by startTimeStamp in eventDetails IN ASCEDING order, use /anprEvents?sort=eventDetails.startTimeStamp   * To sort anprEvents by startTimeStamp in eventDetails IN DECENDING order, use /anprEvents?sort=-eventDetails.startTimeStamp   * Please note the - (minus) # front of the eventDetails.startTimeStamp, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest anprEvent among whole anprEvents, use /anprEvents?maxResults=1   * To limit anprEvents to 5, use /anprEvents?maxResults=5 (optional)
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find anprEvents with eventSnap object. use /anprEvents?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get all anprEvents
    api_response = api_instance.anpr_events_get(where=where, page=page, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an event
    api_instance.anpr_events_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find anprEvents with eventSnap object. use /anprEvents/{id}?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get anprEvent by id
    api_response = api_instance.anpr_events_id_get(id, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.AnprEvent() # AnprEvent |  (optional)

try:
    # Patch
    api_response = api_instance.anpr_events_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.AnprEvent() # AnprEvent |  (optional)

try:
    # Create an anprEvent
    api_response = api_instance.anpr_events_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the attributeEvent model. Example:   * To find attributeEvents with engineTaskId equal 5c1956e925b6b30001103eaa, use /attributeEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\"}   * To find attributeEvents with engineTaskId equal 5c1956e925b6b30001103eaa and sourceId equal 5c1956e925b6b30001103eab, use /attributeEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\",\"eventDetails.sourceId\":\"5c1956e925b6b30001103eab\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /attributeEvents?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort attributeEvents by startTimeStamp in eventDetails IN ASCEDING order, use /attributeEvents?sort=eventDetails.startTimeStamp   * To sort attributeEvents by startTimeStamp in eventDetails IN DECENDING order, use /attributeEvents?sort=-eventDetails.startTimeStamp   * Please note the - (minus) # front of the eventDetails.startTimeStamp, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest attributeEvent among whole attributeEvents, use /attributeEvents?maxResults=1   * To limit attributeEvents to 5, use /attributeEvents?maxResults=5 (optional)
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find attributeEvents with eventSnap object. use /attributeEvents?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get all attributeEvents
    api_response = api_instance.attribute_events_get(where=where, page=page, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->attribute_events_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an event
    api_instance.attribute_events_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->attribute_events_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find attributeEvents with eventSnap object. use /attributeEvents/{id}?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get attributeEvent by id
    api_response = api_instance.attribute_events_id_get(id, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->attribute_events_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.AttributeEvent() # AttributeEvent |  (optional)

try:
    # Patch
    api_response = api_instance.attribute_events_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->attribute_events_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.AttributeEvent() # AttributeEvent |  (optional)

try:
    # Create an attributeEvent
    api_response = api_instance.attribute_events_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->attribute_events_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))

try:
    # Get all unprocesed clips
    api_response = api_instance.clips_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->clips_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get clip by id
    api_response = api_instance.clips_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->clips_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Clip() # Clip |  (optional)

try:
    # Create an unprocesed clip
    api_response = api_instance.clips_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->clips_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))

try:
    # Get task status response
    api_response = api_instance.engine_task_status_cumulative_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_cumulative_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the engineTaskStatus model. Example:   * To find engineTaskStatus with engineTaskId equal \"11\", use /engineTaskStatus?where={\"engineTaskId\":\"11\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find engine tasks at page no 4, use /engineTaskStatus?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort engineTasks by created IN ASCEDING order, use /engineTaskStatus?sort=created   * To sort engineTasks by created IN DECENDING order, use /engineTaskStatus?sort=-created   * Please note the - (minus) # front of the created, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest engineTask among whole engineTasks, use /engineTaskStatus?maxResults=1   * To limit engineTasks to 2, use /engineTaskStatus?maxResults=2 (optional)

try:
    # Get all engineTaskStatus
    api_response = api_instance.engine_task_status_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an engineTaskStatus
    api_instance.engine_task_status_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get engineTaskStatus by id
    api_response = api_instance.engine_task_status_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.EngineTaskStatus() # EngineTaskStatus |  (optional)

try:
    # Patch an engineTaskStatus
    api_response = api_instance.engine_task_status_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.EngineTaskStatus() # EngineTaskStatus |  (optional)

try:
    # Create an engineTaskStatus
    api_response = api_instance.engine_task_status_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_task_status_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the engineTask model. Example:   * To find engineTasks with capbilitiesType equal 211 and sourceId equal \"4\", use /engineTasks?where={\"capbilitiesType\":322,\"source.sourceId\":\"4\"}   * To find engineTasks with destination.extras.value equal \"1553774721506487\", use /engineTasks?where={\"destination.extras.value\":\"1553774721506487\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find engine tasks at page no 4, use /engines?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort engineTasks by created IN ASCEDING order, use /engineTasks?sort=created   * To sort engineTasks by created IN DECENDING order, use /engineTasks?sort=-created   * Please note the - (minus) # front of the created, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest engineTask among whole engineTasks, use /engineTasks?maxResults=1   * To limit engineTasks to 2, use /engineTasks?maxResults=2 (optional)
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with sourceEndPoint argument. Example:   * 'To find engineTasks with sourceEndPoint object. use /engineTasks?embedded={\"sourceEndPoint\":1}' (optional)

try:
    # Get all engineTasks
    api_response = api_instance.engine_tasks_get(where=where, page=page, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_tasks_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an engine task
    api_instance.engine_tasks_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_tasks_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get engine task by id
    api_response = api_instance.engine_tasks_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_tasks_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.EngineTask() # EngineTask |  (optional)

try:
    # Patch an engine task
    api_response = api_instance.engine_tasks_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_tasks_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.EngineTask() # EngineTask |  (optional)

try:
    # Create an engineTask
    api_response = api_instance.engine_tasks_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engine_tasks_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the registeredFace model. Example:   * To find enginess with capabilities 206, 211 , use /engines?where={\"capabilities\":{\"$in\":[206,211]}} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /engines?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first registeredFace among all registeredFaces, use /engines?maxResults=1   * To limit registeredFaces to 5, use /engines?maxResults=5 (optional)

try:
    # Get all engine details
    api_response = api_instance.engines_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engines_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an engine
    api_instance.engines_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->engines_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get engine by id
    api_response = api_instance.engines_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engines_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.Engine() # Engine |  (optional)

try:
    # Patch
    api_response = api_instance.engines_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engines_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Engine() # Engine |  (optional)

try:
    # Create an engine
    api_response = api_instance.engines_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->engines_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))

try:
    # Get all eventSnaps
    api_response = api_instance.event_snaps_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->event_snaps_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get eventSnap by id
    api_response = api_instance.event_snaps_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->event_snaps_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Snap() # Snap |  (optional)

try:
    # Create an eventSnap
    api_response = api_instance.event_snaps_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->event_snaps_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the registeredFace model. Example:   * To find enginess with capabilities 206, 211 , use /inferencers?where={\"capabilities\":{\"$in\":[206,211]}} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /inferencers?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first inferencer among all inferencers, use /inferencers?maxResults=1   * To limit inferencers to 5, use /inferencers?maxResults=5 (optional)

try:
    # Get all inferencers details
    api_response = api_instance.inferencers_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->inferencers_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an inferencer
    api_instance.inferencers_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->inferencers_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get inferencer by id
    api_response = api_instance.inferencers_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->inferencers_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.Inferencer() # Inferencer |  (optional)

try:
    # Patch
    api_response = api_instance.inferencers_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->inferencers_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Inferencer() # Inferencer |  (optional)

try:
    # Create an inferencer
    api_response = api_instance.inferencers_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->inferencers_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | Media sources (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /mediaSources?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first pipeline among all mediaSources, use /mediaSources?maxResults=1   * To limit mediaSources to 5, use /mediaSources?maxResults=5 (optional)

try:
    # Get all media sources
    api_response = api_instance.media_sources_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->media_sources_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete a media source
    api_instance.media_sources_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->media_sources_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get media source by id
    api_response = api_instance.media_sources_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->media_sources_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.SourceEndPoint() # SourceEndPoint |  (optional)

try:
    # Patch
    api_response = api_instance.media_sources_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->media_sources_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.SourceEndPoint() # SourceEndPoint |  (optional)

try:
    # Create a media source
    api_response = api_instance.media_sources_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->media_sources_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the registeredFace model. Example:   * To find enginess with capabilities 206, 211 , use /motionDetectors?where={\"capabilities\":{\"$in\":[206,211]}} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /motionDetectors?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first motionDetector among all motionDetectors, use /motionDetectors?maxResults=1   * To limit motionDetectors to 5, use /motionDetectors?maxResults=5 (optional)

try:
    # Get all motionDetectors details
    api_response = api_instance.motion_detectors_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->motion_detectors_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an motionDetector
    api_instance.motion_detectors_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->motion_detectors_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get motionDetector by id
    api_response = api_instance.motion_detectors_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->motion_detectors_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.MotionDetector() # MotionDetector |  (optional)

try:
    # Patch
    api_response = api_instance.motion_detectors_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->motion_detectors_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.MotionDetector() # MotionDetector |  (optional)

try:
    # Create an motionDetector
    api_response = api_instance.motion_detectors_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->motion_detectors_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the registeredFace model. Example:   * To find enginess with capabilities 206, 211 , use /pipelines?where={\"capabilities\":{\"$in\":[206,211]}} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /pipelines?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first pipeline among all pipelines, use /pipelines?maxResults=1   * To limit pipelines to 5, use /pipelines?maxResults=5 (optional)

try:
    # Get all pipelines details
    api_response = api_instance.pipelines_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pipelines_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an pipeline
    api_instance.pipelines_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->pipelines_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get pipeline by id
    api_response = api_instance.pipelines_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pipelines_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.Pipeline() # Pipeline |  (optional)

try:
    # Patch
    api_response = api_instance.pipelines_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pipelines_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Pipeline() # Pipeline |  (optional)

try:
    # Create an pipeline
    api_response = api_instance.pipelines_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pipelines_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the registeredFace model. Example:   * To find enginess with capabilities 206, 211 , use /preProcesses?where={\"capabilities\":{\"$in\":[206,211]}} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /preProcesses?page=4 (optional)
sort = 'sort_example' # str |  (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get first preProcess among all preProcesses, use /preProcesses?maxResults=1   * To limit preProcesses to 5, use /preProcesses?maxResults=5 (optional)

try:
    # Get all preProcesses details
    api_response = api_instance.pre_processes_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pre_processes_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an preProcess
    api_instance.pre_processes_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->pre_processes_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get preProcess by id
    api_response = api_instance.pre_processes_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pre_processes_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.PreProcess() # PreProcess |  (optional)

try:
    # Patch
    api_response = api_instance.pre_processes_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pre_processes_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.PreProcess() # PreProcess |  (optional)

try:
    # Create an preProcess
    api_response = api_instance.pre_processes_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->pre_processes_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the precisEngineTaskStatus model. Example:   * To find precisEngineTaskStatus with engineTaskId equal \"11\", use /precisEngineTaskStatus?where={\"engineTaskId\":\"11\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find engine tasks at page no 4, use /precisEngineTaskStatus?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort engineTasks by created IN ASCEDING order, use /precisEngineTaskStatus?sort=created   * To sort engineTasks by created IN DECENDING order, use /precisEngineTaskStatus?sort=-created   * Please note the - (minus) # front of the created, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest engineTask among whole precisEngineTask, use /precisEngineTaskStatus?maxResults=1   * To limit engineTasks to 2, use /precisEngineTaskStatus?maxResults=2 (optional)

try:
    # Get all precisEngineTaskStatus
    api_response = api_instance.precis_engine_task_status_get(where=where, page=page, sort=sort, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_task_status_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an precisEngineTaskStatus
    api_instance.precis_engine_task_status_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_task_status_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get precisEngineTaskStatus by id
    api_response = api_instance.precis_engine_task_status_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_task_status_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.PrecisEngineTaskStatus() # PrecisEngineTaskStatus |  (optional)

try:
    # Patch an precisEngineTaskStatus
    api_response = api_instance.precis_engine_task_status_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_task_status_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.PrecisEngineTaskStatus() # PrecisEngineTaskStatus |  (optional)

try:
    # Create an precisEngineTaskStatus
    api_response = api_instance.precis_engine_task_status_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_task_status_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the engineTask model. Example:   * To find precisEngineTasks with capbilitiesType equal 211 and sourceId equal \"4\", use /precisEngineTasks?where={\"capbilitiesType\":322,\"source.sourceId\":\"4\"}   * To find precisEngineTasks with destination.extras.value equal \"1553774721506487\", use /precisEngineTasks?where={\"destination.extras.value\":\"1553774721506487\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find engine tasks at page no 4, use /engines?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort engineTasks by created IN ASCEDING order, use /precisEngineTasks?sort=created   * To sort engineTasks by created IN DECENDING order, use /precisEngineTasks?sort=-created   * Please note the - (minus) # front of the created, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest engineTask among whole engineTasks, use /precisEngineTasks?maxResults=1   * To limit engineTasks to 2, use /precisEngineTasks?maxResults=2 (optional)
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with sourceEndPoint argument. Example:   * 'To find engineTasks with sourceEndPoint object. use /precisEngineTasks?embedded={\"sourceEndPoint\":1}' (optional)

try:
    # Get all precisEngineTasks
    api_response = api_instance.precis_engine_tasks_get(where=where, page=page, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_tasks_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an precis engine task
    api_instance.precis_engine_tasks_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_tasks_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get precis engine task by id
    api_response = api_instance.precis_engine_tasks_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_tasks_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.PrecisEngineTask() # PrecisEngineTask |  (optional)

try:
    # Patch an precis engine task
    api_response = api_instance.precis_engine_tasks_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_tasks_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.PrecisEngineTask() # PrecisEngineTask |  (optional)

try:
    # Create an precisEngineTasks
    api_response = api_instance.precis_engine_tasks_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->precis_engine_tasks_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))

try:
    # Get all unprocesed snaps
    api_response = api_instance.snaps_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->snaps_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID

try:
    # Get snap by id
    api_response = api_instance.snaps_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->snaps_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.Snap() # Snap |  (optional)

try:
    # Create a unprocesed snap
    api_response = api_instance.snaps_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->snaps_post: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
where = 'where_example' # str | The where clause takes a JSON as a string with one or many properties of the vaEvent model. Example:   * To find vaEvents with engineTaskId equal 5c1956e925b6b30001103eaa, use /vaEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\"}   * To find vaEvents with engineTaskId equal 5c1956e925b6b30001103eaa and sourceId equal 5c1956e925b6b30001103eab, use /vaEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\",\"eventDetails.sourceId\":\"5c1956e925b6b30001103eab\"} (optional)
page = 56 # int | The page clause takes a the page number you want to query. Example:   * To find registered faces at page no 4, use /vaEvents?page=4 (optional)
sort = 'sort_example' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort vaEvents by startTimeStamp in eventDetails IN ASCEDING order, use /vaEvents?sort=eventDetails.startTimeStamp   * To sort vaEvents by startTimeStamp in eventDetails IN DECENDING order, use /vaEvents?sort=-eventDetails.startTimeStamp   * Please note the - (minus) # front of the eventDetails.startTimeStamp, that indicates inverse of ASCENDING (optional)
max_results = 56 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest vaEvent among whole vaEvents, use /vaEvents?maxResults=1   * To limit vaEvents to 5, use /vaEvents?maxResults=5 (optional)
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find vaEvents with eventSnap object. use /vaEvents?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get all vaEvents
    api_response = api_instance.va_events_get(where=where, page=page, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->va_events_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
if_match = 'if_match_example' # str | 

try:
    # Delete an event
    api_instance.va_events_id_delete(id, if_match)
except ApiException as e:
    print("Exception when calling EnginesApi->va_events_id_delete: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | Unique ID
embedded = 'embedded_example' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find vaEvents with eventSnap object. use /vaEvents/{id}?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get vaEvent by id
    api_response = api_instance.va_events_id_get(id, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->va_events_id_get: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
if_match = 'if_match_example' # str | 
id = 'id_example' # str | Unique ID
body = swagger_client.VaEvent() # VaEvent |  (optional)

try:
    # Patch
    api_response = api_instance.va_events_id_patch(if_match, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->va_events_id_patch: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EnginesApi(swagger_client.ApiClient(configuration))
body = swagger_client.VaEvent() # VaEvent |  (optional)

try:
    # Create an vaEvent
    api_response = api_instance.va_events_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->va_events_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://v2.videonetics.com:5000

Class	Method	HTTP request	Description
EnginesApi	anpr_events_get	GET /anprEvents	Get all anprEvents
EnginesApi	anpr_events_id_delete	DELETE /anprEvents/{id}	Delete an event
EnginesApi	anpr_events_id_get	GET /anprEvents/{id}	Get anprEvent by id
EnginesApi	anpr_events_id_patch	PATCH /anprEvents/{id}	Patch
EnginesApi	anpr_events_post	POST /anprEvents	Create an anprEvent
EnginesApi	attribute_events_get	GET /attributeEvents	Get all attributeEvents
EnginesApi	attribute_events_id_delete	DELETE /attributeEvents/{id}	Delete an event
EnginesApi	attribute_events_id_get	GET /attributeEvents/{id}	Get attributeEvent by id
EnginesApi	attribute_events_id_patch	PATCH /attributeEvents/{id}	Patch
EnginesApi	attribute_events_post	POST /attributeEvents	Create an attributeEvent
EnginesApi	clips_get	GET /clips	Get all unprocesed clips
EnginesApi	clips_id_get	GET /clips/{id}	Get clip by id
EnginesApi	clips_post	POST /clips	Create an unprocesed clip
EnginesApi	engine_task_status_cumulative_get	GET /engineTaskStatusCumulative	Get task status response
EnginesApi	engine_task_status_get	GET /engineTaskStatus	Get all engineTaskStatus
EnginesApi	engine_task_status_id_delete	DELETE /engineTaskStatus/{id}	Delete an engineTaskStatus
EnginesApi	engine_task_status_id_get	GET /engineTaskStatus/{id}	Get engineTaskStatus by id
EnginesApi	engine_task_status_id_patch	PATCH /engineTaskStatus/{id}	Patch an engineTaskStatus
EnginesApi	engine_task_status_post	POST /engineTaskStatus	Create an engineTaskStatus
EnginesApi	engine_tasks_get	GET /engineTasks	Get all engineTasks
EnginesApi	engine_tasks_id_delete	DELETE /engineTasks/{id}	Delete an engine task
EnginesApi	engine_tasks_id_get	GET /engineTasks/{id}	Get engine task by id
EnginesApi	engine_tasks_id_patch	PATCH /engineTasks/{id}	Patch an engine task
EnginesApi	engine_tasks_post	POST /engineTasks	Create an engineTask
EnginesApi	engines_get	GET /engines	Get all engine details
EnginesApi	engines_id_delete	DELETE /engines/{id}	Delete an engine
EnginesApi	engines_id_get	GET /engines/{id}	Get engine by id
EnginesApi	engines_id_patch	PATCH /engines/{id}	Patch
EnginesApi	engines_post	POST /engines	Create an engine
EnginesApi	event_snaps_get	GET /eventSnaps	Get all eventSnaps
EnginesApi	event_snaps_id_get	GET /eventSnaps/{id}	Get eventSnap by id
EnginesApi	event_snaps_post	POST /eventSnaps	Create an eventSnap
EnginesApi	inferencers_get	GET /inferencers	Get all inferencers details
EnginesApi	inferencers_id_delete	DELETE /inferencers/{id}	Delete an inferencer
EnginesApi	inferencers_id_get	GET /inferencers/{id}	Get inferencer by id
EnginesApi	inferencers_id_patch	PATCH /inferencers/{id}	Patch
EnginesApi	inferencers_post	POST /inferencers	Create an inferencer
EnginesApi	media_sources_get	GET /mediaSources	Get all media sources
EnginesApi	media_sources_id_delete	DELETE /mediaSources/{id}	Delete a media source
EnginesApi	media_sources_id_get	GET /mediaSources/{id}	Get media source by id
EnginesApi	media_sources_id_patch	PATCH /mediaSources/{id}	Patch
EnginesApi	media_sources_post	POST /mediaSources	Create a media source
EnginesApi	motion_detectors_get	GET /motionDetectors	Get all motionDetectors details
EnginesApi	motion_detectors_id_delete	DELETE /motionDetectors/{id}	Delete an motionDetector
EnginesApi	motion_detectors_id_get	GET /motionDetectors/{id}	Get motionDetector by id
EnginesApi	motion_detectors_id_patch	PATCH /motionDetectors/{id}	Patch
EnginesApi	motion_detectors_post	POST /motionDetectors	Create an motionDetector
EnginesApi	pipelines_get	GET /pipelines	Get all pipelines details
EnginesApi	pipelines_id_delete	DELETE /pipelines/{id}	Delete an pipeline
EnginesApi	pipelines_id_get	GET /pipelines/{id}	Get pipeline by id
EnginesApi	pipelines_id_patch	PATCH /pipelines/{id}	Patch
EnginesApi	pipelines_post	POST /pipelines	Create an pipeline
EnginesApi	pre_processes_get	GET /preProcesses	Get all preProcesses details
EnginesApi	pre_processes_id_delete	DELETE /preProcesses/{id}	Delete an preProcess
EnginesApi	pre_processes_id_get	GET /preProcesses/{id}	Get preProcess by id
EnginesApi	pre_processes_id_patch	PATCH /preProcesses/{id}	Patch
EnginesApi	pre_processes_post	POST /preProcesses	Create an preProcess
EnginesApi	precis_engine_task_status_get	GET /precisEngineTaskStatus	Get all precisEngineTaskStatus
EnginesApi	precis_engine_task_status_id_delete	DELETE /precisEngineTaskStatus/{id}	Delete an precisEngineTaskStatus
EnginesApi	precis_engine_task_status_id_get	GET /precisEngineTaskStatus/{id}	Get precisEngineTaskStatus by id
EnginesApi	precis_engine_task_status_id_patch	PATCH /precisEngineTaskStatus/{id}	Patch an precisEngineTaskStatus
EnginesApi	precis_engine_task_status_post	POST /precisEngineTaskStatus	Create an precisEngineTaskStatus
EnginesApi	precis_engine_tasks_get	GET /precisEngineTasks	Get all precisEngineTasks
EnginesApi	precis_engine_tasks_id_delete	DELETE /precisEngineTasks/{id}	Delete an precis engine task
EnginesApi	precis_engine_tasks_id_get	GET /precisEngineTasks/{id}	Get precis engine task by id
EnginesApi	precis_engine_tasks_id_patch	PATCH /precisEngineTasks/{id}	Patch an precis engine task
EnginesApi	precis_engine_tasks_post	POST /precisEngineTasks	Create an precisEngineTasks
EnginesApi	snaps_get	GET /snaps	Get all unprocesed snaps
EnginesApi	snaps_id_get	GET /snaps/{id}	Get snap by id
EnginesApi	snaps_post	POST /snaps	Create a unprocesed snap
EnginesApi	va_events_get	GET /vaEvents	Get all vaEvents
EnginesApi	va_events_id_delete	DELETE /vaEvents/{id}	Delete an event
EnginesApi	va_events_id_get	GET /vaEvents/{id}	Get vaEvent by id
EnginesApi	va_events_id_patch	PATCH /vaEvents/{id}	Patch
EnginesApi	va_events_post	POST /vaEvents	Create an vaEvent

Documentation For Models

• AnimalProperties
• AnprEvent
• AnprEventsResponse
• AttributeEvent
• AttributeEventsResponse
• Capability
• Clip
• ClipsResponse
• Color
• Config
• DefaultResponse
• DestinationEndPoint
• DestinationEndPointDestinationList
• DestinationType
• Engine
• EngineTask
• EngineTaskLineSetting
• EngineTaskStatus
• EngineTaskStatusCumulative
• EngineTaskStatusFailure
• EngineTaskStatusProgress
• EngineTaskStatusResponse
• EngineTaskZoneSetting
• EngineTasksResponse
• EnginesResponse
• Event
• EventDetails
• EventSnapsResponse
• EventType
• EvidenceConfig
• Extra
• Href
• HumanProperties
• Inferencer
• InferencersResponse
• LicensePlateDetails
• Line
• LineType
• Links
• LinksSelf
• LinksSelfSelf
• MediaSourceResponse
• Meta
• MetaAnprEvent
• MetaAttributeEvent
• MetaVaEvent
• MotionDetector
• MotionDetectorsResponse
• ObjectDimension
• ObjectDirectProperties
• ObjectIndirectProperties
• ObjectInfo
• ObjectRect
• ObjectRectWithTimeStampAndEventSnapReference
• Pipeline
• PipelinesResponse
• PreProcess
• PreProcessesResponse
• PrecisEngineTask
• PrecisEngineTaskStatus
• PrecisEngineTaskStatusProgress
• PrecisEngineTaskStatusResponse
• PrecisEngineTasksResponse
• ScheduleSource
• Snap
• SnapsResponse
• SourceEndPoint
• SourceEndPointSourceList
• SourceType
• Title
• TrackProperties
• VaEvent
• VaEventsResponse
• VehicleProperties
• VehicleType
• Vertex
• VtplVideoFrame
• Zone
• ZoneType

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author