Adobe Campaign · JSON Structure

Adobe Campaign Classic Query Definition Structure

SOAP envelope containing a query definition with schema, operation, selected fields, conditions, and pagination parameters.

Type: object Properties: 1
Campaign ManagementCustomer ExperienceEmail MarketingMarketing AutomationMulti-Channel Marketing

QueryDefinition is a JSON Structure definition published by Adobe Campaign, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

queryDef

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/adobe-campaign/refs/heads/main/json-structure/adobe-campaign-classic-query-definition-structure.json",
  "name": "QueryDefinition",
  "description": "SOAP envelope containing a query definition with schema, operation, selected fields, conditions, and pagination parameters.",
  "type": "object",
  "properties": {
    "queryDef": {
      "type": "object",
      "properties": {
        "schema": {
          "type": "string",
          "description": "Target schema name (e.g., nms:recipient, nms:delivery)."
        },
        "operation": {
          "type": "string",
          "enum": [
            "get",
            "getIfExists",
            "select",
            "count"
          ],
          "description": "Query operation type. get returns single record (error if missing), getIfExists returns single or null, select returns multiple records, count returns record count."
        },
        "lineCount": {
          "type": "int32",
          "description": "Maximum number of records to return."
        },
        "startLine": {
          "type": "int32",
          "description": "Starting offset for pagination."
        },
        "select": {
          "type": "object",
          "description": "Field selection using XPath node elements."
        },
        "where": {
          "type": "object",
          "description": "WHERE conditions using condition elements with expr attributes."
        },
        "orderBy": {
          "type": "object",
          "description": "ORDER BY clause with sortNode elements."
        }
      }
    }
  }
}