The renameWidget() GraphQL mutation may be used to rename a widget in LogScale.

For more information on dashboard widgets, see the Manage Widgets documentation page.

Syntax

Below is the syntax for the renameWidget() mutation field:

graphql
renameWidget(
     id: string!
     widgetId: string!
     title: string!
   ): Dashboard!

Returned Datatypes

The returned datatype Dashboard has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Dashboard

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
allowedActions[AssetAction]yes The allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
assetTypeAssetTypeyes The related asset type. See AssetType Table). This has been deprecated and will be removed in LogScale version 1.136.
defaultFilterDashboardFilter  The default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledbooleanyes Whether the shared time by default is enabled.
defaultSharedTimeEndstringyes The default shared ending time.
defaultSharedTimeStartstringyes The default shared starting time.
descriptionstring  A description of the dashboard.
displayNamestringyes The display name of the dashboard.
filters[DashboardFilter]yes The filters used with the dashboard. See DashboardFilter.
idstringyes The unique identifier for the dashboard.
isStarredbooleanyes Whether the dashboard is marked with a star.
labels[string]yes Any labels associated with the dashboard.
namestringyes The name of the dashboard.
packagePackageInstallationyes The package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes The unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parameters[DashboardParameter]yes List of dashboard parameters (see DashboardParameter Table).
readOnlyTokens[DashboardLink]yes List of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
searchDomainSearchDomainyes The search domain for the dashboard. See SearchDomain.
sections[Section]yes The sections for the dashboard. See Section.
yamlTemplatestringyes A YAML formatted string that describes the dashboard. It does not contain links or permissions, and is safe to share and use for making copies of a dashboard. This replaced templateYaml starting in LogScale version 1.165.
timeJumpSizeInMsinteger  The skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes The frequency in which dashboard is updated. See the explanations under the DashboardParameter.
widgets[Widget]yes Widgets for the dashboard (see Widget Table).