[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Get Dashboard
DescriptionGets a list of dashboards by dashboard type. It includes USER_DEFINED
Request
URLURL
https://{api_host}/vrlic/api/v1/content/dashboards/{type}
Path Parameters
Path Parameters
string
type
Required
Type refers to dashboard type here
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
DashboardResponseDto
of type */*
{
"dashboards": [
{
"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"
}
]
}
]
}
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://{api_host}/vrlic/api/v1/content/dashboards/{type}
[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Dashboards Operations
post
delete
get