v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB
behavior

Retrieves behavior(s) from database.

get/behavior

Query parameters

sensorIdstring

This parameter is incompatible with place. Only one of them can exist in the query.

placestring

This parameter is incompatible with sensorId. Only one of them can exist in the query.

objectIdstring

This parameter is incompatible with either 'place', 'queryString' or 'maxResultSize'. It also requires 'sensorId', 'fromTimestamp' and 'toTimestamp' in the query.

objectTypestring

If this parameter is present in the query, then 'objectId' should also be present in the query.

fromTimestampstring date-time

If this parameter is present in the query, then 'toTimestamp' should also be present in the query.

toTimestampstring date-time

If this parameter is present in the query, then 'fromTimestamp' should also be present in the query.

queryStringstring

'queryString' should follow lucene syntax.

maxResultSizeinteger

Response

Successful Operation.

Example response

{
  "behaviors": [
    {
      "timestamp": "2022-08-25T00:00:00.000Z",
      "Id": "logstash generated Id",
      "id": "Cam1 #-# 11",
      "timeInterval": 30,
      "end": "2022-08-25T00:00:30.000Z",
      "locations": {
        "coordinates": [
          [
            1
          ]
        ]
      },
      "smoothLocations": {
        "coordinates": [
          [
            1
          ]
        ]
      },
      "speedOverTime": [
        2.1,
        3.2
      ],
      "sensor": {
        "id": "cam-1",
        "description": "description of sensor",
        "type": "sensor",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "place": {
        "name": "city=abc/building=def/Warehouse=xyz",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "event": {
        "type": "ENTRY",
        "id": "hazard_zone_1",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "object": {
        "type": "Person",
        "location": {
          "lon": 7.5,
          "lat": 2.6,
          "alt": 9.47
        },
        "bbox": {
          "topY": 0.5,
          "rightX": 1.7,
          "bottomY": 0.8,
          "leftX": 0.6,
          "embeddings": [
            {
              "vector": [
                0.1
              ]
            }
          ],
          "confidence": 0.95,
          "info": {
            "additionalProperty1": "value1",
            "additionalProperty2": "value2"
          }
        },
        "id": "133",
        "speed": 50,
        "coordinate": {
          "x": 50,
          "y": 50,
          "z": 50
        },
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "edges": [
        "1"
      ],
      "analyticsModule": {
        "id": "1",
        "description": "description",
        "version": "example1",
        "source": "source1",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "videoPath": "path_to_video"
    }
  ]
}