{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-create-announcement-subscription-details-schema.json",
  "title": "CreateAnnouncementSubscriptionDetails",
  "description": "The details for creating a new announcement subscription.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcementsubscription-api-openapi.yml#/components/schemas/CreateAnnouncementSubscriptionDetails",
  "properties": {
    "compartmentId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the announcement subscription.\n",
      "maxLength": 255,
      "minLength": 1,
      "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.",
      "maxLength": 400,
      "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.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "filterGroups": {
      "additionalProperties": {
        "$ref": "#/$defs/FilterGroupDetails"
      },
      "description": "A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies 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"
    },
    "onsTopicId": {
      "description": "The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see [Details for Notifications](/Content/Identity/policyreference/notificationpolicyreference.htm).\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"
    }
  },
  "required": [
    "compartmentId",
    "displayName",
    "onsTopicId"
  ],
  "type": "object",
  "x-example": "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"definedTags\": {},\n  \"description\": \"announcements for Brazil region required and recommended actions\",\n  \"displayName\": \"subscription-brazilactions\",\n  \"filterGroups\": {\n    \"filterbybrazilactions\": {\n      \"filters\": [\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil East (Sao Paulo)\"\n        },\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil Southeast (Vinhedo)\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_RECOMMENDED\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_REQUIRED\"\n        }\n      ]\n    }\n  }\n  \"freeformTags\": {},\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.examplea4s4glpxfc22s7tmcvbitc7yiyjpft2faux3yb2oya2hihkyzieia\"\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"
    },
    "FilterGroupDetails": {
      "description": "The details of a group of filters to match announcements against. A filter group combines one or more individual filters.",
      "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"
        }
      },
      "required": [
        "filters"
      ],
      "type": "object",
      "x-example": "{\n  \"name\": \"filterbyiaasus\",\n  \"filters\": [\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US East (Ashburn)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (Phoenix)\"\n    },\n    {\n      \"type\": \"PLATFORM_TYPE\",\n      \"value\": \"IAAS\"\n  ]\n}\n"
    }
  }
}