Skip to content

Latest commit

 

History

History
276 lines (195 loc) · 11 KB

ApplicationsApi.md

File metadata and controls

276 lines (195 loc) · 11 KB
Raw

swagger_client.ApplicationsApi

All URIs are relative to http://localhost:8088/ari

Method HTTP request Description
applications_application_name_event_filter_put PUT /applications/{applicationName}/eventFilter Filter application events types.
applications_application_name_get GET /applications/{applicationName} Get details of an application.
applications_application_name_subscription_delete DELETE /applications/{applicationName}/subscription Unsubscribe an application from an event source.
applications_application_name_subscription_post POST /applications/{applicationName}/subscription Subscribe an application to a event source.
applications_get GET /applications List all applications.

applications_application_name_event_filter_put

Application applications_application_name_event_filter_put(application_name, filter=filter)

Filter application events types.

Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated:

"allowed" - Specifies an allowed list of event types
"disallowed" - Specifies a disallowed list of event types

Further, each of those key's value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value:

"type" - The type name of the event to filter

The value must be the string name (case sensitive) of the event type that needs filtering. For example:

{ "allowed": [ { "type": "StasisStart" }, { "type": "StasisEnd" } ] }

As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent.

The following rules apply:

* If the body is empty, both the allowed and disallowed filters are set empty.
* If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty).
* If only one list type is given then only that type is set. The other type is not updated.
* An empty "allowed" list means all events are allowed.
* An empty "disallowed" list means no events are disallowed.
* Disallowed events take precedence over allowed events if the event type is specified in both lists.

Example

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.ApplicationsApi(swagger_client.ApiClient(configuration))
application_name = 'application_name_example' # str | Application's name
filter = NULL # object | Specify which event types to allow/disallow (optional)

try:
    # Filter application events types.
    api_response = api_instance.applications_application_name_event_filter_put(application_name, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_application_name_event_filter_put: %s\n" % e)

Parameters

Name Type Description Notes
application_name str Application's name
filter object Specify which event types to allow/disallow [optional]

Return type

Application

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

applications_application_name_get

Application applications_application_name_get(application_name)

Get details of an application.

Example

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.ApplicationsApi(swagger_client.ApiClient(configuration))
application_name = 'application_name_example' # str | Application's name

try:
    # Get details of an application.
    api_response = api_instance.applications_application_name_get(application_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_application_name_get: %s\n" % e)

Parameters

Name Type Description Notes
application_name str Application's name

Return type

Application

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

applications_application_name_subscription_delete

Application applications_application_name_subscription_delete(application_name, event_source)

Unsubscribe an application from an event source.

Returns the state of the application after the subscriptions have changed

Example

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.ApplicationsApi(swagger_client.ApiClient(configuration))
application_name = 'application_name_example' # str | Application's name
event_source = ['event_source_example'] # list[str] | URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}

try:
    # Unsubscribe an application from an event source.
    api_response = api_instance.applications_application_name_subscription_delete(application_name, event_source)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_application_name_subscription_delete: %s\n" % e)

Parameters

Name Type Description Notes
application_name str Application's name
event_source list[str] URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}

Return type

Application

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

applications_application_name_subscription_post

Application applications_application_name_subscription_post(application_name, event_source)

Subscribe an application to a event source.

Returns the state of the application after the subscriptions have changed

Example

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.ApplicationsApi(swagger_client.ApiClient(configuration))
application_name = 'application_name_example' # str | Application's name
event_source = ['event_source_example'] # list[str] | URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}

try:
    # Subscribe an application to a event source.
    api_response = api_instance.applications_application_name_subscription_post(application_name, event_source)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_application_name_subscription_post: %s\n" % e)

Parameters

Name Type Description Notes
application_name str Application's name
event_source list[str] URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}

Return type

Application

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

applications_get

list[Application] applications_get()

List all applications.

Example

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.ApplicationsApi(swagger_client.ApiClient(configuration))

try:
    # List all applications.
    api_response = api_instance.applications_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Application]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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