startSiteApAutoOrientation
POST https://{{host}}/api/v1/sites/:site_id/maps/:map_id/auto_orient
This API is called to trigger a map for auto orient. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST to this endpoint while a map is still running will be rejected.
force_collection
is set to false by default. If force_collection
is set to false, the API attempts to start auto orientation with existing BLE data. If force_collection
is set to true, the API attempts to start BLE orchestration.
List of devices to provide suggestions for is an optional parameter that can be given to this API. This will provide auto orient suggestions only for the devices specified. If no list of devices is provided, all APs asociated with that map are considered by default
Responses
400 Bad Request
- Map has less than 3 APs associated with it to perform auto orient400 Bad Request
- Auto AP orient is already in progress for this Map400 Bad Request
- Auto orient data does not exist or has gone stale200 Success
- Auto orient process has begun for this map
Request Body
{"macs"=>["<list of device macs>", "..."], "force_collection"=>true}
RESPONSES
status: OK