Oracle Cloud Infrastructure Documentation
Try Free Tier

Management Dashboard Common Types

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_CHANGE_MANAGEMENT_DASHBOARDS_COMPARTMENT_DETAILS_T Type

Compartment to which the dashboard is being moved.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_change_management_dashboards_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_change_management_dashboards_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_change_management_dashboards_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) OCID of the compartment to which the dashboard is being moved.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_CHANGE_MANAGEMENT_SAVED_SEARCHES_COMPARTMENT_DETAILS_T Type

Compartment to which the saved search is being moved.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_change_management_saved_searches_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_change_management_saved_searches_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_change_management_saved_searches_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) OCID of the compartment to which the saved search is being moved.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_JSON_ELEMENT_T_TBL Type

Nested table type of json_element_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_json_element_t_tbl FORCE IS TABLE OF (json_element_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_TILE_DETAILS_T Type

Properties of the dashboard tile representing a saved search. Tiles are laid out in a twelve column grid system with (0,0) at upper left corner.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  saved_search_id varchar2(32767),
  l_row number,
  l_column number,
  height number,
  width number,
  nls json_element_t,
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  state varchar2(32767),
  drilldown_config json_element_t,
  parameters_map json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_t (
    display_name varchar2,
    saved_search_id varchar2,
    l_row number,
    l_column number,
    height number,
    width number,
    nls json_element_t,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    state varchar2,
    drilldown_config json_element_t,
    parameters_map json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Display name of the saved search.

saved_search_id

(required) ID of the saved search.

l_row

(required) Tile's row number.

l_column

(required) Tile's column number.

height

(required) The number of rows the tile occupies.

width

(required) The number of columns the tile occupies.

nls

(required) JSON that contains internationalization options.

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

state

(required) Current state of the saved search.

Allowed values are: 'DELETED', 'UNAUTHORIZED', 'DEFAULT'

drilldown_config

(required) Drill-down configuration to define the destination of a drill-down action.

parameters_map

(optional) Specifies the saved search parameters values

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_TILE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_CREATE_MANAGEMENT_DASHBOARD_DETAILS_T Type

Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_create_management_dashboard_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboard_id varchar2(32767),
  provider_id varchar2(32767),
  provider_name varchar2(32767),
  provider_version varchar2(32767),
  tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_dashboard number,
  is_show_in_home number,
  metadata_version varchar2(32767),
  is_show_description number,
  screen_image varchar2(32767),
  nls json_element_t,
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  l_type varchar2(32767),
  is_favorite number,
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_create_management_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_create_management_dashboard_details_t (
    dashboard_id varchar2,
    provider_id varchar2,
    provider_name varchar2,
    provider_version varchar2,
    tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    is_oob_dashboard number,
    is_show_in_home number,
    metadata_version varchar2,
    is_show_description number,
    screen_image varchar2,
    nls json_element_t,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    l_type varchar2,
    is_favorite number,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboard_id

(optional) ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.

provider_id

(required) ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

tiles

(required) Array of dashboard tiles.

display_name

(required) Display name of the dashboard.

description

(required) Description of the dashboard.

compartment_id

(required) OCID of the compartment in which the dashboard resides.

is_oob_dashboard

(required) Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

is_show_in_home

(required) Determines whether the dashboard will be displayed in Dashboard Home.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

is_show_description

(required) Determines whether the description of the dashboard is displayed.

screen_image

(required) Screen image of the dashboard.

nls

(required) JSON that contains internationalization options.

ui_config

(required) JSON that contains user interface options.

data_config

(required) Array of JSON that contain data source options.

l_type

(required) Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

is_favorite

(required) Determines whether the dashboard is set as favorite.

parameters_config

(optional) Defines parameters for the dashboard.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_CREATE_MANAGEMENT_SAVED_SEARCH_DETAILS_T Type

Properties of a saved search.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_create_management_saved_search_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  provider_id varchar2(32767),
  provider_version varchar2(32767),
  provider_name varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_saved_search number,
  description varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  screen_image varchar2(32767),
  metadata_version varchar2(32767),
  widget_template varchar2(32767),
  widget_vm varchar2(32767),
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_create_management_saved_search_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_create_management_saved_search_details_t (
    id varchar2,
    display_name varchar2,
    provider_id varchar2,
    provider_version varchar2,
    provider_name varchar2,
    compartment_id varchar2,
    is_oob_saved_search number,
    description varchar2,
    nls json_element_t,
    l_type varchar2,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    screen_image varchar2,
    metadata_version varchar2,
    widget_template varchar2,
    widget_vm varchar2,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.

display_name

(required) Display name of the saved search.

provider_id

(required) ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

compartment_id

(required) OCID of the compartment in which the saved search resides.

is_oob_saved_search

(required) Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

description

(required) Description of the saved search.

nls

(required) JSON that contains internationalization options.

l_type

(required) Determines how the saved search is displayed in a dashboard.

Allowed values are: 'SEARCH_SHOW_IN_DASHBOARD', 'SEARCH_DONT_SHOW_IN_DASHBOARD', 'WIDGET_SHOW_IN_DASHBOARD', 'WIDGET_DONT_SHOW_IN_DASHBOARD', 'FILTER_SHOW_IN_DASHBOARD', 'FILTER_DONT_SHOW_IN_DASHBOARD'

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

screen_image

(required) Screen image of the saved search.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

widget_template

(required) The UI template that the saved search uses to render itself.

widget_vm

(required) The View Model that the saved search uses to render itself.

parameters_config

(optional) Defines parameters for the saved search.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_T Type

Properties of a saved search.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  provider_id varchar2(32767),
  provider_version varchar2(32767),
  provider_name varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_saved_search number,
  description varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  created_by varchar2(32767),
  updated_by varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  screen_image varchar2(32767),
  metadata_version varchar2(32767),
  widget_template varchar2(32767),
  widget_vm varchar2(32767),
  lifecycle_state varchar2(32767),
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_t (
    id varchar2,
    display_name varchar2,
    provider_id varchar2,
    provider_version varchar2,
    provider_name varchar2,
    compartment_id varchar2,
    is_oob_saved_search number,
    description varchar2,
    nls json_element_t,
    l_type varchar2,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    created_by varchar2,
    updated_by varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    screen_image varchar2,
    metadata_version varchar2,
    widget_template varchar2,
    widget_vm varchar2,
    lifecycle_state varchar2,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) ID of the saved search.

display_name

(required) Display name of the saved search.

provider_id

(required) ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

provider_version

(required) Version of the service that owns this saved search.

provider_name

(required) Name of the service (for example, Logging Analytics) that owns the saved search.

compartment_id

(required) OCID of the compartment in which the saved search resides.

is_oob_saved_search

(required) Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

description

(required) Description of the saved search.

nls

(required) JSON that contains internationalization options.

l_type

(required) Determines how the saved search is displayed in a dashboard.

Allowed values are: 'SEARCH_SHOW_IN_DASHBOARD', 'SEARCH_DONT_SHOW_IN_DASHBOARD', 'WIDGET_SHOW_IN_DASHBOARD', 'WIDGET_DONT_SHOW_IN_DASHBOARD', 'FILTER_SHOW_IN_DASHBOARD', 'FILTER_DONT_SHOW_IN_DASHBOARD'

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

created_by

(required) The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.

updated_by

(required) The principle id of the user that updated this saved search.

time_created

(required) Date and time the saved search was created.

time_updated

(required) Date and time the saved search was updated.

screen_image

(required) Screen image of the saved search.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

widget_template

(required) The UI template that the saved search uses to render itself.

widget_vm

(required) The View Model that the saved search uses to render itself.

lifecycle_state

(required) OCI lifecycle status. This is automatically managed by the system.

Allowed values are: 'ACTIVE'

parameters_config

(optional) Defines parameters for the saved search.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_saved_search_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_saved_search_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_T Type

Properties of a dashboard, including dashboard ID.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboard_id varchar2(32767),
  id varchar2(32767),
  provider_id varchar2(32767),
  provider_name varchar2(32767),
  provider_version varchar2(32767),
  tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_dashboard number,
  is_show_in_home number,
  created_by varchar2(32767),
  time_created timestamp with time zone,
  updated_by varchar2(32767),
  time_updated timestamp with time zone,
  metadata_version varchar2(32767),
  is_show_description number,
  screen_image varchar2(32767),
  nls json_element_t,
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  l_type varchar2(32767),
  is_favorite number,
  saved_searches dbms_cloud_oci_management_dashboard_management_saved_search_tbl,
  lifecycle_state varchar2(32767),
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_t (
    dashboard_id varchar2,
    id varchar2,
    provider_id varchar2,
    provider_name varchar2,
    provider_version varchar2,
    tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    is_oob_dashboard number,
    is_show_in_home number,
    created_by varchar2,
    time_created timestamp with time zone,
    updated_by varchar2,
    time_updated timestamp with time zone,
    metadata_version varchar2,
    is_show_description number,
    screen_image varchar2,
    nls json_element_t,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    l_type varchar2,
    is_favorite number,
    saved_searches dbms_cloud_oci_management_dashboard_management_saved_search_tbl,
    lifecycle_state varchar2,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboard_id

(required) ID of the dashboard. Same as id.

id

(required) ID of the dashboard. Same as dashboardId.

provider_id

(required) ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

provider_name

(required) Name of the service (for example, Logging Analytics) that owns the dashboard.

provider_version

(required) Version of the service that owns the dashboard.

tiles

(required) Array of dashboard tiles.

display_name

(required) Display name of the dashboard.

description

(required) Description of the dashboard.

compartment_id

(required) OCID of the compartment in which the dashboard resides.

is_oob_dashboard

(required) Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

is_show_in_home

(required) Determines whether the dashboard will be displayed in Dashboard Home.

created_by

(required) User who created the dashboard.

time_created

(required) Date and time the dashboard was created.

updated_by

(required) User who updated the dashboard.

time_updated

(required) Date and time the dashboard was updated.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

is_show_description

(required) Determines whether the description of the dashboard is displayed.

screen_image

(required) Screen image of the dashboard.

nls

(required) JSON that contains internationalization options.

ui_config

(required) JSON that contains user interface options.

data_config

(required) Array of JSON that contain data source options.

l_type

(required) Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

is_favorite

(required) Determines whether the dashboard is set as favorite.

saved_searches

(required) Array of saved searches in the dashboard.

lifecycle_state

(required) State of dashboard.

Allowed values are: 'ACTIVE'

parameters_config

(optional) Defines parameters for the dashboard.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

features_config

(optional) Contains configuration for enabling features.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_SUMMARY_T Type

Summary of the properties of a dashboard.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboard_id varchar2(32767),
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  provider_id varchar2(32767),
  provider_name varchar2(32767),
  provider_version varchar2(32767),
  is_oob_dashboard number,
  created_by varchar2(32767),
  time_created timestamp with time zone,
  updated_by varchar2(32767),
  time_updated timestamp with time zone,
  metadata_version varchar2(32767),
  screen_image varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  features_config json_element_t,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_summary_t (
    dashboard_id varchar2,
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    provider_id varchar2,
    provider_name varchar2,
    provider_version varchar2,
    is_oob_dashboard number,
    created_by varchar2,
    time_created timestamp with time zone,
    updated_by varchar2,
    time_updated timestamp with time zone,
    metadata_version varchar2,
    screen_image varchar2,
    nls json_element_t,
    l_type varchar2,
    features_config json_element_t,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboard_id

(required) ID of the dashboard. Same as id.

id

(required) ID of the dashboard. Same as dashboardId.

display_name

(required) Display name of the dashboard.

description

(required) Description of the dashboard.

compartment_id

(required) OCID of the compartment in which the dashboard resides.

provider_id

(required) ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

is_oob_dashboard

(required) Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

created_by

(required) User who created the dashboard.

time_created

(required) Date and time the dashboard was created.

updated_by

(required) User who updated the dashboard.

time_updated

(required) Date and time the dashboard was updated.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

screen_image

(required) Screen image of the dashboard.

nls

(required) JSON that contains internationalization options.

l_type

(required) Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

features_config

(optional) Contains configuration for enabling features.

lifecycle_state

(required) Current lifecycle state of the dashboard.

Allowed values are: 'ACTIVE'

freeform_tags

(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_dashboard_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_dashboard_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_COLLECTION_T Type

List of dashboards.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_management_dashboard_management_dashboard_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_collection_t (
    items dbms_cloud_oci_management_dashboard_management_dashboard_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) Array of dashboard summaries.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_FOR_IMPORT_DETAILS_T Type

Properties of a saved search.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  provider_id varchar2(32767),
  provider_version varchar2(32767),
  provider_name varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_saved_search number,
  description varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  screen_image varchar2(32767),
  metadata_version varchar2(32767),
  widget_template varchar2(32767),
  widget_vm varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_t (
    id varchar2,
    display_name varchar2,
    provider_id varchar2,
    provider_version varchar2,
    provider_name varchar2,
    compartment_id varchar2,
    is_oob_saved_search number,
    description varchar2,
    nls json_element_t,
    l_type varchar2,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    screen_image varchar2,
    metadata_version varchar2,
    widget_template varchar2,
    widget_vm varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) ID of the saved search.

display_name

(required) Display name of the saved search.

provider_id

(required) ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

compartment_id

(required) OCID of the compartment in which the saved search resides.

is_oob_saved_search

(required) Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

description

(required) Description of the saved search.

nls

(required) JSON that contains internationalization options.

l_type

(required) Determines how the saved search is displayed in a dashboard.

Allowed values are: 'SEARCH_SHOW_IN_DASHBOARD', 'SEARCH_DONT_SHOW_IN_DASHBOARD', 'WIDGET_SHOW_IN_DASHBOARD', 'WIDGET_DONT_SHOW_IN_DASHBOARD', 'FILTER_SHOW_IN_DASHBOARD', 'FILTER_DONT_SHOW_IN_DASHBOARD'

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

screen_image

(required) Screen image of the saved search.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

widget_template

(required) The UI template that the saved search uses to render itself.

widget_vm

(required) The View Model that the saved search uses to render itself.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

parameters_config

(optional) Defines parameters for the saved search.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_FOR_IMPORT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_FOR_IMPORT_EXPORT_DETAILS_T Type

Properties of a dashboard, including dashboard ID and saved searches, for import purposes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboard_id varchar2(32767),
  provider_id varchar2(32767),
  provider_name varchar2(32767),
  provider_version varchar2(32767),
  tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_dashboard number,
  is_show_in_home number,
  metadata_version varchar2(32767),
  is_show_description number,
  screen_image varchar2(32767),
  nls json_element_t,
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  l_type varchar2(32767),
  is_favorite number,
  saved_searches dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_tbl,
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_t (
    dashboard_id varchar2,
    provider_id varchar2,
    provider_name varchar2,
    provider_version varchar2,
    tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    is_oob_dashboard number,
    is_show_in_home number,
    metadata_version varchar2,
    is_show_description number,
    screen_image varchar2,
    nls json_element_t,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    l_type varchar2,
    is_favorite number,
    saved_searches dbms_cloud_oci_management_dashboard_management_saved_search_for_import_details_tbl,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboard_id

(required) ID of the dashboard.

provider_id

(required) ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

tiles

(required) Array of dashboard tiles.

display_name

(required) Display name of the dashboard.

description

(required) Description of the dashboard.

compartment_id

(required) OCID of the compartment in which the dashboard resides.

is_oob_dashboard

(required) Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

is_show_in_home

(required) Determines whether the dashboard will be displayed in Dashboard Home.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

is_show_description

(required) Determines whether the description of the dashboard is displayed.

screen_image

(required) Screen image of the dashboard.

nls

(required) JSON that contains internationalization options.

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

l_type

(required) Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

is_favorite

(required) Determines whether the dashboard is set as favorite.

saved_searches

(required) Array of saved searches in the dashboard.

parameters_config

(optional) Defines parameters for the dashboard.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_FOR_IMPORT_EXPORT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_EXPORT_DETAILS_T Type

Array of dashboards to export. Response from export must be directly acceptable to import (compartmentIds may have to be changed).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_export_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboards dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_export_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_export_details_t (
    dashboards dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboards

(required) Array of dashboards.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_DASHBOARD_IMPORT_DETAILS_T Type

Array of dashboards to import.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_dashboard_import_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboards dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_import_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_dashboard_import_details_t (
    dashboards dbms_cloud_oci_management_dashboard_management_dashboard_for_import_export_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dashboards

(required) Array of dashboards.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_SUMMARY_T Type

Summary of the properties of a saved search.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  is_oob_saved_search number,
  compartment_id varchar2(32767),
  provider_id varchar2(32767),
  provider_version varchar2(32767),
  provider_name varchar2(32767),
  description varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  created_by varchar2(32767),
  updated_by varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  screen_image varchar2(32767),
  metadata_version varchar2(32767),
  widget_template varchar2(32767),
  widget_vm varchar2(32767),
  lifecycle_state varchar2(32767),
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_summary_t (
    id varchar2,
    display_name varchar2,
    is_oob_saved_search number,
    compartment_id varchar2,
    provider_id varchar2,
    provider_version varchar2,
    provider_name varchar2,
    description varchar2,
    nls json_element_t,
    l_type varchar2,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    created_by varchar2,
    updated_by varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    screen_image varchar2,
    metadata_version varchar2,
    widget_template varchar2,
    widget_vm varchar2,
    lifecycle_state varchar2,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) ID of the saved search.

display_name

(required) Display name of the saved search.

is_oob_saved_search

(required) Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

compartment_id

(required) OCID of the compartment in which the saved search resides.

provider_id

(required) ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

provider_version

(required) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

provider_name

(required) The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

description

(required) Description of the saved search.

nls

(required) JSON that contains internationalization options.

l_type

(required) Determines how the saved search is displayed in a dashboard.

Allowed values are: 'SEARCH_SHOW_IN_DASHBOARD', 'SEARCH_DONT_SHOW_IN_DASHBOARD', 'WIDGET_SHOW_IN_DASHBOARD', 'WIDGET_DONT_SHOW_IN_DASHBOARD', 'FILTER_SHOW_IN_DASHBOARD', 'FILTER_DONT_SHOW_IN_DASHBOARD'

ui_config

(required) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(required) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

created_by

(required) The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.

updated_by

(required) The principle id of the user that updated this saved search

time_created

(required) Date and time the saved search was created.

time_updated

(required) Date and time the saved search was updated.

screen_image

(required) Screen image of the saved search.

metadata_version

(required) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

widget_template

(required) The UI template that the saved search uses to render itself.

widget_vm

(required) The View Model that the saved search uses to render itself.

lifecycle_state

(required) OCI lifecycle status. This is automatically managed by the system.

Allowed values are: 'ACTIVE'

parameters_config

(optional) Defines parameters for the saved search.

features_config

(optional) Contains configuration for enabling features.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_management_dashboard_management_saved_search_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_management_dashboard_management_saved_search_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_MANAGEMENT_SAVED_SEARCH_COLLECTION_T Type

List of saved searches.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_management_saved_search_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_management_dashboard_management_saved_search_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_management_saved_search_collection_t (
    items dbms_cloud_oci_management_dashboard_management_saved_search_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) Array of saved search summaries.

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_UPDATE_MANAGEMENT_DASHBOARD_DETAILS_T Type

Properties of a dashboard. Dashboard ID must not be provided.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_update_management_dashboard_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  provider_id varchar2(32767),
  provider_name varchar2(32767),
  provider_version varchar2(32767),
  tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_dashboard number,
  is_show_in_home number,
  metadata_version varchar2(32767),
  is_show_description number,
  screen_image varchar2(32767),
  nls json_element_t,
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  l_type varchar2(32767),
  is_favorite number,
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_update_management_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_update_management_dashboard_details_t (
    provider_id varchar2,
    provider_name varchar2,
    provider_version varchar2,
    tiles dbms_cloud_oci_management_dashboard_management_dashboard_tile_details_tbl,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    is_oob_dashboard number,
    is_show_in_home number,
    metadata_version varchar2,
    is_show_description number,
    screen_image varchar2,
    nls json_element_t,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    l_type varchar2,
    is_favorite number,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

provider_id

(optional) ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

provider_name

(optional) The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

provider_version

(optional) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

tiles

(optional) Array of dashboard tiles.

display_name

(optional) Display name of the dashboard.

description

(optional) Description of the dashboard.

compartment_id

(optional) OCID of the compartment in which the dashboard resides.

is_oob_dashboard

(optional) Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

is_show_in_home

(optional) Determines whether the dashboard will be displayed in Dashboard Home.

metadata_version

(optional) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

is_show_description

(optional) Determines whether the description of the dashboard is displayed.

screen_image

(optional) Screen image of the dashboard.

nls

(optional) JSON that contains internationalization options.

ui_config

(optional) JSON that contains user interface options.

data_config

(optional) Array of JSON that contain data source options.

l_type

(optional) Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

is_favorite

(optional) Determines whether the dashboard is set as favorite.

parameters_config

(optional) Defines parameters for the dashboard.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_MANAGEMENT_DASHBOARD_UPDATE_MANAGEMENT_SAVED_SEARCH_DETAILS_T Type

Properties of a saved search. Saved search ID must not be provided.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_management_dashboard_update_management_saved_search_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  provider_id varchar2(32767),
  provider_version varchar2(32767),
  provider_name varchar2(32767),
  compartment_id varchar2(32767),
  is_oob_saved_search number,
  description varchar2(32767),
  nls json_element_t,
  l_type varchar2(32767),
  ui_config json_element_t,
  data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  screen_image varchar2(32767),
  metadata_version varchar2(32767),
  widget_template varchar2(32767),
  widget_vm varchar2(32767),
  parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  features_config json_element_t,
  drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_update_management_saved_search_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_management_dashboard_update_management_saved_search_details_t (
    display_name varchar2,
    provider_id varchar2,
    provider_version varchar2,
    provider_name varchar2,
    compartment_id varchar2,
    is_oob_saved_search number,
    description varchar2,
    nls json_element_t,
    l_type varchar2,
    ui_config json_element_t,
    data_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    screen_image varchar2,
    metadata_version varchar2,
    widget_template varchar2,
    widget_vm varchar2,
    parameters_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    features_config json_element_t,
    drilldown_config dbms_cloud_oci_management_dashboard_json_element_t_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Display name of the saved search.

provider_id

(optional) ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

provider_version

(optional) The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

provider_name

(optional) The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

compartment_id

(optional) OCID of the compartment in which the saved search resides.

is_oob_saved_search

(optional) Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

description

(optional) Description of the saved search.

nls

(optional) JSON that contains internationalization options.

l_type

(optional) Determines how the saved search is displayed in a dashboard.

Allowed values are: 'SEARCH_SHOW_IN_DASHBOARD', 'SEARCH_DONT_SHOW_IN_DASHBOARD', 'WIDGET_SHOW_IN_DASHBOARD', 'WIDGET_DONT_SHOW_IN_DASHBOARD', 'FILTER_SHOW_IN_DASHBOARD', 'FILTER_DONT_SHOW_IN_DASHBOARD'

ui_config

(optional) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

data_config

(optional) It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

screen_image

(optional) Screen image of the saved search.

metadata_version

(optional) The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

widget_template

(optional) The UI template that the saved search uses to render itself.

widget_vm

(optional) The View Model that the saved search uses to render itself.

parameters_config

(optional) Defines parameters for the saved search.

features_config

(optional) Contains configuration for enabling features.

drilldown_config

(optional) Drill-down configuration to define the destination of a drill-down action.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

Was this article helpful?