updateSpanGeometry
PUT
/api/v1/screen-groups/{id}/span
const url = 'https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/span';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"displayMode":"mirror","canvas":{"width":1,"height":1},"panels":[{"screenId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","screenName":"example","order":1,"x":1,"y":1,"width":1,"height":1,"rotation":0,"bezelLeft":1,"bezelTop":1,"bezelRight":1,"bezelBottom":1}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/span \ --header 'Content-Type: application/json' \ --data '{ "displayMode": "mirror", "canvas": { "width": 1, "height": 1 }, "panels": [ { "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "screenName": "example", "order": 1, "x": 1, "y": 1, "width": 1, "height": 1, "rotation": 0, "bezelLeft": 1, "bezelTop": 1, "bezelRight": 1, "bezelBottom": 1 } ] }'Update span geometry. Requires an authenticated dashboard user.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Header Parameters
Section titled “Header Parameters”X-CSRF-Token
string
Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
displayMode
string
canvas
object
width
required
integer
height
required
integer
panels
Array<object>
object
screenId
required
string format: uuid
screenName
string
order
required
integer
x
required
integer
y
required
integer
width
required
integer
height
required
integer
rotation
required
integer
bezelLeft
integer
bezelTop
integer
bezelRight
integer
bezelBottom
integer
Responses
Section titled “ Responses ”Display Group updated and member manifests revised
Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
description
required
string
displayMode
required
string
presentationGatewayScreenId
string format: uuid
playlistId
string format: uuid
playlistName
string
layoutId
string format: uuid
layoutName
string
presentationType
string
playbackEpoch
required
string format: date-time
membershipCount
required
integer
screens
required
Array<object>
object
id
required
string format: uuid
name
required
string
location
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{ "data": { "displayMode": "mirror", "presentationType": "playlist" }}Geometry conflicts with current membership
Canvas or panel validation failed