Updating Bounding

Updates existing BoundingBox objects that satisfy the specified constraints.

Parameters

  • [optional] _ref: Reference to other connections within the transaction.
  • [optional] unique: Indicates whether a single object is expected to satisfy the constraints.

Blocks

Details

Either _ref OR constraints must be specified.

If the _ref parameter is specified, it must refers to the search results of a previous FindBoundingBox or AddBoundingBox.

If the rectangle parameter is absent, only properties will be updated (or removed).

The remove_props parameter is an array of strings specifying the properties to be deleted (if any).

If search results are empty, this will cause an exception.

Examples

# Update the name of a region of interest
"UpdateBoundingBox" : {
    "_ref" : 1234,
   "properties" : {
        "name" : "super_interesting_stuff"
   }
}

# Update the coordinates of a region of interest
"UpdateBoundingBox" : {
    "_ref" : 1234,
    "rectangle" : {"x": 100, "y": 60, "w": 45, "h": 45}
}

# Update the coordinates of a region of interest based on constraints
"UpdateBoundingBox" : {
    "rectangle" : {"x": 100, "y": 100, "w": 35, "h": 35},
    "constraints" : { "name" : ["==", "super_interesting_stuff"] }
}