[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service

Get Dashboard By ID

Description

Gets a dashboard by id

Request

Request

URL

URL


get
https://{api_host}/vrlic/api/v1/content/dashboards/id/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DashboardDefinitionDto of type */*
{
	"allowedAction": "READ",
	"contentPackId": "string",
	"createdAt": "string",
	"createdBy": "string",
	"cspOrgId": "string",
	"dashboardType": "USER_DEFINED",
	"entityTagAssociation": [
		{
			"tagId": "string",
			"tagName": "string"
		}
	],
	"id": "string",
	"isFavourite": false,
	"lastUpdatedAt": "string",
	"lastUpdatedBy": "string",
	"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": [
						{
							"fieldName": "text",
							"operator": "CONTAINS",
							"value": "error"
						}
					],
					"fieldName": "string",
					"operator": "AND",
					"tags": [
						"string"
					],
					"value": "string"
				},
				"contentPackId": "string",
				"createdAt": "string",
				"createdBy": "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,
				"lastUpdatedAt": "string",
				"lastUpdatedBy": "string",
				"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"
		}
	]
}
string
dashboardType Required

All allowed dashboard types, which include: USER_DEFINED

Possible values are: USER_DEFINED


string
name Required

A unique name for each dashboard


array of DashboardWidget
widgets Required

List of dashboard widget


string
id Optional

A unique identifier for each dashboard


string
cspOrgId Optional

Unique ID associated with the org


string
createdBy Optional

Email of the user who created this dashboard


entityTagAssociation Optional

List of tags associated with this dashboard


string
createdAt Optional

ISO8601 date string that informs when this dashboard was created


boolean
isFavourite Optional

Represents whether this dashboard is a user’s favorite


string
lastUpdatedAt Optional

ISO8601 date string that informs when this dashboard was updated


string
lastUpdatedBy Optional

Email of the user who last updated this dashboard


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


string
allowedAction Optional

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

Possible values are: READUPDATELOCKHIDDENDISABLEDNONE

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/vrlic/api/v1/content/dashboards/id/{id}


[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service
Feedback

Was this page helpful?