Skip to content
Docs
Select language:English

/api/v1/locations/{id}/layout

PUT
/api/v1/locations/{id}/layout
curl --request PUT \
  --url https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout \
  --header 'Content-Type: application/json' \
  --data '{ "version": "example", "rooms": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "x": 1, "z": 1, "w": 1, "d": 1, "kind": "room", "surface": "wood" } ], "nodes": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "x": 1, "z": 1, "rot": 0, "model": "example", "hostId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
Any of:
string
<= 40 characters
rooms
required
Array<object>
<= 400 items
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
x
required
integer
<= 100000
z
required
integer
<= 100000
w
required
integer
>= 100 <= 10000
d
required
integer
>= 100 <= 10000
kind
required
string
Allowed values: room balcony terrace garden
surface
required
string
Allowed values: wood tile concrete deck grass
nodes
required
Array<object>
<= 3000 items
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
x
required
integer
<= 100000
z
required
integer
<= 100000
rot
required
Any of:
number
Allowed values: 0
model
required
string
<= 40 characters
hostId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
version
required
string | null
Examplegenerated
{
  "version": "example"
}