[Index]
Data model for dashboard gauge chart widget.
Model ref.: data/DashboardWidgetChartGauge
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"title": {
"title": "Title",
"description": "The title to be displayed for this widget.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "Provide a useful description for this widget.",
"type": "string"
},
"resource": {
"title": "Resource",
"description": "Specify resource",
"type": "string",
"format": "uri",
"target": "/api/data/ReporterResource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/ReporterResource",
"choices": []
},
"datasource": {
"title": "Datasource",
"description": "The source from which the data for this column chart is obtained.",
"type": "string",
"default": "Insights"
},
"resource_definition": {
"title": "Resource Definition",
"description": "Returns the resource definitions",
"type": "string"
},
"_lowerTs": {
"title": "Start Timestamp",
"description": "Lower timestamp bound for the data range shown in the chart",
"type": "integer"
},
"_upperTs": {
"title": "End Timestamp",
"description": "Upper timestamp bound for the data range shown in the chart",
"type": "integer"
},
"_outputType": {
"title": "Output Type",
"description": "The format in which the data will be presented in the chart",
"type": "string",
"default": "highcharts",
"choices": [
{
"value": "raw",
"title": "Raw"
},
{
"value": "highcharts",
"title": "Highcharts"
}
]
},
"_groupingLimit": {
"title": "Series Limit",
"description": "The maximum number of groups to display on the chart",
"type": "string",
"default": "0",
"choices": [
{
"value": "0",
"title": "All"
},
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "10",
"title": "10"
},
{
"value": "15",
"title": "15"
},
{
"value": "20",
"title": "20"
},
{
"value": "25",
"title": "25"
},
{
"value": "30",
"title": "30"
},
{
"value": "40",
"title": "40"
},
{
"value": "50",
"title": "50"
},
{
"value": "60",
"title": "60"
},
{
"value": "70",
"title": "70"
},
{
"value": "80",
"title": "80"
},
{
"value": "90",
"title": "90"
},
{
"value": "100",
"title": "100"
},
{
"value": "200",
"title": "200"
},
{
"value": "300",
"title": "300"
},
{
"value": "400",
"title": "400"
},
{
"value": "500",
"title": "500"
},
{
"value": "1000",
"title": "1000"
},
{
"value": "10000",
"title": "10000"
},
{
"value": "50000",
"title": "50000"
},
{
"value": "100000",
"title": "100000"
}
]
},
"interval": {
"title": "Interval",
"description": "The time range over which the chart is presented.",
"type": "integer",
"default": 3,
"choices": [
{
"value": 6,
"title": "Per Second"
},
{
"value": 5,
"title": "Per Minute"
},
{
"value": 4,
"title": "Hourly"
},
{
"value": 3,
"title": "Daily"
},
{
"value": 2,
"title": "Weekly"
},
{
"value": 1,
"title": "Monthly"
}
]
},
"type": {
"title": "Type",
"description": "The chart type.",
"type": "integer",
"default": 3,
"choices": [
{
"value": 0,
"title": "Line"
},
{
"value": 1,
"title": "Column"
},
{
"value": 2,
"title": "Pie"
},
{
"value": 3,
"title": "Gauge"
},
{
"value": 16,
"title": "Table"
}
]
},
"fields": {
"title": "Fields",
"description": "Specify the fields from the resource to be used in the chart.",
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"title": "GUID",
"description": "Unique identifier for the field.",
"type": "string"
},
"ruleName": {
"title": "Field Name",
"description": "This is the field name.",
"type": "string",
"choices": []
},
"headerName": {
"title": "Friendly Name",
"description": "Specify a friendly name to be used in the chart.",
"type": "string"
},
"ruleTypeString": {
"title": "Field Type",
"description": "This is the field type",
"type": "string",
"readonly": true
},
"ruleType": {
"title": "Field Type",
"description": "This is the field type",
"type": "integer"
},
"valueType": {
"title": "Value Type",
"description": "This is the operation value type",
"type": "integer"
},
"operation": {
"title": "Operation",
"description": "Select the operation to be performed on the field.",
"type": "string",
"choices": []
},
"value_mapping": {
"title": "Value Mapping",
"description": "Select the value mapping to display user-friendly values. This will override the resource value mapping if one exists. To use the raw value, select 'NO MAPPING'.",
"type": "string"
}
}
}
},
"filters": {
"title": "Filters",
"description": "Specify filters to be applied to the data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"title": "GUID",
"description": "Unique identifier for the filter field.",
"type": "string"
},
"ruleName": {
"title": "Field Name",
"description": "Specify Field Name",
"type": "string",
"choices": []
},
"operation": {
"title": "Operation",
"description": "Specify operation",
"type": "string",
"choices": []
},
"filterValue": {
"title": "Filter Value",
"description": "Specify filter value",
"type": "string"
},
"ignore_case": {
"title": "Ignore Case",
"type": "boolean",
"required": false,
"readonly": false
},
"type": {
"title": "Filter Type",
"description": "Specify type",
"type": "integer"
}
}
}
},
"sorts": {
"title": "Sorts",
"description": "Specify sorts to be applied to the fields.",
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"title": "GUID",
"description": "Unique identifier for the sort field.",
"type": "string"
},
"ruleName": {
"title": "Field Name",
"description": "Select the field name to sort by.",
"type": "string",
"choices": []
},
"sort": {
"title": "Sort Type",
"description": "Select the sort type",
"type": "integer",
"choices": [
{
"value": 0,
"title": "Ascending"
},
{
"value": 1,
"title": "Descending"
}
]
}
}
}
},
"settings": {
"title": "Chart Settings",
"description": "Chart Settings",
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Specify description",
"type": "string"
},
"suffix": {
"title": "Gauge Label",
"description": "Specify suffix",
"type": "any"
},
"min": {
"title": "Min",
"description": "Specify min",
"type": "integer",
"default": 0
},
"max": {
"title": "Max",
"description": "Specify max",
"type": "integer",
"default": 100
},
"labelInside": {
"title": "Label Inside",
"description": "Specify labelInside",
"type": "boolean"
},
"showBands": {
"title": "Show Bands",
"description": "Specify showBands",
"type": "boolean"
},
"green": {
"title": "Band 1 %",
"description": "Specify the percentage range for Band 1",
"type": "integer",
"default": 33
},
"greenColor": {
"title": "Green Color",
"description": "Select the color for Band 1",
"type": "string",
"format": "color",
"default": "#68bd17"
},
"yellow": {
"title": "Band 2 %",
"description": "Specify the percentage range for Band 2",
"type": "integer",
"default": 33
},
"yellowColor": {
"title": "Yellow Color",
"description": "Select the color for Band 2",
"type": "string",
"format": "color",
"default": "#fbc403"
},
"red": {
"title": "Band 3 %",
"description": "Specify the percentage range for Band 3",
"type": "integer",
"default": 34
},
"redColor": {
"title": "Red Color",
"description": "Select the color for Band 3",
"type": "string",
"format": "color",
"default": "#dc0c00"
}
}
}
},
"schema_version": "0.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DashboardWidgetChartGauge/add/ |
|
The GUI Add form of data/DashboardWidgetChartGauge as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/DashboardWidgetChartGauge | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DashboardWidgetChartGauge/ |
|
The data/DashboardWidgetChartGauge schema and all instances as JSON. |
(The list will return 0 to 3 data/DashboardWidgetChartGauge instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "title",
"direction": "asc",
"current": "/api/data/DashboardWidgetChartGauge/?skip=0&limit=3&order_by=title&direction=asc&traversal=fulltree"
},
"operations": [
"help",
"bulk_update_form",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"migration",
"remove",
"move",
"transform",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "data/DashboardWidgetChartGauge",
"summary_attrs": [
{
"name": "title",
"title": "Title"
},
{
"name": "resource",
"title": "Resource"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"add",
"list"
],
"schema_version": "0.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DashboardWidgetChartGauge/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DashboardWidgetChartGauge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DashboardWidgetChartGauge/[pkid] | hierarchy=[hierarchy] | The data/DashboardWidgetChartGauge instance with [pkid]. |