Oracle Cloud Infrastructure Documentation
Try Free Tier

Announcement Functions

Package: DBMS_CLOUD_OCI_AS_ANNOUNCEMENT

GET_ANNOUNCEMENT Function

Gets the details of a specific announcement. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION get_announcement (
  announcement_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_as_announcement_get_announcement_response_t;

Parameters

Parameter Description

announcement_id

(required) The OCID of the announcement.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://announcements.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ANNOUNCEMENT_USER_STATUS Function

Gets information about whether a specific announcement was acknowledged by a user. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION get_announcement_user_status (
  announcement_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_as_announcement_get_announcement_user_status_response_t;

Parameters

Parameter Description

announcement_id

(required) The OCID of the announcement.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://announcements.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ANNOUNCEMENTS Function

Gets a list of announcements for the current tenancy. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION list_announcements (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  announcement_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  is_banner number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  time_one_earliest_time timestamp with time zone DEFAULT NULL,
  time_one_latest_time timestamp with time zone DEFAULT NULL,
  environment_name varchar2 DEFAULT NULL,
  service varchar2 DEFAULT NULL,
  platform_type varchar2 DEFAULT NULL,
  exclude_announcement_types dbms_cloud_oci_announcements_service_varchar2_tbl DEFAULT NULL,
  should_show_only_latest_in_chain number DEFAULT NULL,
  chain_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_as_announcement_list_announcements_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

limit

(optional) The maximum number of items to return in a paginated \"List\" call.

page

(optional) The value of the `opc-next-page` response header from the previous \"List\" call.

announcement_type

(optional) The type of announcement.

lifecycle_state

(optional) The announcement's current lifecycle state.

Allowed values are: 'ACTIVE', 'INACTIVE'

is_banner

(optional) Whether the announcement is displayed as a console banner.

sort_by

(optional) The criteria to sort by. You can specify only one sort order.

Allowed values are: 'timeOneValue', 'timeTwoValue', 'timeCreated', 'referenceTicketNumber', 'summary', 'announcementType'

sort_order

(optional) The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)

Allowed values are: 'ASC', 'DESC'

time_one_earliest_time

(optional) The boundary for the earliest `timeOneValue` date on announcements that you want to see.

time_one_latest_time

(optional) The boundary for the latest `timeOneValue` date on announcements that you want to see.

environment_name

(optional) A filter to return only announcements that match a specific environment name.

service

(optional) A filter to return only announcements affecting a specific service.

platform_type

(optional) A filter to return only announcements affecting a specific platform.

Allowed values are: 'IAAS', 'SAAS'

exclude_announcement_types

(optional) Exclude The type of announcement.

should_show_only_latest_in_chain

(optional) A filter to display only the latest announcement in a chain.

chain_id

(optional) A filter to return only announcements belonging to the specified announcement chain ID.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://announcements.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ANNOUNCEMENT_USER_STATUS Function

Updates the status of the specified announcement with regard to whether it has been marked as read. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION update_announcement_user_status (
  announcement_id varchar2,
  status_details dbms_cloud_oci_announcements_service_announcement_user_status_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_as_announcement_update_announcement_user_status_response_t;

Parameters

Parameter Description

announcement_id

(required) The OCID of the announcement.

status_details

(required) The information to use to update the announcement's read status.

if_match

(optional) The locking version, used for optimistic concurrency control.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://announcements.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

Was this article helpful?