AnnouncementsCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-announcements-collection-schema.json",
  "title": "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.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcement-api-openapi.yml#/components/schemas/AnnouncementsCollection",
  "properties": {
    "items": {
      "description": "A collection of announcements.",
      "items": {
        "$ref": "#/$defs/AnnouncementSummary"
      },
      "type": "array"
    },
    "userStatuses": {
      "description": "The user-specific status for found announcements.",
      "items": {
        "$ref": "#/$defs/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",
  "$defs": {
    "AnnouncementSummary": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseAnnouncement"
        },
        {}
      ],
      "description": "A summary representation of an announcement.\n",
      "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"
    },
    "AnnouncementUserStatusDetails": {
      "description": "An announcement's status regarding whether it has been acknowledged by a user.\n",
      "properties": {
        "timeAcknowledged": {
          "description": "The date and time the announcement was acknowledged, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-01-01T17:43:01.389+0000`\n",
          "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.",
      "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.\n",
          "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.\n",
          "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\nan email subject line. Avoid entering confidential information.\n",
          "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.\nExample: `2019-01-01T17:43:01.389+0000`\n",
          "format": "date-time",
          "type": "string"
        },
        "timeOneTitle": {
          "description": "The label associated with an initial time value.\nExample: `Time Started`\n",
          "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.\nExample: `START_TIME`\n",
          "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\ncan vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.\n",
          "format": "date-time",
          "type": "string"
        },
        "timeTwoTitle": {
          "description": "The label associated with a second time value.\nExample: `Time Ended`\n",
          "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.\nExample: `END_TIME`\n",
          "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\ncan vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.\n",
          "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.\nExample: `2019-01-01T17:43:01.389+0000`\n",
          "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"
    }
  }
}