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=<compartmentId> Host: announcements.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /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/<announcementId> Host: announcements.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /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/<announcementId>/compartment Host: announcements.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /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/<announcementId>/userStatus Host: announcements.us-ashburn-1.oraclecloud.com <authorization and other headers> ' 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/<announcementId>\nhost: announcements.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\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.) ' in: query name: sortOrder schema: type: string enum: - ASC - DESC ExcludeTypesQueryParam: description: Exclude The type of announcement. in: query name: excludeAnnouncementTypes schema: type: array items: maxLength: 64 minLength: 1 type: string CompartmentIdQueryParam: description: 'The OCID of the compartment. ' in: query name: compartmentId required: true schema: type: string maxLength: 512 minLength: 1 IfMatchHeader: description: The locking version, used for optimistic concurrency control. in: header name: if-match schema: type: string PlatformTypeQueryParam: description: A filter to return only announcements affecting a specific platform. in: query name: platformType x-default-description: No default value for PlatformType schema: type: string enum: - IAAS - SAAS - PAAS maxLength: 64 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return in a paginated "List" call. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 BannerQueryParam: description: Whether the announcement is displayed as a console banner. in: query name: isBanner schema: type: boolean FilterByChainIdQueryParam: description: A filter to return only announcements belonging to the specified announcement chain ID. in: query name: chainId schema: type: string ServiceQueryParam: description: A filter to return only announcements affecting a specific service. in: query name: service schema: type: string maxLength: 256 minLength: 1 ShouldShowOnlyLatestInChainQueryParam: description: A filter to display only the latest announcement in a chain. in: query name: shouldShowOnlyLatestInChain schema: type: boolean default: false AnnouncementIdPathParam: description: The OCID of the announcement. in: path name: announcementId required: true schema: type: string TimeOneLatestTimeQueryParam: description: The boundary for the latest `timeOneValue` date on announcements that you want to see. in: query name: timeOneLatestTime schema: type: string format: date-time SortAnnouncementsByQueryParam: description: 'The criteria to sort by. You can specify only one sort order. ' in: query name: sortBy schema: type: string enum: - timeOneValue - timeTwoValue - timeCreated - referenceTicketNumber - summary - announcementType AnnouncementTypeQueryParam: description: The type of announcement. in: query name: announcementType schema: type: string maxLength: 64 minLength: 1 AnnouncementLifecycleStateQueryParam: description: The announcement's current lifecycle state. in: query name: lifecycleState schema: type: string enum: - ACTIVE - INACTIVE EnvironmentNameQueryParam: description: A filter to return only announcements that match a specific environment name. in: query name: environmentName schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID. ' in: header name: opc-request-id schema: type: string responses: default: description: Unknown Error headers: 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/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string 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. ' 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. ' 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. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: false x-oracle-package: com.oracle.pic.announcements.announcements-api