Displays

Retrieve all displays

get

Returns all display configurations available in the current workspace.

Responses
chevron-right
200

List of displays retrieved successfully

application/json
idstring · uuidOptional
get
/api/display/

List display folders

get
Responses
chevron-right
200

Display folders retrieved successfully

application/json
idstring · uuidOptional
displaysstring · uuid[]Optional
get
/api/display/group/

Retrieve a display by ID

get

Fetches a display configuration by its unique identifier.

Path parameters
displayIdstring · uuidRequired

Unique identifier (UUID) of the display to retrieve

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
chevron-right
200

Display retrieved successfully

application/json
idstring · uuidOptional
get
/api/display/{displayId}

Create a display

post

Creates a display configuration in the current workspace.

Body
idstring · uuidOptional
Responses
chevron-right
200

Display created successfully

application/json
idstring · uuidOptional
post
/api/display/add

Delete a display

delete

Deletes a display by its unique identifier.

Path parameters
displayIdstring · uuidRequired

Unique identifier (UUID) of the display to delete

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
chevron-right
200

Display deleted successfully

application/json
anyOptional
delete
/api/display/delete/{displayId}

No content

Create display folder

post
Body
idstring · uuidOptional
displaysstring · uuid[]Optional
Responses
chevron-right
200

OK

*/*
anyOptional
post
/api/display/group/add
200

OK

No content

Assign display to folder

post
Body
groupIdstring · uuidOptional
displayIdstring · uuidOptional
Responses
chevron-right
200

OK

*/*
anyOptional
post
/api/display/group/add-display
200

OK

No content

Delete display folder

delete
Responses
chevron-right
200

OK

*/*
anyOptional
delete
/api/display/group/delete/{groupId}
200

OK

No content

Remove display from folder

post
Body
groupIdstring · uuidOptional
displayIdstring · uuidOptional
Responses
chevron-right
200

OK

*/*
anyOptional
post
/api/display/group/remove-display
200

OK

No content

Update display folder

put
Body
idstring · uuidOptional
displaysstring · uuid[]Optional
Responses
chevron-right
200

OK

*/*
anyOptional
put
/api/display/group/update
200

OK

No content

Update a display

put

Updates a display configuration in the current workspace.

Body
idstring · uuidOptional
Responses
chevron-right
200

Display updated successfully

application/json
idstring · uuidOptional
put
/api/display/update

Last updated