latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Canvases

Update specific fields of a widget.

Update specific fields of a widget.

patch/canvases/widgets/{id}

Path parameters

idstring required

Request body

idstring uuid
namestring
type'RANGE' | 'TEMPLATE' | 'TEXT'
  • RANGE - Range
  • TEMPLATE - Template
  • TEXT - Text
visual_type'TEXT' | 'DATA_TABLE' | 'LINE' | 'BAR' | 'ROW' | 'COMBO' | 'PIE' | 'DONUT' | 'METRIC' | 'TREND' | 'WATERFALL'
  • TEXT - Text
  • DATA_TABLE - Data Table
  • LINE - Line Chart
  • BAR - Bar Chart
  • ROW - Row Chart
  • COMBO - Combo Chart
  • PIE - Pie Chart
  • DONUT - Donut Chart
  • METRIC - Metric
  • TREND - Trend
  • WATERFALL - Waterfall Chart
{"stackTrail":"components:schemas:PatchedWidget:properties:settings","oasType":"schema","type":"unknown"}

Response

idstring uuid required
namestring required
type'RANGE' | 'TEMPLATE' | 'TEXT' required
  • RANGE - Range
  • TEMPLATE - Template
  • TEXT - Text
visual_type'TEXT' | 'DATA_TABLE' | 'LINE' | 'BAR' | 'ROW' | 'COMBO' | 'PIE' | 'DONUT' | 'METRIC' | 'TREND' | 'WATERFALL' required
  • TEXT - Text
  • DATA_TABLE - Data Table
  • LINE - Line Chart
  • BAR - Bar Chart
  • ROW - Row Chart
  • COMBO - Combo Chart
  • PIE - Pie Chart
  • DONUT - Donut Chart
  • METRIC - Metric
  • TREND - Trend
  • WATERFALL - Waterfall Chart
{"stackTrail":"components:schemas:Widget:properties:settings","oasType":"schema","type":"unknown"}