AnnouncementSubscription

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-announcement-subscription-schema.json",
  "title": "AnnouncementSubscription",
  "description": "A subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcementsubscription-api-openapi.yml#/components/schemas/AnnouncementSubscription",
  "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"
    },
    "description": {
      "description": "A description of the announcement subscription. Avoid entering confidential information.",
      "type": "string"
    },
    "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"
    },
    "filterGroups": {
      "additionalProperties": {
        "$ref": "#/$defs/FilterGroup"
      },
      "description": "A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.\n",
      "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.\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.\n",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current lifecycle state of the announcement subscription.",
      "enum": [
        "ACTIVE",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "onsTopicId": {
      "description": "The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.\n",
      "type": "string"
    },
    "preferredLanguage": {
      "default": "en-US",
      "description": "(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.",
      "format": "x-obmcs-human-language",
      "type": "string"
    },
    "preferredTimeZone": {
      "default": "UTC",
      "description": "The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles",
      "format": "x-obmcs-time-zone",
      "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.exampleaqisx3ryazu44rhjcvbwasbdkv3tmurqkqri6yd3p6wzfauxdqmqa\",\n  \"displayName\": \"actionrequired-subscription\",\n  \"description\": \"subscription for required actions\",\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"timeCreated\": \"2022-03-01T23:55:57.672Z\",\n  \"timeUpdated\": \"2022-03-01T23:55:57.672Z\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails\": null,\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleac37suzoqdnp3hg3jmopb32zcvbitupvwvovlufauxsirkjveeqsa\",\n  \"filterGroups\": {\n    \"filterbytype\": {\n      \"name\": \"filterbytype\",\n      \"filters\": [\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_REQUIRED\"\n        }\n      ]\n    }\n  },\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n",
  "$defs": {
    "Filter": {
      "description": "Criteria that the Announcements service uses to match announcements so it can provide only desired announcements to subscribers.",
      "properties": {
        "type": {
          "description": "The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.",
          "enum": [
            "COMPARTMENT_ID",
            "PLATFORM_TYPE",
            "REGION",
            "SERVICE",
            "RESOURCE_ID",
            "ANNOUNCEMENT_TYPE"
          ],
          "type": "string"
        },
        "value": {
          "description": "The value of the filter.",
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "type": "object",
      "x-example": "{\n  \"type\": \"ANNOUNCEMENT_TYPE\",\n  \"value\": \"ACTION_REQUIRED\"\n}\n"
    },
    "FilterGroup": {
      "description": "A group of filters to match announcements against.",
      "properties": {
        "filters": {
          "description": "A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.",
          "items": {
            "$ref": "#/$defs/Filter"
          },
          "type": "array"
        },
        "name": {
          "description": "The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.",
          "type": "string"
        }
      },
      "required": [
        "name",
        "filters"
      ],
      "type": "object",
      "x-example": "{\n  \"name\": \"filterbycomputeactions\",\n    \"filters\": [\n      {\n        \"type\": \"ANNOUNCEMENT_TYPE\",\n        \"value\": \"ACTION_REQUIRED\"\n      },\n      {\n        \"type\": \"ANNOUNCEMENT_TYPE\",\n        \"value\": \"ACTION_RECOMMENDED\"\n      },\n      {\n        \"type\": \"SERVICE\",\n        \"value\": \"Oracle Cloud Infrastructure Compute\"\n      }\n    ]\n}\n"
    }
  }
}