Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
Previous page
Next page
POST http://IP address:port/prefix/grpc
Get a list of all cameras
Request body:
{
"method": "axxonsoft.bl.domain.DomainService.ListCameras",
"data": {
"view" : "VIEW_MODE_FULL"
}
}
Response example:
Get info about a particular camera
Request body:
{
"method": "axxonsoft.bl.domain.DomainService.BatchGetCameras",
"data": {
"items":[{
"access_point":"hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"
}]
}
}
Response example:
Get a list of all cameras of all nodes of this server
Request body:
{
"method": "axxonsoft.bl.domain.DomainService.ListCameras",
"data":
{
"view": "VIEW_MODE_NO_CHILD_OBJECTS"
}
}
Get a list of all cameras of a particular node
Request body:
{
"method": "axxonsoft.bl.domain.DomainService.ListCameras",
"data":
{
"filter": "hosts/Node1/",
"view": "VIEW_MODE_NO_CHILD_OBJECTS"
}
}
Get information about a video channel
Request body:
{
"method": "axxonsoft.bl.domain.DomainService.ListCameras",
"data":
{
"view": "VIEW_MODE_FULL",
"query": {
"query": "comment.1",
"search_fields": "DECORATED_NAME",
"search_type": "SUBSTRING",
"decorated_name_template": "{comment}.{display_id}"
},
"page_token":"",
"page_size":"100"
}
}
where view specifies how the result will be displayed:
- VIEW_MODE_FULL—full information,
- VIEW_MODE_STRIPPED—only basic information about the camera, no information about components (microphone, telemetry, storage, and streams).
query—allows you to get a subset of results in accordance with the search request.
search_type—an integer or value that specifies which search type to use:
- 0 or SUBSTRING—search using the substring method (default),
- 1 or FUZZY—fuzzy search method.
search_fields—a list of integers or values separated by "|" that define which fields to search. If a match is found, subsequent fields will not be searched. Valid values are:
- 0 or DECORATED_NAME—search according to the template specified in the decorated_name_template field (default {display_id}.{display_name}),
- 1 or DISPLAY_NAME—search by name,
- 2 or DISPLAY_ID—search by short name,
- 3 or COMMENT—search by a comment,
- 4 or ACCESS_POINT—search by an access point.
decorated_name_template—a template that determines how the final search string will be constructed. There are keywords that can be replaced with actual device values. Keywords are:
- {display_name}—camera name,
- {display_id}—camera short name,
- {comment}—camera comment,
- {access_point}—camera access point.
The default template is {display_id}.{display_name}. For example, for a device named "Camera" and with the short name "1", the final search string would be "1.Camera".
page_token and page_size—are used for page-by-page display of query results.
Response example:
Overview
Content Tools