createSiteMap
Create Site Map
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidRequest Body
application/json
Request Body
Map or floorplan metadata for a site or organization
Location boundary definitions configured on this map
When type==image, height of the map image in pixels
Physical height of the map in meters
doubleWhen type==google, bottom-right map bounds coordinate
When type==google, top-left map bounds coordinate
Whether this map is considered locked down
falseOptional floor number within the map stack
0 <= valueMap stack containing this map
uuidThe name of the map
Maximum occupancy configured for this map
Map orientation in degrees; 0 means up is north, 90 means up is west
0 <= value <= 3590User-annotated X origin, pixels
User-annotated Y origin, pixels
When type==image, pixels per meter for the map image
Site survey path geometry for this map
0 <= itemsMap type, such as image or google
"image"Value in
- "google"
- "image"
If type==google, map tile view to display. enum: hybrid, roadmap, satellite, terrain.
Value in
- "hybrid"
- "roadmap"
- "satellite"
- "terrain"
Wall path geometry for this map
Navigation pathfinding settings for this map
Wayfinding path geometry for this map
When type==image, width of the map image in pixels
Physical width of the map in meters
doubleResponse Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps" \ -H "Content-Type: application/json" \ -d '{ "height": 0, "height_m": 0, "latlng_br": { "lat": "string", "lng": "string" }, "latlng_tl": { "lat": "string", "lng": "string" }, "locked": true, "name": "string", "occupancy_limit": 0, "orientation": 0, "origin_x": 0, "origin_y": 0, "ppm": 0, "sitesurvey_path": [ { "coordinate": "string", "name": "string", "nodes": [ { "edges": { "N2": "string" }, "name": "string", "position": { "x": 0, "y": 0 } } ] } ], "type": "image", "view": "roadmap", "wall_path": { "coordinate": "string", "nodes": [ { "edges": { "N2": "string" }, "name": "string", "position": { "x": 0, "y": 0 } } ] }, "wayfinding": { "micello": { "account_key": "string", "default_level_id": 0 }, "snap_to_path": true }, "wayfinding_path": { "coordinate": "string", "nodes": [ { "edges": { "N2": "string" }, "name": "string", "position": { "x": 0, "y": 0 } } ] }, "width": 0, "width_m": 0 }'{ "created_time": 0.1, "flags": { "assetHoldTime": 5, "storeTime": 10 }, "for_site": true, "geofences": [ { "name": "example", "vertices": [ { "X": 700, "Y": 100 } ] } ], "height": 1500, "height_m": 0.1, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "latlng_br": { "lat": "string", "lng": "string" }, "latlng_tl": { "lat": "string", "lng": "string" }, "locked": false, "mapstack_floor": 1, "mapstack_id": "6a2856e5-9974-4b44-b75f-f41547024f71", "modified_time": 0.1, "name": "Mist Office", "occupancy_limit": 0, "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "orientation": 30, "origin_x": 35, "origin_y": 60, "ppm": 40.94, "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "sitesurvey_path": [], "thumbnail_url": "https://url/to/image.png", "type": "image", "url": "https://url/to/image.png", "view": "hybrid", "wall_path": { "coordinate": "actual", "nodes": [] }, "wayfinding": { "micello": { "account_key": "adasdf", "default_level_id": 5, "map_id": "c660f81dd250c" }, "snap_to_path": true }, "wayfinding_path": { "coordinate": "actual", "nodes": [] }, "width": 1250, "width_m": 0.1}