[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs

Update Query Definition By Put

Description

Updates the query definition by id

Request

Request

URL

URL


put
https://{api_host}/vrlic/api/v1/query-definitions/{id}
Copy

Path Parameters

Path Parameters

string
id Required

ID of the existing query def


Request Body

Request Body

QueryDefinitionsDto of mimetype application/json Required
{
	"name": "string"
}
string
name Required

Query name. It should be unique


aggregationFunctions Optional

List of aggregate field and function name


string
contentPackId Optional

Content pack id if this query belongs to any


string
description Optional

Detailed description of Query definition


string
documentSelfLink Optional

Indicates document self link


entityTagAssociation Optional

List of entity tag associated with this query


array of FieldListItem
fieldListItems Optional

Field List Items


array of GroupByTerm
groupByTerms Optional

List of group by field name and type


string
id Optional

boolean
isAnnotation Optional

Indicates whether the query should be used to annotate log messages


boolean
isFavorite Optional

Is Query Favourite - used to identify if the query is favourite for a user.


boolean
isSearchable Optional

Indicates whether the query should be displayed in search results


constraints Optional

Constraints for the query associated with this dataset


string
queryId Optional

Query identifier. It should be unique


array of RelationFunction
relationFunctions Optional

List of relation name and type. Allowed relation type includes: LOGS


string
source Optional

All allowed source of query: CONTENT_PACK, USER_DEFINED

Possible values are: CONTENT_PACKUSER_DEFINED


string
sourceName Optional

Name of the content pack that provided this query definition


array of string
tenantLinks Optional

List of tenant links


string
url Optional

An URL that links to additional information. (Vmware KB article / other recommended approach for fixing issue)


widget Optional

Widget configuration - used to capture configuration of the chart on the explore logs UI, and to provide defaults when a query is added to a dashboard.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns QueryDefinitionsDto of type */*
{
	"aggregationFunctions": [
		{
			"fieldName": "string",
			"functionName": "COUNT"
		}
	],
	"constraints": {
		"constraints": "QueryConstraint Object",
		"fieldName": "string",
		"operator": "AND",
		"tags": [
			"string"
		],
		"value": "string"
	},
	"contentPackId": "string",
	"description": "string",
	"documentSelfLink": "string",
	"entityTagAssociation": [
		{
			"tagId": "string",
			"tagName": "string"
		}
	],
	"fieldListItems": [
		{
			"link": "string",
			"name": "string"
		}
	],
	"groupByTerms": [
		{
			"fieldName": "string",
			"groupByType": "EACH_VALUE"
		}
	],
	"id": "string",
	"isAnnotation": false,
	"isFavorite": false,
	"isSearchable": false,
	"name": "string",
	"queryId": "string",
	"relationFunctions": [
		{
			"relationName": "string",
			"relationType": "LOGS",
			"shardInfo": {
				"key": "string"
			}
		}
	],
	"source": "CONTENT_PACK",
	"sourceName": "string",
	"tenantLinks": [
		"string"
	],
	"url": "string",
	"widget": {
		"analysisFunctions": [
			{
				"name": "INFLECTION",
				"parameters": {
					"key": "string"
				}
			}
		],
		"filter": {
			"options": {
				"key": "string"
			},
			"type": "DATE"
		},
		"name": "string",
		"visualization": {
			"options": {
				"key": "string"
			},
			"type": "AREA"
		},
		"widgetType": "CHART"
	}
}
string
name Required

Query name. It should be unique


aggregationFunctions Optional

List of aggregate field and function name


string
contentPackId Optional

Content pack id if this query belongs to any


string
description Optional

Detailed description of Query definition


string
documentSelfLink Optional

Indicates document self link


entityTagAssociation Optional

List of entity tag associated with this query


array of FieldListItem
fieldListItems Optional

Field List Items


array of GroupByTerm
groupByTerms Optional

List of group by field name and type


string
id Optional

boolean
isAnnotation Optional

Indicates whether the query should be used to annotate log messages


boolean
isFavorite Optional

Is Query Favourite - used to identify if the query is favourite for a user.


boolean
isSearchable Optional

Indicates whether the query should be displayed in search results


constraints Optional

Constraints for the query associated with this dataset


string
queryId Optional

Query identifier. It should be unique


array of RelationFunction
relationFunctions Optional

List of relation name and type. Allowed relation type includes: LOGS


string
source Optional

All allowed source of query: CONTENT_PACK, USER_DEFINED

Possible values are: CONTENT_PACKUSER_DEFINED


string
sourceName Optional

Name of the content pack that provided this query definition


array of string
tenantLinks Optional

List of tenant links


string
url Optional

An URL that links to additional information. (Vmware KB article / other recommended approach for fixing issue)


widget Optional

Widget configuration - used to capture configuration of the chart on the explore logs UI, and to provide defaults when a query is added to a dashboard.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"aggregationFunctions":[{"fieldName":"string","functionName":"COUNT"}],"constraints":{"constraints":"QueryConstraint Object","fieldName":"string","operator":"AND","tags":["string"],"value":"string"},"contentPackId":"string","description":"string","documentSelfLink":"string","entityTagAssociation":[{"tagId":"string","tagName":"string"}],"fieldListItems":[{"link":"string","name":"string"}],"groupByTerms":[{"fieldName":"string","groupByType":"EACH_VALUE"}],"id":"string","isAnnotation":false,"isFavorite":false,"isSearchable":false,"name":"string","queryId":"string","relationFunctions":[{"relationName":"string","relationType":"LOGS","shardInfo":{"key":"string"}}],"source":"CONTENT_PACK","sourceName":"string","tenantLinks":["string"],"url":"string","widget":{"analysisFunctions":[{"name":"INFLECTION","parameters":{"key":"string"}}],"filter":{"options":{"key":"string"},"type":"DATE"},"name":"string","visualization":{"options":{"key":"string"},"type":"AREA"},"widgetType":"CHART"}}' https://{api_host}/vrlic/api/v1/query-definitions/{id}


[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Feedback

Was this page helpful?