DashboardDefinitionDto

Dashboard definition

Properties

string

name Required

A unique name for each dashboard

string

dashboardType Required

All allowed dashboard types, which include: USER_DEFINED

Possible values are: USER_DEFINED

array of DashboardWidget

widgets Required

List of dashboard widget

string

allowedAction Optional

All allowed feature actions, which include: READ, UPDATE, LOCK, HIDDEN, DISABLED, NONE

Possible values are: READ , UPDATE , LOCK , HIDDEN , DISABLED , NONE

string

cspOrgId Optional

Unique ID associated with the org

array of EntityTagAssociationDto

entityTagAssociation Optional

List of tags associated with this dashboard

string

id Optional

A unique identifier for each dashboard

boolean

isFavourite Optional

Represents whether this dashboard is a user’s favorite

string

contentPackId Optional

ID of the content pack that this dashboard belongs to if the dashboard is part of a content pack

string

owner Optional

Name of the owner of this dashboard

JSON Example

Show optional properties

{
	"dashboardType": "USER_DEFINED",
	"name": "string",
	"widgets": [
		{
			"name": "string",
			"queryDefinitionLink": "string",
			"widgetPlacement": {
				"height": 4,
				"width": 4,
				"x": 0,
				"y": 0
			},
			"widgetType": "CHART"
		}
	]
}

{
	"allowedAction": "READ",
	"contentPackId": "string",
	"cspOrgId": "string",
	"dashboardType": "USER_DEFINED",
	"entityTagAssociation": [
		{
			"tagId": "string",
			"tagName": "string"
		}
	],
	"id": "string",
	"isFavourite": false,
	"name": "string",
	"owner": "string",
	"widgets": [
		{
			"analysisFunctions": [
				{
					"name": "INFLECTION",
					"parameters": {
						"key": "string"
					}
				}
			],
			"chartOptions": {
				"key": "string"
			},
			"chartType": "string",
			"description": "string",
			"filter": {
				"options": {
					"key": "string"
				},
				"type": "DATE"
			},
			"name": "string",
			"queryDefinitionLink": "string",
			"queryDefinitionState": {
				"aggregationFunctions": [
					{
						"fieldName": "string",
						"functionName": "COUNT"
					}
				],
				"annotation": false,
				"constraints": {
					"constraints": "QueryConstraint Object",
					"fieldName": "string",
					"operator": "AND",
					"tags": [
						"string"
					],
					"value": "string"
				},
				"contentPackId": "string",
				"description": "string",
				"documentAuthPrincipalLink": "string",
				"documentDescription": {
					"description": "string",
					"documentIndexingOptions": [
						"INDEX_METADATA"
					],
					"name": "string",
					"propertyDescriptions": {
						"key": {
							"elementDescription": "PropertyDescription Object",
							"enumValues": [
								"string"
							],
							"exampleValue": {},
							"indexingOptions": [
								"EXPAND"
							],
							"kind": "string",
							"propertyDocumentation": "string",
							"typeName": "LONG",
							"usageOptions": [
								"SINGLE_ASSIGNMENT"
							]
						}
					},
					"serializedStateSizeLimit": 0,
					"serviceCapabilities": [
						"INSTRUMENTATION"
					],
					"serviceRequestRoutes": {
						"key": {
							"action": "GET",
							"description": "string",
							"handler": {},
							"matcher": {},
							"parameters": [
								{
									"description": "string",
									"name": "string",
									"paramDef": "QUERY",
									"required": false,
									"type": "string",
									"value": "string"
								}
							],
							"path": "string",
							"supportLevel": "NOT_SUPPORTED"
						}
					},
					"userInterfaceResourcePath": "string",
					"versionRetentionFloor": 0,
					"versionRetentionLimit": 0
				},
				"documentEpoch": 0,
				"documentExpirationTimeMicros": 0,
				"documentKind": "string",
				"documentOwner": "string",
				"documentSelfLink": "string",
				"documentSourceLink": "string",
				"documentTransactionId": "string",
				"documentUpdateAction": "string",
				"documentUpdateTimeMicros": 0,
				"documentVersion": 0,
				"groupByTerms": [
					{
						"fieldName": "string",
						"groupByType": "EACH_VALUE"
					}
				],
				"isAnnotation": false,
				"isSearchable": false,
				"name": "string",
				"relationFunctions": [
					{
						"relationName": "string",
						"relationType": "LOGS",
						"shardInfo": {
							"key": "string"
						}
					}
				],
				"searchable": false,
				"source": "USER_DEFINED",
				"sourceName": "string",
				"tenantLinks": [
					"string"
				],
				"url": "string",
				"widget": {
					"analysisFunctions": [
						{
							"name": "INFLECTION",
							"parameters": {
								"key": "string"
							}
						}
					],
					"visualization": {
						"options": {
							"key": "string"
						},
						"type": "AREA"
					},
					"widgetType": "CHART"
				}
			},
			"visualization": {
				"options": {
					"key": "string"
				},
				"type": "AREA"
			},
			"widgetPlacement": {
				"height": 4,
				"width": 4,
				"x": 0,
				"y": 0
			},
			"widgetProperties": {
				"key": {}
			},
			"widgetType": "CHART"
		}
	]
}

[{"label":"Latest (v1)","version":"latest"}]

vmware-aria-operations-for-logs

Property Of

DashboardResponseDto

Parameter To

Create Dashboard

Returned By

Create Dashboard
Get Dashboard By ID

DashboardDefinitionDto

Properties

JSON Example

Property Of

Parameter To

Returned By

Was this page helpful?