OBJECT
DashboardMutation
link GraphQL Schema definition
- type DashboardMutation {
- # Delete multiple custom dashboards. This will also delete the default dashboard
- # settings associated with these dashboards if present.
- # Input to this API are dashboardIds and nodeVersions if optimistic locking is
- # needed.
- # ORG level dashboards can be deleted by organization admins.
- # USER level dashboards can be deleted by users owning the dashboard.
- #
- # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
- # for a stable API but we reserve the right to fix issues including modifying the
- # schema if required.
- #
- # Arguments
- # dashboards: [Not documented]
- (
- DashboardBulkDeleteInput!] : [
- ): DashboardBulkDeleteResponse
- # Delete a custom dashboard. This will delete the dashboard defaults associated
- # with dashboard ( if any)
- # ORG level dashboards can be deleted by organization admins.
- # USER level dashboards can be deleted by users owning the dashboard.
- #
- # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
- # for a stable API but we reserve the right to fix issues including modifying the
- # schema if required.
- #
- # Arguments
- # dashboardId: [Not documented]
- # nodeVersion: [Not documented]
- String!, : ID): Dashboard! ( :
- # Set a dashboard as default for a user/organization and category.
- # Only ORG dashboards can be set as ORG_DEFAULT by an admin.
- # PROJECT dashboard can be set as PROJECT_DEFAULT by Project admin or Org admin.
- # Any dashboard that is visible to a user can be set as USER_DEFAULT for
- # themselves.
- #
- # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
- # for a stable API but we reserve the right to fix issues including modifying the
- # schema if required.
- #
- # Arguments
- # category: [Not documented]
- # cspProjectEntityId: [Not documented]
- # dashboardId: [Not documented]
- # defaultType: [Not documented]
- (
- String!, :
- EntityId, :
- String!, :
- DashboardDefaultType! :
- ): DashboardDefault!
- # UnSet a dashboard as default for a user/organization and category.
- # Only org admin would be able to un-set the ORG_DEFAULT dashboard.
- # PROJECT dashboard can be unset by Project admin or Org admin.
- # USER dashboards can be unset by user owning the dashboard.
- #
- # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
- # for a stable API but we reserve the right to fix issues including modifying the
- # schema if required.
- #
- # Arguments
- # category: [Not documented]
- # cspProjectEntityId: [Not documented]
- # defaultType: [Not documented]
- (
- String!, :
- EntityId, :
- DashboardDefaultType! :
- ): DashboardDefault!
- # Create or update a dashboard.
- # When updating a dashboard dashboardId, nodeVersion, payload and category are
- # required parameters, the other attributes ( dashboardVisibility) are all
- # optional and will be updated if passed.
- # When creating a dashboard dashboardId and nodeVersion are not required, all
- # other attributes (payload, category) are all required.
- # When updating the ORG dashboard,
- # if the user is an admin it should update the dashboard instance.
- # if the user is not an admin a copy of the dashboard should be created with the
- # modifications.
- #
- # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
- # for a stable API but we reserve the right to fix issues including modifying the
- # schema if required.
- #
- # Arguments
- # input: [Not documented]
- DashboardInput!): Dashboard! ( :
- }