Oracle Announcement API

The announcement API from Oracle — 4 operation(s) for announcement.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-announcement-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Manage Oracle Cloud Infrastructure console announcements.
  title: Announcements Service Announcement API
  version: 0.0.1
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Announcements Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    what: the harvested document for Announcements Service API
servers:
- url: http://127.0.0.1/20180904
- url: https://127.0.0.1/20180904
tags:
- name: announcement
paths:
  /announcements:
    get:
      description: '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.

        '
      operationId: ListAnnouncements
      parameters:
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AnnouncementTypeQueryParam'
      - $ref: '#/components/parameters/AnnouncementLifecycleStateQueryParam'
      - $ref: '#/components/parameters/BannerQueryParam'
      - $ref: '#/components/parameters/SortAnnouncementsByQueryParam'
      - $ref: '#/components/parameters/SortAnnouncementsOrderQueryParam'
      - $ref: '#/components/parameters/TimeOneEarliestTimeQueryParam'
      - $ref: '#/components/parameters/TimeOneLatestTimeQueryParam'
      - $ref: '#/components/parameters/EnvironmentNameQueryParam'
      - $ref: '#/components/parameters/ServiceQueryParam'
      - $ref: '#/components/parameters/PlatformTypeQueryParam'
      - $ref: '#/components/parameters/ExcludeTypesQueryParam'
      - $ref: '#/components/parameters/ShouldShowOnlyLatestInChainQueryParam'
      - $ref: '#/components/parameters/FilterByChainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The list of announcements for the current tenancy.

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For pagination of a list of items. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementsCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists announcements for the tenancy.
      tags:
      - announcement
      x-example: 'GET /20180904/announcements?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: announcements.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /announcements/{announcementId}:
    get:
      description: '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.

        '
      operationId: GetAnnouncement
      parameters:
      - $ref: '#/components/parameters/AnnouncementIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Detailed information for the specified announcement.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Announcement'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets information about an announcement.
      tags:
      - announcement
      x-example: 'GET /20180904/announcements/<var>&lt;announcementId&gt;</var>

        Host: announcements.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /announcements/{announcementId}/compartment:
    get:
      description: 'Gets the compartment details of an announcement.

        '
      operationId: GetAnnouncementCompartment
      parameters:
      - $ref: '#/components/parameters/AnnouncementIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The compartment details of the specified announcement.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementCompartment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the compartment details of an announcement.
      tags:
      - announcement
      x-example: 'GET /20180904/announcements/<var>&lt;announcementId&gt;</var>/compartment

        Host: announcements.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /announcements/{announcementId}/userStatus:
    get:
      description: '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.

        '
      operationId: GetAnnouncementUserStatus
      parameters:
      - $ref: '#/components/parameters/AnnouncementIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The read status of the specified announcement.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementUserStatusDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the read status of an announcement.
      tags:
      - announcement
      x-example: 'GET /20180904/announcements/<var>&lt;announcementId&gt;</var>/userStatus

        Host: announcements.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: '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.

        '
      operationId: UpdateAnnouncementUserStatus
      parameters:
      - $ref: '#/components/parameters/AnnouncementIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The update was successful.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementUserStatusDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the read status of an announcement.
      tags:
      - announcement
      x-example: "PUT /20180904/announcements/<var>&lt;announcementId&gt;</var>\nhost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeAcknowledged\" : \"2019-01-28T23:21:57.342Z\",\n  \"userId\" : \"ocid1.user.region1..exampleaorxz3psplonigcvbzy5oaiwiubh7k7ip6zgklfauxic67kksu4oq\",\n  \"userStatusAnnouncementId\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\"\n}\n"
      x-related-resource: '#/definitions/AnnouncementUserStatusDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnouncementUserStatusDetails'
        description: The information to use to update the announcement's read status.
        required: true
components:
  schemas:
    Property:
      description: 'A generic property that might be associated with the affected resource.

        '
      properties:
        name:
          description: The name of the property.
          type: string
        value:
          description: The value of the property.
          type: string
      required:
      - name
      - value
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    AnnouncementUserStatusDetails:
      description: 'An announcement''s status regarding whether it has been acknowledged by a user.

        '
      properties:
        timeAcknowledged:
          description: 'The date and time the announcement was acknowledged, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-01-01T17:43:01.389+0000`

            '
          format: date-time
          type: string
        userId:
          description: The OCID of the user that this status is associated with.
          maxLength: 255
          minLength: 1
          type: string
        userStatusAnnouncementId:
          description: The OCID of the announcement that this status is associated with.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - userStatusAnnouncementId
      - userId
      type: object
      x-example: "{\n  \"userStatusAnnouncementId\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"userId\" : \"ocid1.user.region1..exampleaorxz3psplonigcvbzy5oaiwiubh7k7ip6zgklfauxic67kksu4oq\",\n  \"timeAcknowledged\" : \"2019-01-28T23:21:57.342Z\"\n}\n"
    BaseAnnouncement:
      description: Incident information that forms the basis of an announcement. Avoid entering confidential information.
      discriminator:
        propertyName: type
      properties:
        affectedRegions:
          description: Impacted regions.
          items:
            type: string
          type: array
        announcementType:
          description: The type of announcement. An announcement's type signals its severity.
          enum:
          - ACTION_RECOMMENDED
          - ACTION_REQUIRED
          - EMERGENCY_CHANGE
          - EMERGENCY_MAINTENANCE
          - EMERGENCY_MAINTENANCE_COMPLETE
          - EMERGENCY_MAINTENANCE_EXTENDED
          - EMERGENCY_MAINTENANCE_RESCHEDULED
          - INFORMATION
          - PLANNED_CHANGE
          - PLANNED_CHANGE_COMPLETE
          - PLANNED_CHANGE_EXTENDED
          - PLANNED_CHANGE_RESCHEDULED
          - PRODUCTION_EVENT_NOTIFICATION
          - SCHEDULED_MAINTENANCE
          type: string
        chainId:
          description: The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.
          type: string
        environmentName:
          description: 'The name of the environment that this announcement pertains to.

            '
          type: string
        id:
          description: The OCID of the announcement.
          maxLength: 255
          minLength: 1
          type: string
        isBanner:
          description: Whether the announcement is displayed as a banner in the console.
          type: boolean
        lifecycleState:
          description: The current lifecycle state of the announcement.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
        platformType:
          description: 'The platform type that this announcement pertains to.

            '
          enum:
          - IAAS
          - SAAS
          - PAAS
          type: string
        referenceTicketNumber:
          description: The reference Jira ticket number.
          type: string
        services:
          description: Impacted Oracle Cloud Infrastructure services.
          items:
            type: string
          type: array
        summary:
          description: 'A summary of the issue. A summary might appear in the console banner view of the announcement or in

            an email subject line. Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: 'The date and time the announcement was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-01-01T17:43:01.389+0000`

            '
          format: date-time
          type: string
        timeOneTitle:
          description: 'The label associated with an initial time value.

            Example: `Time Started`

            '
          type: string
        timeOneType:
          description: 'The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English.

            Example: `START_TIME`

            '
          enum:
          - ACTION_REQUIRED_BY
          - NEW_START_TIME
          - ORIGINAL_END_TIME
          - REPORT_DATE
          - START_TIME
          - TIME_DETECTED
          type: string
        timeOneValue:
          description: 'The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning

            can vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.

            '
          format: date-time
          type: string
        timeTwoTitle:
          description: 'The label associated with a second time value.

            Example: `Time Ended`

            '
          type: string
        timeTwoType:
          description: 'The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English.

            Example: `END_TIME`

            '
          enum:
          - END_TIME
          - NEW_END_TIME
          - ESTIMATED_END_TIME
          type: string
        timeTwoValue:
          description: 'The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning

            can vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the announcement was last updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-01-01T17:43:01.389+0000`

            '
          format: date-time
          type: string
        type:
          description: The entity type, which is either an announcement or the summary representation of an announcement.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - referenceTicketNumber
      - summary
      - description
      - announcementType
      - lifecycleState
      - isBanner
      - type
      - services
      - affectedRegions
      x-example: "{\n  \"type\" : \"Announcement\",\n  \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"referenceTicketNumber\" : \"ANN-123\",\n  \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n  \"timeOneTitle\" : \"Time Started\",\n  \"timeOneType\"  : \"START_TIME\",\n  \"timeOneValue\" : \"2019-01-01T21:00:00.000Z\",\n  \"timeTwoTitle\" : \"Time Ended\",\n  \"timeTwoType \" : \"END_TIME\",\n  \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n  \"services\" : [ \"Compute\" ],\n  \"affectedRegions\" : [ \"us-ashburn-1\" ],\n  \"announcementType\" : \"ACTION_REQUIRED\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"isBanner\" : false,\n  \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n  \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\"\n}\n"
    Announcement:
      allOf:
      - $ref: '#/components/schemas/BaseAnnouncement'
      - discriminator:
          propertyName: Announcement
        properties:
          additionalInformation:
            description: 'Additional information about the event, expressed by using Markdown language and included in the

              details view of an announcement. Additional information might include remediation steps or

              answers to frequently asked questions. Avoid entering confidential information.

              '
            type: string
          affectedResources:
            description: The list of resources, if any, affected by the event described in the announcement.
            items:
              $ref: '#/components/schemas/AffectedResource'
            type: array
          description:
            description: 'A detailed explanation of the event, expressed by using Markdown language. Avoid entering

              confidential information.

              '
            type: string
      description: 'A message about an impactful operational event.

        '
      x-example: "{\n  \"type\" : \"Announcement\",\n  \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"referenceTicketNumber\" : \"ANN-123\",\n  \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n  \"timeOneTitle\" : \"Time Started\",\n  \"timeOneValue\" : \"2019-01-01T21:00:00.000Z\",\n  \"timeTwoTitle\" : \"Time Ended\",\n  \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n  \"services\" : [ \"Compute\" ],\n  \"affectedRegions\" : [ \"us-ashburn-1\" ],\n  \"announcementType\" : \"ACTION_REQUIRED\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"isBanner\" : false,\n  \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n  \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\",\n  \"description\" : \"All versions of Linux OS have been patched for a security vulnerability. However, existing instances deployed prior to January 1, 2019 require customers to apply a patch themselves.\\nReview the list of impacted resources to determine which instances require action.\",\n  \"additionalInformation\" : \"For more information about the vulnerability, see CVE 12345.\",\n  \"followups\" : [ ],\n  \"affectedResources\" : [\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampler2amtptcvblufks3mzzajtwkcxcu4mbjc3fauxwqo6nvpjqr2mb3a\",\n      \"resourceName\" : \"OCIULADMIN\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.examplert3fvrwrmylfhtcvbiyebg4sqiqjytb3iph64v3b6tfauxma5koha\",\n      \"resourceName\" : \"1234567:INTEGRATION:OICDVQSic:wls:vm-1\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampler52l2kcvb6aicisbg4arsedumiwao35p4faux5p5lkuuoq76nenhq\",\n      \"resourceName\" : \"3456789:wtss:QA1234Auto2QSwtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.examplerz7g4b5bcvbnb7txuiek7tjbytffauxypdx4tp4oicxdmwoksiujq\",\n      \"resourceName\" : \"9876543:wtss:Prod4321Auto1wtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampleroww4scvb2zvtnyin6oh5ngd2uuwgg3g5fmnq4w3rszfauxy6diva\",\n      \"resourceName\" : \"7654321:wtss:VBQSwtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    }\n  ]\n}\n"
    AnnouncementSummary:
      allOf:
      - $ref: '#/components/schemas/BaseAnnouncement'
      - discriminator: AnnouncementSummary
      description: 'A summary representation of an announcement.

        '
      x-example: "{\n  \"type\" : \"AnnouncementSummary\",\n  \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"referenceTicketNumber\" : \"ANN-123\",\n  \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n  \"timeOneTitle\" : \"Time Started\",\n  \"timeOneValue\" : \"2019-01-01T21:00:00.000Z\",\n  \"timeTwoTitle\" : \"Time Ended\",\n  \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n  \"services\" : [ \"Compute\" ],\n  \"affectedRegions\" : [ \"us-ashburn-1\" ],\n  \"announcementType\" : \"ACTION_REQUIRED\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"isBanner\" : false,\n  \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n  \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\"\n}\n"
    AnnouncementsCollection:
      description: 'A list of announcements that match filter criteria, if any. Results contain both the announcements and the user-specific status of the announcements.

        '
      properties:
        items:
          description: A collection of announcements.
          items:
            $ref: '#/components/schemas/AnnouncementSummary'
          type: array
        userStatuses:
          description: The user-specific status for found announcements.
          items:
            $ref: '#/components/schemas/AnnouncementUserStatusDetails'
          type: array
      type: object
      x-example: "{\n  \"items\" : [\n    {\n      \"type\" : \"AnnouncementSummary\",\n      \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n      \"referenceTicketNumber\" : \"ANN-123\",\n      \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n      \"timeOneTitle\" : \"Time Started\",\n      \"timeOneValue\" : \"2018-01-01T21:00:00.000Z\",\n      \"timeTwoTitle\" : \"Time Ended\",\n      \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n      \"services\" : [ \"Compute\" ],\n      \"affectedRegions\" : [ \"us-ashburn-1\" ],\n      \"announcementType\" : \"ACTION_REQUIRED\",\n      \"lifecycleState\" : \"ACTIVE\",\n      \"isBanner\" : false,\n      \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n      \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\"\n    },\n    {\n      \"type\" : \"AnnouncementSummary\",\n      \"id\" : \"ocid1.announcement.region1..exampleaphhzyhfzsgfcvbgjm6ardqh6h4xn3cyhc5wfauxdi423cesdm6aq\",\n      \"referenceTicketNumber\" : \"ANN-12345\",\n      \"summary\" : \"Increased latency when using Compute APIs within the us-ashburn-1 region\",\n      \"timeOneTitle\" : \"Time Started\",\n      \"timeOneValue\" : \"2019-01-17T21:45:03.535Z\",\n      \"timeTwoTitle\" : \"Time Ended\",\n      \"timeTwoValue\" : \"2019-01-18T00:45:03.535Z\",\n      \"services\" : [ \"Compute\" ],\n      \"affectedRegions\" : [ \"us-ashburn-1\" ],\n      \"announcementType\" : \"INFORMATION\",\n      \"lifecycleState\" : \"ACTIVE\",\n      \"isBanner\" : false,\n      \"timeCreated\" : \"2018-01-17T23:21:11.378Z\",\n      \"timeUpdated\" : \"2019-01-18T22:46:16.613Z\"\n    },\n    {\n      \"type\" : \"AnnouncementSummary\",\n      \"id\" : \"ocid1.announcement.region1..exampleazf2ztmktv6ls3syed7ecvbaw6z6tiavgkwgmvlfn36faux7c2x7a\",\n      \"referenceTicketNumber\" : \"ANN-54321\",\n      \"summary\" : \"Investigating dropped connections between regions\",\n      \"timeOneTitle\" : \"Time Started\",\n      \"timeOneValue\" : \"2019-01-28T23:17:34.944Z\",\n      \"timeTwoTitle\" : null,\n      \"timeTwoValue\" : null,\n      \"services\" : [ \"Networking\" ],\n      \"affectedRegions\" : [ \"us-ashburn-1\" ],\n      \"announcementType\" : \"PRODUCTION_EVENT_NOTIFICATION\",\n      \"lifecycleState\" : \"ACTIVE\",\n      \"isBanner\" : true,\n      \"timeCreated\" : \"2018-01-29T02:29:06.805Z\",\n      \"timeUpdated\" : \"2018-01-29T02:29:06.805Z\"\n    }\n  ],\n  \"userStatuses\" : [\n    {\n      \"userStatusAnnouncementId\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n      \"userId\" : \"ocid1.user.region1..exampleaorxz3psplonigcvbzy5oaiwiubh7k7ip6zgklfauxic67kksu4oq\",\n      \"timeAcknowledged\" : \"2019-01-17T23:21:57.342Z\"\n    },\n    {\n      \"userStatusAnnouncementId\" : \"ocid1.announcement.region1..exampleaphhzyhfzsgfcvbgjm6ardqh6h4xn3cyhc5wfauxdi423cesdm6aq\",\n      \"userId\" : \"ocid1.user.region1..exampleaorxz3psplonigcvbzy5oaiwiubh7k7ip6zgklfauxic67kksu4oq\",\n      \"timeAcknowledged\" : null\n    },\n    {\n      \"userStatusAnnouncementId\" : \"ocid1.announcement.region1..exampleazf2ztmktv6ls3syed7ecvbaw6z6tiavgkwgmvlfn36faux7c2x7a\",\n      \"userId\" : \"ocid1.user.region1..exampleaorxz3psplonigcvbzy5oaiwiubh7k7ip6zgklfauxic67kksu4oq\",\n      \"timeAcknowledged\" : null\n    }\n  ]\n}\n"
    AffectedResource:
      description: 'The resource affected by the event described in the announcement.

        '
      properties:
        additionalProperties:
          description: Additional properties associated with the resource.
          items:
            $ref: '#/components/schemas/Property'
          type: array
        region:
          description: The region where the affected resource exists.
          type: string
        resourceId:
          description: The OCID of the affected resource.
          maxLength: 255
          minLength: 1
          type: string
        resourceName:
          description: The friendly name of the resource.
          type: string
      required:
      - resourceId
      - resourceName
      - region
      type: object
      x-example: "{\n  \"resourceId\" : \"ocid1.instance.oc1.iad.exampler2amtptcvblufks3mzzajtwkcxcu4mbjc3fauxwqo6nvpjqr2mb3a\",\n  \"resourceName\" : \"OCIULADMIN\",\n  \"region\" : \"us-ashburn-1\"\n}\n"
    AnnouncementCompartment:
      description: Compartment details of an announcement.
      properties:
        compartmentId:
          description: The OCID of the compartment to which the announcement belongs to.
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\"\n}\n"
  parameters:
    TimeOneEarliestTimeQueryParam:
      description: The boundary for the earliest `timeOneValue` date on announcements that you want to see.
      in: query
      name: timeOneEarliestTime
      schema:
        type: string
        format: date-time
    PaginationTokenQueryParam:
      description: The value of the `opc-next-page` response header from the previous "List" call.
      in: query
      name: page
      schema:
        type: string
        maxLength: 3000
        minLength: 1
    SortAnnouncementsOrderQueryParam:
      description: 'The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)

  

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-announcement-api-openapi.yml