HIhillstar
workspaces

Replace the workspace UI configuration (admin only)

put/api/workspaces/{workspace_id}/ui-config

Request

  • Base URL
    https://api.hillstar.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hillstar.ai/api/workspaces/{workspace_id}/ui-config
  • Auth
    none declared

Path parameters

workspace_idinteger required

Workspace ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

score_display'numeric' | 'letter' | 'qualitative' | 'hidden'
score_scale_maxinteger

Value a raw score of 5 is displayed as (default 5)

score_scale_mininteger

Value a raw score of 1 is displayed as (default 1)

Example request

{
  "$schema": "https://example.com/api/schemas/WorkspaceUIConfigRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required
created_by_user_idinteger nullable required
idinteger required
namestring required
ui_configobject required
updated_atstring date-time required

Example response

{
  "$schema": "https://example.com/api/schemas/WorkspaceResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.