Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
Previous page Next page
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Next »
{
"method":"axxonsoft.bl.config.ConfigurationService.ListUnits",
"data":{
"unit_uids":["hosts/Server1/MultimediaStorage.Aqua"]
}
}
Response example (local archive):
{
"units": [
{
"uid": "hosts/Server1/MultimediaStorage.Aqua",
"display_id": "Aqua",
"type": "MultimediaStorage",
"display_name": "Archive Aqua",
"access_point": "",
"properties": [
{
"id": "display_name",
"name": "Display Name",
"type": "string",
"readonly": false,
"value_string": "Archive Aqua"
},
{
"id": "enabled",
"name": "Enabled",
"type": "bool",
"readonly": false,
"value_bool": true
}
],
"units": [
{
"uid": "hosts/Server1/MultimediaStorage.Aqua/ArchiveVolume/H:/archiveAqua.afs",
"display_id": "H:/archiveAqua.afs",
"type": "ArchiveVolume",
"display_name": "",
"access_point": "",
"properties": [
{
"id": "file_size",
"name": "Volume size(GB)",
"type": "int32",
"readonly": true,
"value_int32": 1
}
],
"units": [],
"factory": [],
"destruction_args": [
{
"id": "remove_file",
"name": "Remove volume file",
"type": "bool",
"readonly": false,
"value_bool": false
}
],
"discoverable": false,
"status": "UNIT_STATUS_ACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
},
{
"uid": "hosts/Server1/MultimediaStorage.Aqua/ArchiveContext/b73f4b6c-2962-5d51-e9ee-ceb5420b4cd2",
"display_id": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0",
"type": "ArchiveContext",
"display_name": "",
"access_point": "",
"properties": [
{
"id": "streaming_id",
"name": "Archive Streaming ID",
"type": "string",
"readonly": false,
"enum_constraint": {
"items": [
{
"name": "axis",
"properties": [],
"value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0"
},
{
"name": "axis",
"properties": [],
"value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:1"
}
]
},
"value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0"
},
{
"id": "constant_recording",
"name": "Constant recording",
"type": "bool",
"readonly": false,
"value_bool": true
},
{
"id": "prerecord_sec",
"name": "Prerecording, seconds",
"type": "int32",
"readonly": false,
"value_int32": 0
},
{
"id": "specific_fps",
"name": "Specific FPS",
"type": "double",
"readonly": false,
"value_double": 0
},
{
"id": "archive_name",
"name": "Archive display name",
"type": "string",
"readonly": true,
"value_string": "Archive Aqua"
}
],
"units": [],
"factory": [],
"destruction_args": [],
"discoverable": false,
"status": "UNIT_STATUS_ACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
}
],
"destruction_args": [],
"discoverable": false,
"status": "UNIT_STATUS_ACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
}
],
"unreachable_objects": [],
"not_found_objects": []
}
Response example (remote archive):
"units": [
{
"uid": "hosts/Server1/MultimediaStorage.Lime",
"display_id": "Lime",
"type": "MultimediaStorage",
"display_name": "mr.Lime",
"access_point": "",
"properties": [
{
"id": "display_name",
"name": "Display Name",
"type": "string",
"readonly": false,
"value_string": "mr.Lime"
},
{
"id": "enabled",
"name": "Enabled",
"type": "bool",
"readonly": false,
"value_bool": true
}
],
"units": [
{
"uid": "hosts/Server1/MultimediaStorage.Lime/ArchiveVolume/\\\\192.168.25.112\\1\\archiveLime.afs",
"display_id": "\\\\192.168.25.112\\1\\archiveLime.afs",
"type": "ArchiveVolume",
"display_name": "",
"access_point": "",
"properties": [
{
"id": "user",
"name": "Login",
"type": "string",
"readonly": false,
"value_string": "Tester"
},
{
"id": "password",
"name": "Password",
"type": "string",
"readonly": false,
"value_string": "123456"
},
{
"id": "file_size",
"name": "Volume size(GB)",
"type": "int32",
"readonly": true,
"value_int32": 2
}
],
"units": [],
"factory": [],
"destruction_args": [
{
"id": "remove_file",
"name": "Remove volume file",
"type": "bool",
"readonly": false,
"value_bool": false
}
],
"discoverable": false,
"status": "UNIT_STATUS_ACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
}
],
"factory": [],
"destruction_args": [],
"discoverable": false,
"status": "UNIT_STATUS_ACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
}
],
"unreachable_objects": [],
"not_found_objects": []
}
where units contains:
- file/section of the archive (ArchiveVolume);
- linked cameras (ArchiveContext).
Get information about the archive status:
{
"method": "axxonsoft.bl.archive.ArchiveService.GetVolumesState",
"data":{
"access_point":"hosts/Server1/MultimediaStorage.Blue/MultimediaStorage",
"volume_ids":["C:/archiveBlue.afs"]
}
}
Response example:
{
"volumes_state": {
"C:/archiveBlue.afs": {
"state": "MOUNTED",
"readonly": false,
"progress": 100
}
},
"not_found_volumes": []
}
where:
- state—the MOUNTED value indicates that the archive volumes in the system are accessible and ready for use;
- readonly—boolean value: if = true, then the archive is in read-only mode. If not, then value = false.
Get information about linked cameras:
{
"method":"axxonsoft.bl.config.ConfigurationService.ListUnits",
"data":{
"unit_uids":["hosts/Server1/MultimediaStorage.Aqua/ArchiveContext.b73f4b6c-2962-5d51-e9ee-ceb5420b4cd2"]
}
}
Response example:
{
"units": [
{
"uid": "hosts/Server1/MultimediaStorage.Aqua/ArchiveContext.b73f4b6c-2962-5d51-e9ee-ceb5420b4cd2",
"display_id": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0",
"type": "ArchiveContext",
"display_name": "",
"access_point": "",
"properties": [
{
"id": "streaming_id",
"name": "Archive Streaming ID",
"type": "string",
"readonly": false,
"enum_constraint": {},
"value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:1"
},
{
"id": "constant_recording",
"name": "Constant recording",
"type": "bool",
"readonly": false,
"value_bool": false
},
{
"id": "prerecord_sec",
"name": "Prerecording, seconds",
"type": "int32",
"readonly": false,
"value_int32": 2
},
{
"id": "specific_fps",
"name": "Specific FPS",
"type": "double",
"readonly": false,
"value_double": 0
},
{
"id": "archive_name",
"name": "Archive display name",
"type": "string",
"readonly": true,
"value_string": "Archive Aqua"
}
],
"units": [],
"factory": [],
"destruction_args": [],
"discoverable": false,
"status": "UNIT_STATUS_INACTIVE",
"stripped": false,
"opaque_params": [],
"assigned_templates": []
}
],
"unreachable_objects": [],
"not_found_objects": []
}
Get information on a specific archive:
{
"method": "axxonsoft.bl.domain.DomainService.BatchGetArchives",
"data": {
"items" : {
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage"
}
}
}
Response example:
--ngpboundary
Content-Type: application/json; charset=utf-8
Content-Length: 12110
{
"items": [
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"incomplete": false,
"display_name": "AliceBlue Archive",
"display_id": "AliceBlue",
"is_embedded": false,
"archive_access": "ARCHIVE_ACCESS_FULL",
"bindings": [
{
"name": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"camera": {
"access_point": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"incomplete": false,
"display_name": "Camera",
"display_id": "4",
"ip_address": "0.0.0.0",
"camera_access": "CAMERA_ACCESS_UNSPECIFIED",
"vendor": "Virtual",
"model": "Virtual",
"firmware": "1.0.0",
"comment": "",
"armed": false,
"geo_location_latitude": "0",
"geo_location_longitude": "0",
"geo_location_azimuth": "0",
"breaks_unused_connections": false,
"serial_number": "",
"video_streams": [],
"microphones": [],
"ptzs": [],
"archive_bindings": [],
"ray": [],
"relay": [],
"detectors": [],
"offline_detectors": [],
"group_ids": [
"e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
],
"is_activated": true,
"text_sources": [],
"speakers": [],
"enabled": true,
"panomorph": {
"enabled": false,
"fit_to_frame": false,
"camera_position": 0,
"view_type": 0,
"camera_lens": "FISH_EYE_LENS",
"fisheye_circles": {
"circle": [
{
"center": {
"x": 0,
"y": 0
},
"radius": 0
}
]
}
},
"video_buffer_size": 50,
"video_buffer_enabled": false,
"alternative_view": {
"alternative_camera_name": "",
"second_alternative_camera_name": ""
}
},
"is_default": false,
"is_replica": false,
"is_permanent": true,
"sources": [
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.0CD24A6E-7D41-8204-946E-292C56526027",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"origin": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"mimetype": "video/vc-raw",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
},
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.88B74EF7-DD55-E48B-C8C2-80164E5B7436",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.audio:0",
"origin": "hosts/SERVER1/DeviceIpint.4/SourceEndpoint.audio:0",
"mimetype": "application/audio",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
}
]
},
{
"name": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"camera": {
"access_point": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"incomplete": false,
"display_name": "Camera",
"display_id": "1",
"ip_address": "0.0.0.0",
"camera_access": "CAMERA_ACCESS_UNSPECIFIED",
"vendor": "Virtual",
"model": "Virtual",
"firmware": "1.0.0",
"comment": "",
"armed": false,
"geo_location_latitude": "0",
"geo_location_longitude": "0",
"geo_location_azimuth": "0",
"breaks_unused_connections": false,
"serial_number": "",
"video_streams": [],
"microphones": [],
"ptzs": [],
"archive_bindings": [],
"ray": [],
"relay": [],
"detectors": [],
"offline_detectors": [],
"group_ids": [
"e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
],
"is_activated": true,
"text_sources": [],
"speakers": [],
"enabled": true,
"panomorph": {
"enabled": false,
"fit_to_frame": false,
"camera_position": 0,
"view_type": 0,
"camera_lens": "FISH_EYE_LENS",
"fisheye_circles": {
"circle": [
{
"center": {
"x": 0,
"y": 0
},
"radius": 0
}
]
}
},
"video_buffer_size": 50,
"video_buffer_enabled": false,
"alternative_view": {
"alternative_camera_name": "",
"second_alternative_camera_name": ""
}
},
"is_default": false,
"is_replica": false,
"is_permanent": true,
"sources": [
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.302BB661-FBE8-A713-D62F-1699D9B0445C",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"origin": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"mimetype": "video/vc-raw",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
},
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.AA123B66-E4C0-88CD-CBE2-3E1C1A8D9CBC",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.audio:0",
"origin": "hosts/SERVER1/DeviceIpint.1/SourceEndpoint.audio:0",
"mimetype": "application/audio",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
}
]
},
{
"name": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"camera": {
"access_point": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"incomplete": false,
"display_name": "Camera",
"display_id": "2",
"ip_address": "0.0.0.0",
"camera_access": "CAMERA_ACCESS_UNSPECIFIED",
"vendor": "Virtual",
"model": "Virtual",
"firmware": "1.0.0",
"comment": "",
"armed": false,
"geo_location_latitude": "0",
"geo_location_longitude": "0",
"geo_location_azimuth": "0",
"breaks_unused_connections": false,
"serial_number": "",
"video_streams": [],
"microphones": [],
"ptzs": [],
"archive_bindings": [],
"ray": [],
"relay": [],
"detectors": [],
"offline_detectors": [],
"group_ids": [
"e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
],
"is_activated": true,
"text_sources": [],
"speakers": [],
"enabled": true,
"panomorph": {
"enabled": false,
"fit_to_frame": false,
"camera_position": 0,
"view_type": 0,
"camera_lens": "FISH_EYE_LENS",
"fisheye_circles": {
"circle": [
{
"center": {
"x": 0,
"y": 0
},
"radius": 0
}
]
}
},
"video_buffer_size": 50,
"video_buffer_enabled": false,
"alternative_view": {
"alternative_camera_name": "",
"second_alternative_camera_name": ""
}
},
"is_default": false,
"is_replica": false,
"is_permanent": true,
"sources": [
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.97CEC08C-B8DA-8FB1-1F52-ECB170D9F5C2",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"origin": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"mimetype": "video/vc-raw",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
},
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.B6DD90A9-883A-45D6-6026-500C1A3208FF",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.audio:0",
"origin": "hosts/SERVER1/DeviceIpint.2/SourceEndpoint.audio:0",
"mimetype": "application/audio",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
}
]
},
{
"name": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"camera": {
"access_point": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"incomplete": false,
"display_name": "Camera",
"display_id": "3",
"ip_address": "0.0.0.0",
"camera_access": "CAMERA_ACCESS_UNSPECIFIED",
"vendor": "Virtual",
"model": "Virtual",
"firmware": "1.0.0",
"comment": "",
"armed": false,
"geo_location_latitude": "0",
"geo_location_longitude": "0",
"geo_location_azimuth": "0",
"breaks_unused_connections": false,
"serial_number": "",
"video_streams": [],
"microphones": [],
"ptzs": [],
"archive_bindings": [],
"ray": [],
"relay": [],
"detectors": [],
"offline_detectors": [],
"group_ids": [
"e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
],
"is_activated": true,
"text_sources": [],
"speakers": [],
"enabled": true,
"panomorph": {
"enabled": false,
"fit_to_frame": false,
"camera_position": 0,
"view_type": 0,
"camera_lens": "FISH_EYE_LENS",
"fisheye_circles": {
"circle": [
{
"center": {
"x": 0,
"y": 0
},
"radius": 0
}
]
}
},
"video_buffer_size": 50,
"video_buffer_enabled": false,
"alternative_view": {
"alternative_camera_name": "",
"second_alternative_camera_name": ""
}
},
"is_default": false,
"is_replica": false,
"is_permanent": true,
"sources": [
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.99E5AA8F-2737-8C46-CD32-9C078AF3D64F",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.audio:0",
"origin": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.audio:0",
"mimetype": "application/audio",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
},
{
"access_point": "hosts/SERVER1/MultimediaStorage.AliceBlue/Sources/src.EC060F6C-4F27-75C9-0B00-48F9EF26D8C9",
"storage": "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage",
"binding": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"media_source": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"origin": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
"mimetype": "video/vc-raw",
"origin_storage": "",
"origin_storage_source": "",
"prerecording": 3000
}
]
}
],
"is_activated": true,
"enabled": true
}
],
"not_found_objects": [],
"unreachable_objects": []
}
--ngpboundary
Content-Type: application/json; charset=utf-8
Content-Length: 71
{
"items": [],
"not_found_objects": [],
"unreachable_objects": []
}
The response contains information about video cameras linked with this archive.
- No labels
Overview
Content Tools
Error formatting macro: children: java.lang.NullPointerException