Applications - Types

Updated on 28 Nov 2024
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

The Application Events endpoint returns records of changes that have occurred related to the given application.

Application Type Object

Field	Example	Definition
application_type string	network_camera	Type identifier string
name string	'Camera Capture'	Descriptive name
description string	'Capture media from network cameras and associate with the camera subject. Deprecated. Please create Camera Capture V2 applications'	Application description
production bool	True or False	The flag ‘production‘ shows if the application type is available in production.
output_only bool	True or False	Some applications do not have input subjects; this flag shows if the application type can have input subjects.
deprecated bool	True or False	The field 'deprecated' is associated with 'production'. When 'deprecated' is set to True, 'production' must be False.
feedback bool	True or False	allows the user to check if they can provide feedback for the specified application.
default_detection_threshold float	0.0	initial value, which is set to the detection threshold which the user does not set
cogniac_model bool	True or False	This field (if it is True) shows if the user can train models.
max_output_subjects int	30	represents the maximum number of output subjects for a specified app.
app_data_types list	[]	lists all the data types that can be submitted as labels.
support_detection_threshold bool	True or False	Shows if the application supports detection threshold.
valid_consensus_types list	[]	This field shows the supported consensus types.
tenant_ids list	[]	If this is present, then the app types are available only to the listed tenants.
default_release_metrics string	None	Initial value that is not set by the users for the release metrics. this is the default metrics (evaluation metrics) the app has assigned
valid_release_metrics list	[]	all the release metrics also called 'evaluation metrics’ supported by an app.
input_focus_app_data_types list	[u'box_set', u'segment_list']	Shows what application data type can be converted to focus by the current application.
execution_targets list	[u'CloudCore']	Shows where this Model can be applied.

The application type endpoint:

GET /1/applications/all/types
Host: https://api.cogniac.io

curl -X GET https://api.cogniac.io/1/applications/all/types \
-H "Authorization: Bearer abcdefg.hijklmnop.qrstuvwxyz"
| json_pp

import requests
import json

url_prefix = 'https://api.cogniac.io'
api_version = "1"
token = ''  # add your token here
headers = {'Authorization': f'Bearer {token}'}  

url = f'{url_prefix}/{api_version}/applications/all/types'
response = requests.get(url, headers=headers)

if response.status_code == 200:
    formatted_json = json.dumps(response.json(), indent=2)
    print(formatted_json)
else:
    print(f"Error: {response.status_code}")
    print(response.content)

[{u'app_data_types': [],
  u'app_manager_dsp_module': None,
  u'application_type': u'network_camera',
  u'cogniac_model': False,
  u'custom_fields': {u'action_device_key': {u'default_value': 0,
    u'type': u'int'},
   u'action_group_key': {u'default_value': 0, u'type': u'int'},
   u'action_group_mask': {u'default_value': 0, u'type': u'int'},
   u'action_subnet': {u'default_value': u'192.168.0.255', u'type': u'unicode'},
   u'fps': {u'default_value': 1e-06,
    u'max_value': 5.000001,
    u'min_value': 1.25e-07,
    u'type': u'float'},
   u'gateway_id': {u'default_value': None, u'type': u'NoneType'},
   u'network_cameras': {u'default_value': [], u'type': u'list'},
   u'trigger_delay_seconds': {u'default_value': 0, u'type': u'int'},
   u'trigger_hold_down_seconds': {u'default_value': 0, u'type': u'int'},
   u'trigger_sequence_seconds': {u'default_value': 0, u'type': u'int'},
   u'video_segment_duration': {u'default_value': 0,
    u'max_value': 90,
    u'min_value': 0,
    u'type': u'int'}},
  u'default_detection_threshold': 0.0,
  u'default_release_metrics': None,
  u'deprecated': True,
  u'description': u'Capture media from network cameras and associate with the camera subject. Deprecated. Please create Camera Capture V2 applications',
  u'execution_targets': [u'CloudCore'],
  u'feedback': False,
  u'input_focus_app_data_types': [u'box_set', u'segment_list'],
  u'max_output_subjects': 30,
  u'name': u'Camera Capture',
  u'output_only': False,
  u'per_app_dsp': False,
  u'production': True,
  u'support_detection_threshold': False,
  u'valid_consensus_types': [],
  u'valid_release_metrics': [],
  u'video_input': False},
 {u'app_data_types': [],
  u'app_manager_dsp_module': None,
  u'application_type': u'camera_capture',
  u'cogniac_model': False,
  u'custom_fields': {},
  u'default_detection_threshold': 0.0,
  u'default_release_metrics': None,
    ...
 }
 ...
]

				
					import requests

my_headers 
					=
					{
					"Authorization"
					:
					"Bearer abcdefg.hijklmnop.qrstuvwxyz"
					}

resp 
					= requests
					.get
					(
					"https://api.cogniac.io/1/applications/all/types"
					,
                    headers
					=my_headers
					)
					print resp
					.json
					(
					)

Was this article helpful?

What's Next

Applications - Edges

Table of contents

Application Type Object
Example: Retrieve Application Events