Oracle Cloud Infrastructure Documentation
Try Free Tier

Dashboard Common Types

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_CHANGE_DASHBOARD_GROUP_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_CHANGE_DASHBOARD_GROUP_DETAILS_T Type

The information to be updated.

Syntax

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

Fields

Field Description

dashboard_group_id

(required) The OCID of the dashboardGroup into which the resource should be moved.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_CREATE_DASHBOARD_DETAILS_T Type

The base schema for creating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_create_dashboard_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dashboard_group_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  schema_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_dashboard_details_t (
    dashboard_group_id varchar2,
    display_name varchar2,
    description varchar2,
    schema_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

dashboard_group_id

(required) The OCID of the dashboard group that the dashbaord is associated with.

display_name

(optional) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(optional) A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

schema_version

(required) The schema describing how to interpret the dashboard configuration and widgets.

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_DASHBOARD_SERVICE_CREATE_DASHBOARD_GROUP_DETAILS_T Type

The data to create a new dashboard group.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_create_dashboard_group_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_dashboard_group_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_dashboard_group_details_t (
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(optional) A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

compartment_id

(required) The OCID of the compartment containing the dashboard group.

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_DASHBOARD_SERVICE_JSON_ELEMENT_T_TBL Type

Nested table type of json_element_t.

Syntax

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

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_CREATE_V1_DASHBOARD_DETAILS_T Type

Details for creating a version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_create_v1_dashboard_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_dashboard_service_create_dashboard_details_t (
  config json_element_t,
  widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_v1_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_create_v1_dashboard_details_t (
    dashboard_group_id varchar2,
    display_name varchar2,
    description varchar2,
    schema_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    config json_element_t,
    widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_dashboard_service_create_v1_dashboard_details_t is a subtype of the dbms_cloud_oci_dashboard_service_create_dashboard_details_t type.

Fields

Field Description

config

(optional) The layout and widget placement for the dashboard.

widgets

(required) The basic visualization building blocks of a dashboard.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_T Type

The base schema for a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  dashboard_group_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  schema_version varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_t (
    id varchar2,
    dashboard_group_id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    schema_version varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

id

(required) The OCID of the dashboard resource.

dashboard_group_id

(required) The OCID of the dashboard group that the dashboard belongs to.

display_name

(required) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(required) A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

compartment_id

(required) The OCID of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.

schema_version

(required) The schema describing how to interpret the dashboard configuration and widgets.

Allowed values are: 'V1'

time_created

(required) The date and time the dashboard was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_updated

(required) The date and time the dashboard was updated, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the dashboard.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

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\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_SUMMARY_T Type

Summary information about the dashboard.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  dashboard_group_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_summary_t (
    id varchar2,
    dashboard_group_id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the dashboard resource.

dashboard_group_id

(required) The OCID of the dashboard group that the dashboard belongs to.

display_name

(required) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(required) A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

compartment_id

(required) The OCID of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.

time_created

(required) The date and time the dashboard was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z

time_updated

(optional) The date and time the dashboard was updated, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the Dashboard.

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\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_dashboard_service_dashboard_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_dashboard_service_dashboard_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_COLLECTION_T Type

Results of a dashboard search. Contains `DashboardSummary` items.

Syntax

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

Fields

Field Description

items

(required) A list of dashboards.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_GROUP_T Type

The base schema for a dashboard group.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_group_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_group_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_group_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the dashboard group.

display_name

(required) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(required) A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

compartment_id

(required) The OCID of the compartment containing the dashboard group.

time_created

(required) The date and time the dashboard group was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_updated

(required) The date and time the dashboard group was updated, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the `DashboardGroup` resource.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

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\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_GROUP_SUMMARY_T Type

Summary information for the dashboard group.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_group_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_group_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_dashboard_group_summary_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the dashboard group.

display_name

(required) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(required) A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

compartment_id

(required) The OCID of the compartment containing the dashboard group.

time_created

(required) The date and time the dashboard group was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_updated

(optional) The date and time the dashboard group was updated, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the `DashboardGroup` resource.

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\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_GROUP_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_dashboard_service_dashboard_group_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_dashboard_group_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_dashboard_service_dashboard_group_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_DASHBOARD_GROUP_COLLECTION_T Type

A list of dashboard groups that match filter criteria, if any. Results contain `DashboardGroupSummary` objects.

Syntax

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

Fields

Field Description

items

(required) A list of dashboard groups.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_ERROR_T Type

Details about erros encountered.

Syntax

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

Fields

Field Description

code

(required) A machine-usable code for the error that occured.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_UPDATE_DASHBOARD_DETAILS_T Type

The base schema for updating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_update_dashboard_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  schema_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_dashboard_details_t (
    display_name varchar2,
    description varchar2,
    schema_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

display_name

(optional) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(optional) A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

schema_version

(required) The schema describing how to interpret the dashboard configuration and widgets.

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_DASHBOARD_SERVICE_UPDATE_DASHBOARD_GROUP_DETAILS_T Type

The data to update a dashboard group.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_update_dashboard_group_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_dashboard_group_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_dashboard_group_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'\"&\\

description

(optional) A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'\"&\\

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_DASHBOARD_SERVICE_UPDATE_V1_DASHBOARD_DETAILS_T Type

Details for updating a version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_update_v1_dashboard_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_dashboard_service_update_dashboard_details_t (
  config json_element_t,
  widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_v1_dashboard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_update_v1_dashboard_details_t (
    display_name varchar2,
    description varchar2,
    schema_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    config json_element_t,
    widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_dashboard_service_update_v1_dashboard_details_t is a subtype of the dbms_cloud_oci_dashboard_service_update_dashboard_details_t type.

Fields

Field Description

config

(optional) The layout and widget placement for the dashboard.

widgets

(optional) The basic visualization building blocks of a dashboard.

DBMS_CLOUD_OCI_DASHBOARD_SERVICE_V1_DASHBOARD_T Type

A version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_dashboard_service_v1_dashboard_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_dashboard_service_dashboard_t (
  config json_element_t,
  widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_v1_dashboard_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_dashboard_service_v1_dashboard_t (
    id varchar2,
    dashboard_group_id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    schema_version varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    config json_element_t,
    widgets dbms_cloud_oci_dashboard_service_json_element_t_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_dashboard_service_v1_dashboard_t is a subtype of the dbms_cloud_oci_dashboard_service_dashboard_t type.

Fields

Field Description

config

(optional) The dashboard configuration. For example, the layout and widget placement.

widgets

(required) The visualization building blocks of the dashboard.

Was this article helpful?