Method: legacySoarDashboard.legacyImportDashboard

Full name: projects.locations.instances.legacySoarDashboard.legacyImportDashboard

Imports a dashboard from a file.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to import the dashboard for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "id": string,
  "creator": string,
  "name": string,
  "defaultTimeRange": enum (DashboardTimeRangeTypesEnums),
  "allowedUsersJson": string,
  "allowedUsers": [
    string
  ],
  "widgets": [
    {
      object (LegacySoarDashboardWidgetDataModel)
    }
  ],
  "environmentsJson": string,
  "environments": [
    string
  ],
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string
}
Fields
id

string (int64 format)

Optional. The ID of the dashboard.
creator

string

Optional. The creator of the dashboard.
name

string

Optional. The name of the dashboard.
defaultTimeRange

enum (DashboardTimeRangeTypesEnums)

Optional. The default time range of the dashboard.
allowedUsersJson

string

Optional. The allowed users of the dashboard.
allowedUsers[]

string

Optional. The allowed users of the dashboard.
widgets[]

object (LegacySoarDashboardWidgetDataModel)

Optional. The widgets of the dashboard.
environmentsJson

string

Optional. The environments of the dashboard.
environments[]

string

Optional. The environments of the dashboard.
creationTimeUnixTimeInMs

string (int64 format)

Optional. The creation time of the dashboard in Unix time in milliseconds.
modificationTimeUnixTimeInMs

string (int64 format)

Optional. The modification time of the dashboard in Unix time in milliseconds.

Response body

ImportLegacySoarDashboardResponse represents the response for importing a dashboard.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": {
    object (LegacySoarDashboardDataModel)
  }
}
Fields
payload

object (LegacySoarDashboardDataModel)

Optional. The data model of the dashboard.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.