Acquia · JSON Structure

Acquia Cloud Ux Message Structure

ux-message schema from Acquia Cloud API

Type: object Properties: 11 Required: 11
ContentExperience

Ux Message is a JSON Structure definition published by Acquia, describing 11 properties, of which 11 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id uuid title body url filters flags weight start_at expire_at _links

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/json-structure/acquia-cloud-ux-message-structure.json",
  "description": "ux-message schema from Acquia Cloud API",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "The message identifier."
    },
    "uuid": {
      "type": "uuid",
      "description": "The message unique identifier."
    },
    "title": {
      "type": "string",
      "description": "The message title."
    },
    "body": {
      "type": "string",
      "description": "The message body.",
      "nullable": true
    },
    "url": {
      "type": "uri",
      "description": "The message url.",
      "nullable": true
    },
    "filters": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-filters"
    },
    "flags": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-flags"
    },
    "weight": {
      "type": "int32",
      "description": "The message priority weight."
    },
    "start_at": {
      "type": "datetime",
      "description": "The UTC timestamp of when the message started."
    },
    "expire_at": {
      "type": "datetime",
      "description": "The UTC timestamp of when the message expires."
    },
    "_links": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_links"
    }
  },
  "required": [
    "id",
    "uuid",
    "title",
    "body",
    "url",
    "filters",
    "flags",
    "weight",
    "start_at",
    "expire_at",
    "_links"
  ],
  "name": "Ux Message"
}