getSiteApAutoplacementStatus

GET https://{{host}}/api/v1/sites/:site_id/maps/:map_id/auto_placement

This API is called to view the current status of auto placement for a given map.

Response Parameters

NameTypeDescription
statusStringthe status of autoplacement for a given map
start_timefloattime when autoplacement process was last queued for this map
est_time_leftfloat(Only when inprogress) estimate of the time to completion
end_timefloattime when autoplacement completed or was manually stopped

Status Descriptions

StatusDescription
pendingAutoplacement has not been requested for this map
inprogressAutoplacement is currently processing
doneThe autoplacement process has completed
data_neededAdditional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map
invalid_modelAutoplacement is not supported on the model of the APs on the map
invalid_versionAutoplacement is not supported with the APs current firmware version
errorThere was an error in the autoplacement process

RESPONSES

status: OK

{"status":"error","start_time":1678900062,"end_time":1678900362}