AnnouncementSubscriptionCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-announcement-subscription-collection-schema.json",
  "title": "AnnouncementSubscriptionCollection",
  "description": "The results of a search for announcement subscriptions. This object contains both announcement subscription summary objects and other information, such as metadata.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcementsubscription-api-openapi.yml#/components/schemas/AnnouncementSubscriptionCollection",
  "properties": {
    "items": {
      "description": "A list of announcement subscriptions.",
      "items": {
        "$ref": "#/$defs/AnnouncementSubscriptionSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "x-example": "{\n  \"items\": [\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaial3u5l6cvbwelj37dbuxl5fauxv3ux54jbn2mewx3ddna\",\n      \"displayName\": \"announcement-subscription-5\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2023-09-18T22:45:27.948Z\",\n      \"timeUpdated\": \"2023-01-06T23:19:27.948Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleagbx3or53zcvboatv24o5k4yyvnrph2fauxpekkwgovs7ue7mtixa\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiam2cvbefolukref6a3f323ffauxixzktfy37nmjf37nvq\",\n      \"displayName\": \"announcement-subscription-2\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2022-09-18T23:14:05.756Z\",\n      \"timeUpdated\": \"2022-09-18T23:14:05.756Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleay4zq6zpisulo6cvb4hy3cjaljxo2e35fauxkamd7jnwkhalztpkq\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiacfq6oa5cvbt2csvefzddrex4kcoezc2yzekjufauxmha\",\n      \"displayName\": \"announcement-subscription-1\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2022-09-16T23:55:33.329Z\",\n      \"timeUpdated\": \"2023-01-06T23:22:32.956Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleahxrbayxljicvb2hkny3el5gvj7hru3ubqfauxxt3zw3krmgbsh7a\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    }\n  ]\n}\n",
  "$defs": {
    "AnnouncementSubscriptionSummary": {
      "description": "A summary representation of an announcement subscription.",
      "properties": {
        "compartmentId": {
          "description": "The OCID of the compartment that contains the announcement subscription.",
          "type": "string"
        },
        "definedTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type": "object"
          },
          "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
          "type": "object"
        },
        "displayName": {
          "description": "A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n",
          "type": "string"
        },
        "freeformTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
          "type": "object"
        },
        "id": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the announcement subscription.",
          "type": "string"
        },
        "lifecycleDetails": {
          "description": "A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.",
          "type": "string"
        },
        "lifecycleState": {
          "description": "The current lifecycle state of the announcement subscription.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/AnnouncementSubscription/lifecycleState"
        },
        "onsTopicId": {
          "description": "The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.",
          "type": "string"
        },
        "systemTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type": "object"
          },
          "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
          "type": "object"
        },
        "timeCreated": {
          "description": "The date and time that the announcement subscription was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The date and time that the announcement subscription was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "compartmentId",
        "lifecycleState",
        "timeCreated",
        "displayName",
        "freeformTags",
        "definedTags",
        "onsTopicId"
      ],
      "type": "object",
      "x-example": "{\n  \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiacfq6oa5cvbt2csvefzddrex4kcoezc2yzekjufauxmha\",\n  \"displayName\": \"announcement-subscription-1\",\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n  \"timeCreated\": \"2022-09-16T23:55:33.329Z\",\n  \"timeUpdated\": \"2023-01-06T23:22:32.956Z\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails\": null,\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleahxrbayxljicvb2hkny3el5gvj7hru3ubqfauxxt3zw3krmgbsh7a\",\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n"
    }
  }
}