{
  "openapi": "3.0.1",
  "info": {
    "title": "Marketing Contents",
    "description": "Create and administer marketing contents",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Marketing Contents",
      "description": "Create and administer marketing contents."
    }
  ],
  "paths": {
    "/marketing-contents": {
      "get": {
        "summary": "Get the marketing contents in a store.",
        "operationId": "getMarketingContents",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-builder-class": "com.ibm.commerce.rest.admin.v2.marketing.MarketingContentExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "searchString",
            "description": "Limits search results to only include marketing contents with a name that matches the value of this parameter.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "description": "The offset.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/recordSetStartNumber",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "description": "The limit.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/maxItems",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentCollection"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a marketing content.",
        "operationId": "createMarketingContent",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "processMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ProcessMarketingContentType",
        "x-action-code": "Add",
        "x-expression-template": "/MarketingContent[1]",
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/externalIdentifier/storeIdentifier/uniqueID",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MarketingContent"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "headers": {
              "Location": {
                "description": "The URI of the content.",
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/{id}": {
      "get": {
        "summary": "Get a marketing content.",
        "operationId": "getMarketingContent",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-template": "{_wcf.ap={accessProfile};_wcf.dataLanguageIds={dataLanguageIds}}/MarketingContent[MarketingContentIdentifier[(UniqueID='{id}')]]",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "parameters": [
          {
            "name": "id",
            "description": "The content ID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "dataLanguageIds",
            "description": "The data language IDs.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent[1]",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContent"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update a marketing content.",
        "operationId": "updateMarketingContent",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Change",
        "x-expression-template": "/MarketingContent[1]",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MarketingContent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation is successful."
          }
        }
      },
      "delete": {
        "summary": "Delete a marketing content.",
        "operationId": "deleteMarketingContent",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "processMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ProcessMarketingContentType",
        "x-action-code": "Delete",
        "x-expression-template": "/MarketingContent[1]",
        "parameters": [
          {
            "name": "id",
            "description": "The content ID.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful."
          }
        }
      }
    },
    "/marketing-contents/by-ids": {
      "get": {
        "summary": "Get marketing contents by IDs.",
        "operationId": "getMarketingContentByIds",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-template": "{_wcf.ap={accessProfile}}/MarketingContent[MarketingContentIdentifier[(UniqueID='{id}')]]",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID(s) for identifying the marketing content.  One or more id NVPs can be specified.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "description": "The offset.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/recordSetStartNumber",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "description": "The limit.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/maxItems",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentCollection"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/by-name-or-description": {
      "get": {
        "summary": "Search for marketing contents by name or description.",
        "operationId": "getMarketingContentsByNameOrDescription",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "x-parameters": {
          "template": "/MarketingContent[search(MarketingContentIdentifier/ExternalIdentifier/Name='$searchText$' or MarketingContentDescription/MarketingText='$searchText$')]",
          "accessProfile": "IBM_Admin_Summary"
        },
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "searchText",
            "description": "The name or description pattern to search.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "description": "The offset.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/recordSetStartNumber",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "description": "The limit.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/maxItems",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentCollection"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/by-name-and-type": {
      "get": {
        "summary": "Search for marketing contents by name and content type.",
        "operationId": "getMarketingContentsByNameAndType",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "x-parameters": {
          "template": "/MarketingContent[MarketingContentFormat[UniqueID=$contentTypeId$] and search(MarketingContentIdentifier/ExternalIdentifier/Name='$searchText$' or MarketingContentDescription/MarketingText='$searchText$')]",
          "accessProfile": "IBM_Admin_Summary"
        },
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "searchText",
            "description": "The name or description pattern to search.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contentTypeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                1,
                2,
                5
              ]
            },
            "description": "Specify the type id of marketing content:\n * '1' - Asset\n * '2' - Text for store page dispaly\n * '5' - text message for mobile device\n"
          },
          {
            "name": "offset",
            "description": "The offset.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/recordSetStartNumber",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "description": "The limit.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/maxItems",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentCollection"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/by-attachment-id": {
      "get": {
        "summary": "Search for marketing contents by attachment.",
        "operationId": "getMarketingContentsByAttachmentId",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "x-expression-template": "{_wcf.ap={accessProfile};_wcf.dataLanguageIds={dataLanguageIds}}/MarketingContent[Attachment[AttachmentIdentifier[(UniqueID='{attachmentId}')]]]",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "attachmentId",
            "description": "The unique numeric ID for identifying the attachment.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dataLanguageIds",
            "description": "The data language IDs.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "description": "The offset.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/recordSetStartNumber",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "description": "The limit.",
            "in": "query",
            "required": false,
            "x-entity-path": "dataArea/get/maxItems",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentCollection"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/{id}/descriptions": {
      "post": {
        "summary": "Add a new description to a marketing content.",
        "operationId": "createMarketingContentDescription",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Add",
        "x-expression-template": "/MarketingContent[1]/MarketingContentDescription[1]",
        "x-request-verb": "change",
        "x-response-verb": "respond",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]/marketingContentDescription[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MarketingContentDescription"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent/marketingContentDescription[1]/language",
            "headers": {
              "Location": {
                "description": "The URI of the marketing content description.",
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/{id}/descriptions/{languageId}": {
      "get": {
        "summary": "Get the language specific description of a marketing content.",
        "operationId": "getMarketingContentDescription",
        "tags": [
          "Marketing Contents"
        ],
        "x-expression-template": "{_wcf.ap='IBM_Admin_Details';_wcf.dataLanguageIds='{languageId}'}/MarketingContent[MarketingContentIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "getMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.GetMarketingContentType",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-context-data": "uniqueId",
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "description": "The integer for identifying the language of the marketing content description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentDescription[1]",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingContentDescription"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update the language specific description of a marketing content.",
        "operationId": "updateMarketingContentDescription",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Change",
        "x-expression-template": "/MarketingContent[1]/MarketingContentDescription[1]",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "description": "The langauge ID of the marketing content description.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentDescription[1]/language",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]/marketingContentDescription[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MarketingContentDescription"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation is successful."
          }
        }
      }
    },
    "/marketing-contents/{id}/image-map-areas": {
      "post": {
        "summary": "Add a new image map area to a marketing content.",
        "operationId": "createMarketingContentImageMapArea",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Add",
        "x-expression-template": "/MarketingContent[1]/MarketingContentImageMap[1]/Area[1]",
        "x-request-verb": "change",
        "x-response-verb": "respond",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "languageId",
            "description": "The integer for identifying the language of the marketing content image map. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentImageMap/language"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]/marketingContentImageMap[1]/area[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Area"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/marketingContent/marketingContentImageMap[1]/area[1]/uniqueID",
            "headers": {
              "Location": {
                "description": "The URI of the image map area.",
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/marketing-contents/{id}/image-map-areas/{areaId}": {
      "patch": {
        "summary": "Update an image map area of a marketing content.",
        "operationId": "updateMarketingContentImageMapArea",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Change",
        "x-expression-template": "/MarketingContent[1]/MarketingContentImageMap[1]/Area[1]",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "areaId",
            "description": "The unique numeric ID for identifying the image map area.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentImageMap[1]/area[1]/uniqueID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "required": true,
          "x-entity-path": "dataArea/marketingContent[1]/marketingContentImageMap[1]/area[1]",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Area"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation is successful."
          }
        }
      },
      "delete": {
        "summary": "Delete an image map area of a marketing content.",
        "operationId": "deleteMarketingContentImageMapArea",
        "tags": [
          "Marketing Contents"
        ],
        "x-facade-client-class": "com.ibm.commerce.marketing.facade.client.MarketingFacadeClient",
        "x-facade-client-method": "changeMarketingContent",
        "x-request-bod-class": "com.ibm.commerce.marketing.facade.datatypes.ChangeMarketingContentType",
        "x-action-code": "Delete",
        "x-expression-template": "/MarketingContent[1]/MarketingContentImageMap[1]/Area[1]",
        "x-request-verb": "change",
        "parameters": [
          {
            "name": "id",
            "description": "The unique numeric ID for identifying the marketing content.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "areaId",
            "description": "The unique numeric ID for identifying the image map area.",
            "in": "path",
            "required": true,
            "x-entity-path": "dataArea/marketingContent[1]/marketingContentImageMap[1]/area[1]/uniqueID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MarketingContentCollection": {
        "description": "A collection of marketing contents.",
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MarketingContent"
            }
          }
        }
      },
      "MarketingContent": {
        "description": "A marketing content.",
        "type": "object",
        "x-entity-class": "com.ibm.commerce.marketing.facade.datatypes.MarketingContentType",
        "x-entity-paths": {
          "attachmentReference": "attachment"
        },
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the marketing content.",
            "x-entity-path": "marketingContentIdentifier/uniqueID"
          },
          "storeId": {
            "type": "integer",
            "format": "int32",
            "description": "The ID of the store to which the marketing content belongs.",
            "x-entity-path": "marketingContentIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          },
          "name": {
            "type": "string",
            "description": "The name of the marketing content.",
            "x-entity-path": "marketingContentIdentifier/externalIdentifier/name"
          },
          "descriptions": {
            "type": "array",
            "description": "The descriptions of the marketing content.",
            "x-entity-path": "marketingContentDescription",
            "items": {
              "$ref": "#/components/schemas/MarketingContentDescription"
            }
          },
          "contentType": {
            "type": "string",
            "enum": [
              "File",
              "Text",
              "Sms"
            ],
            "description": "The type of marketing content:\n * 'File' - Asset\n * 'Text' - Text for store page dispaly\n * 'Sms' - Text message for mobile device\n",
            "x-entity-path": "marketingContentFormat/name"
          },
          "contentTypeId": {
            "type": "string",
            "enum": [
              1,
              2,
              5
            ],
            "description": "The type id of marketing content:\n * '1' - Asset\n * '2' - Text for store page dispaly\n * '5' - Text message for mobile device\n",
            "x-entity-path": "marketingContentFormat/uniqueID"
          },
          "clickAction": {
            "type": "string",
            "enum": [
              "None",
              "Single",
              "Multiple"
            ],
            "description": "Specify the number of click actions supported by the marketing content:\n * 'None' - No URL defined for the marketing content.\n * 'Single' - Whole marketing content is mapped to one single URL.\n * 'Multiple' - A HTML image map is defined for the marketing content. The image map has multiple areas, each has its own URL.\n"
          },
          "url": {
            "type": "string",
            "description": "The click action (URL) to be invoked when the marketing content on the page is clicked."
          },
          "inputOption": {
            "type": "string",
            "enum": [
              "Area",
              "Source"
            ],
            "description": "Specify the method for defining the image map: * 'Area' - Define each area in the image map individually. * 'Source' - Include the HTML source code to define the entire image map.\n"
          },
          "imageMaps": {
            "type": "array",
            "description": "The image map information that are used in the store front pages.",
            "x-entity-path": "marketingContentImageMap",
            "items": {
              "$ref": "#/components/schemas/MarketingContentImageMap"
            }
          },
          "attachmentId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the attachment.",
            "x-entity-path": "attachment/attachmentIdentifier/uniqueID"
          },
          "attachmentIdentifier": {
            "type": "string",
            "description": "The unique string identifier for identifying the attachment within the context of a particular store.",
            "x-entity-path": "attachment/attachmentIdentifier/externalIdentifier/identifier"
          },
          "attachmentStoreId": {
            "type": "integer",
            "format": "int32",
            "description": "The unique numeric ID for identifying the store which owns the attachment.",
            "x-entity-path": "attachment/attachmentIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          },
          "attachmentReferenceId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the attachment reference.",
            "x-entity-path": "attachment/attachmentReferenceIdentifier/uniqueID"
          },
          "behavior": {
            "type": "string",
            "enum": [
              0,
              1
            ],
            "description": "Specify the behavior of the marketing content in marketing spot. The associated e-Marketing Spot can use this setting to determine how to cache the e-Marketing Spot results.\n * '0' - The marketing content is static, whcih means it displays the same results to all customers.\n * '1' - The marketing content has dynamic behavior that can display different results.\n",
            "x-entity-path": "marketingSpotBehavior"
          },
          "ignoreAssetSizeLimit": {
            "type": "string",
            "enum": [
              0,
              1
            ],
            "description": "Indicates if allowing marketing content to display when associated asset file is larger than the maximum file size limit. Default value is \"1\".\n * '0' - No\n * '1' - Yes\n",
            "x-entity-path": "ovrMktLimit"
          }
        }
      },
      "MarketingContentDescription": {
        "description": "An description of a marketing content.",
        "type": "object",
        "x-entity-class": "com.ibm.commerce.marketing.facade.datatypes.MarketingContentDescriptionType",
        "properties": {
          "marketingText": {
            "type": "string",
            "description": "The marketing text of the marketing content. It describes the marketing objective intended by the marketing campaign."
          },
          "languageId": {
            "type": "integer",
            "format": "int32",
            "description": "The language for this marketing content description.",
            "x-entity-path": "language"
          },
          "location": {
            "type": "string",
            "description": "The full image path of the marketing content in the Web application."
          }
        }
      },
      "MarketingContentImageMap": {
        "description": "The marketing contant image map information that are used in the store front pages.",
        "type": "object",
        "x-entity-class": "com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the image map."
          },
          "source": {
            "type": "string",
            "description": "The HTML definition of the image map."
          },
          "areas": {
            "type": "array",
            "description": "The image map areas.",
            "x-entity-path": "area",
            "items": {
              "$ref": "#/components/schemas/Area"
            }
          },
          "languageId": {
            "type": "integer",
            "format": "int32",
            "description": "The language for this marketing content image map.",
            "x-entity-path": "language"
          }
        }
      },
      "Area": {
        "description": "An area in the image map.",
        "type": "object",
        "x-entity-class": "com.ibm.commerce.marketing.facade.datatypes.AreaType",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the area.",
            "x-entity-path": "uniqueID"
          },
          "shape": {
            "type": "string",
            "enum": [
              "rect",
              "circle",
              "poly"
            ],
            "description": "Specify the shape of the image map area:\n * 'rect' - Rectangle\n * 'circle' - Circle\n * 'poly' - Polygon\n"
          },
          "coordinates": {
            "type": "string",
            "description": "The coordinate of the image map. For example, \"10,20,62,126\""
          },
          "url": {
            "type": "string",
            "description": "The link to the image."
          },
          "title": {
            "type": "string",
            "description": "The title of the image map."
          },
          "alternateText": {
            "type": "string",
            "description": "An alternate text for the image map."
          },
          "target": {
            "type": "string",
            "description": "Specify where to open the target URL. For example, _blank, _parent, _self, _top, and the frame name."
          },
          "sequence": {
            "type": "number",
            "format": "double",
            "description": "The sequence of the area.",
            "x-entity-path": "displaySequence"
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}