Service: Zone

This API is officially released and maintained.

The zone service allows getting, configuring, deleting and receiving updates of the configured zones.

List

Returns the configured zones

Response containing the configured list of zones

Table 2. Available fields in blickfeld.percept_pipeline.services.ZoneListResponse
Field	Type	Default	Unit
zones	repeated config.ZoneAlgorithm	-	-
zones	The currently configured zones

Store / Update a zone

Request to store or update an existing zone

Table 3. Available fields in blickfeld.percept_pipeline.services.ZoneStoreRequest
Field	Type	Default	Unit
zone	config.ZoneAlgorithm	-	-
zone	The new zone to be added. If there is a zone with the same uuid, that zone will get updated with this configuration.

Delete a zone

Request to delete a zone

Table 4. Available fields in blickfeld.percept_pipeline.services.ZoneDeleteRequest
Field	Type	Default	Unit
uuid	string	-	-
uuid	The uuid of the zone to be deleted

Watch configuration for zone list

Continuous response on zone list changes

Table 5. Available fields in blickfeld.percept_pipeline.services.ZoneWatchResponse
Field	Type	Default	Unit
zones	repeated config.ZoneAlgorithm	-	-
zones	The current/updated list of zones