swagger: '2.0'
info:
  title: Attachment REST APIs
  version: '2.0'
paths:
  /attachments:
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          format: int32
          in: query
          name: offset
          required: false
          type: integer
          x-entity-path: dataArea/get/recordSetStartNumber
        - description: The maximum number of records to return.
          format: int32
          in: query
          name: limit
          required: false
          type: integer
          x-entity-path: dataArea/get/maxItems
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentCollection'
          x-entity-path: dataArea/attachment
      summary: Get all attachments.
      x-expression-template: '{_wcf.ap=IBM_Admin_Summary}/Attachment'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
    post:
      consumes:
        - application/json
      parameters:
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/Attachment'
          x-entity-path: 'dataArea/attachment[1]'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment.
              type: string
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
      summary: Create an attachment.
      x-action-code: Add
      x-expression-template: '/Attachment[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: processAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PostBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ProcessAttachmentType
  /attachments/by-asset-path:
    get:
      produces:
        - application/json
      parameters:
        - description: The unique asset path for identifying the attachment.
          in: query
          name: assetPath
          required: true
          type: string
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          format: int32
          in: query
          name: offset
          required: false
          type: integer
          x-entity-path: dataArea/get/recordSetStartNumber
        - description: The maximum number of records to return.
          format: int32
          in: query
          name: limit
          required: false
          type: integer
          x-entity-path: dataArea/get/maxItems
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentCollection'
          x-entity-path: dataArea/attachment
      summary: Get attachments by asset path.
      x-expression-template: >-
        {_wcf.ap=IBM_Admin_Summary}/Attachment[search(AttachmentAsset/StoreIdentifier/UniqueID='{storeId}'
        and AttachmentAsset/AttachmentAssetPath='{assetPath}')]
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
  /attachments/by-code:
    get:
      produces:
        - application/json
      parameters:
        - description: >-
            The unique string identifier for identifying the attachment within
            the context of a particular store.
          in: query
          name: code
          required: true
          type: string
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          format: int32
          in: query
          name: offset
          required: false
          type: integer
          x-entity-path: dataArea/get/recordSetStartNumber
        - description: The maximum number of records to return.
          format: int32
          in: query
          name: limit
          required: false
          type: integer
          x-entity-path: dataArea/get/maxItems
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentCollection'
          x-entity-path: dataArea/attachment
      summary: Get attachments by code.
      x-expression-builder-class: >-
        com.ibm.commerce.rest.admin.v2.content.util.ContentSearchExpressionBuilder
      x-expression-builder-method: formatExpression
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-parameters:
        access-profile: IBM_Admin_Summary
        template: >-
          /Attachment[search(AttachmentIdentifier/ExternalIdentifier/Identifier='$code$')]
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
  /attachments/by-code-name-and-asset-path:
    get:
      produces:
        - application/json
      parameters:
        - description: >-
            The unique string identifier for identifying the attachment within
            the context of a particular store.
          in: query
          name: code
          required: true
          type: string
        - description: The name for identifying the attachment.
          in: query
          name: name
          required: true
          type: string
        - description: The asset path for identifying the attachment.
          in: query
          name: assetPath
          required: true
          type: string
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          format: int32
          in: query
          name: offset
          required: false
          type: integer
          x-entity-path: dataArea/get/recordSetStartNumber
        - description: The maximum number of records to return.
          format: int32
          in: query
          name: limit
          required: false
          type: integer
          x-entity-path: dataArea/get/maxItems
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentCollection'
          x-entity-path: dataArea/attachment
      summary: 'Get attachments by code, name and asset path.'
      x-expression-builder-class: >-
        com.ibm.commerce.rest.admin.v2.content.util.ContentSearchExpressionBuilder
      x-expression-builder-method: formatExpression
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-parameters:
        access-profile: IBM_Admin_Summary
        template: >-
          /Attachment[search(AttachmentIdentifier/ExternalIdentifier/Identifier='$code$'
          and AttachmentDescription/Name='$name$' and
          AttachmentAsset/AttachmentAssetPath='$assetPath$')]
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
  /attachments/by-name:
    get:
      produces:
        - application/json
      parameters:
        - description: The name for identifying the attachment.
          in: query
          name: name
          required: true
          type: string
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          format: int32
          in: query
          name: offset
          required: false
          type: integer
          x-entity-path: dataArea/get/recordSetStartNumber
        - description: The maximum number of records to return.
          format: int32
          in: query
          name: limit
          required: false
          type: integer
          x-entity-path: dataArea/get/maxItems
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentCollection'
          x-entity-path: dataArea/attachment
      summary: Get attachments by name.
      x-expression-builder-class: >-
        com.ibm.commerce.rest.admin.v2.content.util.ContentSearchExpressionBuilder
      x-expression-builder-method: formatExpression
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-parameters:
        access-profile: IBM_Admin_Summary
        template: '/Attachment[search(AttachmentDescription/Name=''$name$'')]'
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
  '/attachments/{id}':
    delete:
      parameters:
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
      responses:
        '204':
          description: The operation is successful.
      summary: Delete an attachment by unique identifier.
      x-action-code: Delete
      x-expression-template: '/Attachment[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: processAttachment
      x-flow-class: com.ibm.commerce.rest.bod.DeleteBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ProcessAttachmentType
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: path
          name: id
          required: true
          type: integer
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/Attachment'
          x-entity-path: 'dataArea/attachment[1]'
      summary: Get an attachment by unique identifier.
      x-expression-template: >-
        {_wcf.ap=IBM_Admin_Summary}/Attachment/AttachmentIdentifier[(UniqueID='{id}')]
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
    patch:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/Attachment'
          x-entity-path: 'dataArea/attachment[1]'
      responses:
        '200':
          description: The operation is successful.
      summary: Update an attachment by unique identifier.
      x-action-code: Change
      x-expression-template: '/Attachment[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PatchBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
  '/attachments/{id}/assets':
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: path
          name: id
          required: true
          type: integer
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentAssetCollection'
          x-entity-path: 'dataArea/attachment[1]/attachmentAsset'
      summary: Get assets of an attachment by unique identifier.
      x-expression-template: >-
        {_wcf.ap=IBM_Admin_AttachmentWithAssets}/Attachment/AttachmentIdentifier[(UniqueID='{id}')]
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
    post:
      consumes:
        - application/json
      parameters:
        - description: >-
            The unique numeric ID for identifying the attachment to which this
            asset belongs.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: dataArea/attachment/attachmentIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentAsset'
          x-entity-path: 'dataArea/attachment[1]/attachmentAsset[1]'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment asset.
              type: string
          x-entity-path: >-
            dataArea/attachment[1]/attachmentAsset[1]/attachmentAssetIdentifier/uniqueID
      summary: Create an attachment asset.
      x-action-code: Add
      x-expression-template: '/Attachment[1]/AttachmentAsset[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PostBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
      x-request-verb: change
      x-response-verb: respond
  '/attachments/{id}/assets/{assetId}':
    delete:
      parameters:
        - description: >-
            The unique numeric ID for identifying the attachment to which the
            asset belongs.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment asset.
          format: int64
          in: path
          name: assetId
          required: true
          type: integer
          x-entity-path: >-
            dataArea/attachment[1]/attachmentAsset[1]/attachmentAssetIdentifier/uniqueID
      responses:
        '204':
          description: The operation is successful.
      summary: Delete an attachment asset by unique identifier.
      x-action-code: Delete
      x-expression-template: '/Attachment[1]/AttachmentAsset[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.DeleteBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
      x-request-verb: change
      x-response-verb: respond
    patch:
      consumes:
        - application/json
      parameters:
        - description: >-
            The unique numeric ID for identifying the attachment to which the
            asset belongs.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment asset.
          format: int64
          in: path
          name: assetId
          required: true
          type: integer
          x-entity-path: >-
            dataArea/attachment[1]/attachmentAsset[1]/attachmentAssetIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentAsset'
          x-entity-path: 'dataArea/attachment[1]/attachmentAsset[1]'
      responses:
        '200':
          description: The operation is successful.
      summary: Update an attachment asset by unique identifier.
      x-action-code: Change
      x-expression-template: '/Attachment[1]/AttachmentAsset[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PatchBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
  '/attachments/{id}/descriptions':
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: path
          name: id
          required: true
          type: integer
        - description: >-
            The integer(s) for identifying the language of the member group
            description. For a list of the integers that map to the supported
            default languages, refer to the Knowledge Center. Multiple
            identifiers should be specified as a comma-separated list.
          in: query
          name: dataLanguageIds
          required: true
          type: string
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentDescriptionCollection'
          x-entity-path: 'dataArea/attachment[1]/attachmentDescription'
      summary: Get descriptions of an attachment by unique identifier.
      x-expression-template: >-
        {_wcf.ap=IBM_Admin_AttachmentWithAssets;_wcf.dataLanguageIds='{dataLanguageIds}'}/Attachment/AttachmentIdentifier[(UniqueID='{id}')]
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: getAttachment
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.GetAttachmentType
    post:
      consumes:
        - application/json
      parameters:
        - description: >-
            The unique numeric ID for identifying the attachment to which this
            description applies.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: dataArea/attachment/attachmentIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentDescription'
          x-entity-path: 'dataArea/attachment[1]/attachmentDescription[1]'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment description.
              type: string
          x-entity-path: 'dataArea/attachment[1]/attachmentDescription[1]/language'
      summary: Create an attachment description.
      x-action-code: Add
      x-expression-template: '/Attachment[1]/AttachmentDescription[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PostBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
      x-request-verb: change
      x-response-verb: respond
  '/attachments/{id}/descriptions/{descriptionId}':
    patch:
      consumes:
        - application/json
      parameters:
        - description: >-
            The unique numeric ID for identifying the attachment to which the
            description applies.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment description.
          format: int32
          in: path
          name: descriptionId
          required: true
          type: integer
          x-entity-path: 'dataArea/attachment[1]/attachmentDescription[1]/language'
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentDescription'
          x-entity-path: 'dataArea/attachment[1]/attachmentDescription[1]'
      responses:
        '200':
          description: The operation is successful.
      summary: Update an attachment description by unique identifier.
      x-action-code: Change
      x-expression-template: '/Attachment[1]/AttachmentDescription[1]'
      x-facade-client-class: com.ibm.commerce.content.facade.client.AttachmentFacadeClient
      x-facade-client-method: changeAttachment
      x-flow-class: com.ibm.commerce.rest.bod.PatchBodMappingFlow
      x-request-bod-class: com.ibm.commerce.content.facade.datatypes.ChangeAttachmentType
  '/catalog-entries/{catalogEntryId}/attachment-references':
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog entry.
          format: int64
          in: path
          name: catalogEntryId
          required: true
          type: integer
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The integer(s) for identifying the language of the catalog entry
            description. For a list of the integers that map to the supported
            default languages, refer to the Knowledge Center. Multiple
            identifiers should be specified as a comma-separated list.
          in: query
          name: dataLanguageIds
          required: true
          type: string
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentReferenceCollection'
          x-entity-path: 'dataArea/catalogEntry[1]/attachmentReference'
      summary: Get a collection of catalog entry attachment reference.
      x-expression-template: >-
        {_wcf.ap='{accessProfile}';_wcf.dataLanguageIds
        ='{dataLanguageIds}'}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='{catalogEntryId}')]]
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: getCatalogEntry
      x-parameters:
        accessProfile: IBM_Admin_CatalogEntryAttachmentReference
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.GetCatalogEntryType
    post:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog entry.
          format: int64
          in: path
          name: catalogEntryId
          required: true
          type: integer
          x-entity-path: 'dataArea/catalogEntry[1]/catalogEntryIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalogEntry[1]/catalogEntryIdentifier/externalIdentifier/storeIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentReference'
          x-entity-path: 'dataArea/catalogEntry[1]/attachmentReference[1]'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment reference for a catalog entry.
              type: string
          x-entity-path: >-
            dataArea/catalogEntry[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
      summary: Create an attachment reference for a catalog entry.
      x-action-code: Add
      x-expression-template: '/CatalogEntry[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalogEntry
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogEntryType
      x-request-verb: change
  '/catalog-entries/{catalogEntryId}/attachment-references/{id}':
    delete:
      parameters:
        - description: The unique numeric ID for identifying the catalog entry.
          format: int64
          in: path
          name: catalogEntryId
          required: true
          type: integer
          x-entity-path: 'dataArea/catalogEntry[1]/catalogEntryIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment reference.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: >-
            dataArea/catalogEntry[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalogEntry[1]/catalogEntryIdentifier/externalIdentifier/storeIdentifier/uniqueID
      responses:
        '204':
          description: The operation is successful.
      summary: Delete an attachment reference of a catalog entry.
      x-action-code: Delete
      x-expression-template: '/CatalogEntry[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalogEntry
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogEntryType
      x-request-verb: change
    patch:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog entry.
          format: int64
          in: path
          name: catalogEntryId
          required: true
          type: integer
          x-entity-path: 'dataArea/catalogEntry[1]/catalogEntryIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment reference.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: >-
            dataArea/catalogEntry[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalogEntry[1]/catalogEntryIdentifier/externalIdentifier/storeIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentReference'
          x-entity-path: 'dataArea/catalogEntry[1]/attachmentReference[1]'
      responses:
        '200':
          description: The operation is successful.
      summary: Update an attachment reference of a catalog entry.
      x-action-code: Change
      x-expression-template: '/CatalogEntry[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalogEntry
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogEntryType
  '/catalogs/{catalogId}/attachment-references/{id}':
    delete:
      parameters:
        - description: The unique numeric ID for identifying the catalog.
          format: int64
          in: path
          name: catalogId
          required: true
          type: integer
          x-entity-path: 'dataArea/catalog[1]/catalogIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment reference.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: >-
            dataArea/catalog[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID
        - description: The unique numeric ID for identifying the attachment.
          format: int64
          in: query
          name: attachmentId
          required: true
          type: integer
          x-entity-path: >-
            dataArea/catalog[1]/attachmentReference[1]/attachmentIdentifier/uniqueID
      responses:
        '204':
          description: The operation is successful.
      summary: Delete an attachment reference of a catalog.
      x-action-code: Delete
      x-expression-template: '/Catalog[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalog
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType
      x-request-verb: change
    patch:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog.
          format: int64
          in: path
          name: catalogId
          required: true
          type: integer
          x-entity-path: 'dataArea/catalog[1]/catalogIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment reference.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: >-
            dataArea/catalog[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentReference'
          x-entity-path: 'dataArea/catalog[1]/attachmentReference[1]'
      responses:
        '200':
          description: The operation is successful.
      summary: Update an attachment reference of a catalog.
      x-action-code: Change
      x-expression-template: '/Catalog[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalog
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType
  '/catalogs/{id}/attachment-references':
    get:
      produces:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog.
          format: int64
          in: path
          name: id
          required: true
          type: integer
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: >-
            The integer(s) for identifying the language of the member group
            description. For a list of the integers that map to the supported
            default languages, refer to the Knowledge Center. Multiple
            identifiers should be specified as a comma-separated list.
          in: query
          name: dataLanguageIds
          required: true
          type: string
      responses:
        '200':
          description: The operation is successful.
          schema:
            $ref: '#/definitions/AttachmentReferenceCollection'
          x-entity-path: 'dataArea/catalog[1]/attachmentReference'
      summary: Get the attachment references of a catalog.
      x-expression-template: >-
        {_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[CatalogIdentifier[(UniqueID='{id}')]]
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: getCatalog
      x-parameters:
        accessProfile: IBM_Admin_CatalogAttachmentReference
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.GetCatalogType
    post:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the catalog.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/catalog[1]/catalogIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
          x-entity-path: >-
            dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentReference'
          x-entity-path: 'dataArea/catalog[1]/attachmentReference[1]'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment reference for a catalog.
              type: string
          x-entity-path: >-
            dataArea/catalog[1]/attachmentReference[1]/attachmentReferenceIdentifier/uniqueID
      summary: Create an attachment reference for a catalog.
      x-action-code: Add
      x-expression-template: '/Catalog[1]/AttachmentReference[1]'
      x-facade-client-class: com.ibm.commerce.catalog.facade.client.CatalogFacadeClient
      x-facade-client-method: changeCatalog
      x-request-bod-class: com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType
      x-request-verb: change
  '/marketing-contents/{id}/attachment-references':
    post:
      consumes:
        - application/json
      parameters:
        - description: The unique numeric ID for identifying the marketing content.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the store.
          format: int32
          in: query
          name: storeId
          required: true
          type: integer
          x-context-data: storeId
        - description: The request body.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/AttachmentReference'
          x-entity-path: 'dataArea/marketingContent[1]/attachment'
      responses:
        '201':
          description: The operation is successful.
          headers:
            Location:
              description: The URI of the attachment reference content.
              type: string
          x-entity-path: >-
            dataArea/marketingContent/attachment/attachmentReferenceIdentifier/uniqueID
      summary: Create an attachment reference for a marketing content.
      x-action-code: Add
      x-expression-template: '/MarketingContent[1]/Attachment'
      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-request-verb: change
      x-response-verb: respond
  '/marketing-contents/{id}/attachment-references/{attachmentReferenceId}':
    delete:
      parameters:
        - description: The unique numeric ID for identifying the marketing content.
          format: int64
          in: path
          name: id
          required: true
          type: integer
          x-entity-path: 'dataArea/marketingContent[1]/marketingContentIdentifier/uniqueID'
        - description: The unique numeric ID for identifying the attachment reference.
          format: int64
          in: path
          name: attachmentReferenceId
          required: true
          type: integer
          x-entity-path: >-
            dataArea/marketingContent[1]/attachment/attachmentReferenceIdentifier/uniqueID
      responses:
        '204':
          description: The operation is successful.
      summary: Delete an attachment reference of a marketing content.
      x-action-code: Delete
      x-expression-template: '/MarketingContent[1]/Attachment'
      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-request-verb: change
definitions:
  Attachment:
    description: An attachment.
    properties:
      code:
        description: >-
          The unique string identifier for identifying the attachment within the
          context of a particular store.
        type: string
        x-entity-path: attachmentIdentifier/externalIdentifier/identifier
      id:
        description: The unique numeric ID for identifying the attachment.
        format: int32
        type: integer
        x-entity-path: attachmentIdentifier/uniqueID
      storeId:
        description: >-
          The unique numeric ID for identifying the store to which the
          attachment belongs. Can only be set when the attachment is created.
        format: int32
        type: integer
        x-entity-path: attachmentIdentifier/externalIdentifier/storeIdentifier/uniqueID
    type: object
    x-entity-class: com.ibm.commerce.content.facade.datatypes.AttachmentType
  AttachmentAsset:
    description: An attachment asset.
    properties:
      directoryPath:
        description: >-
          The directory path of the attachment asset. This is a substring of the
          attachment asset path when the attachment asset is a file. For
          example, if the attachment asset path is /image/a.gif, then its
          directory path is /image.
        readOnly: true
        type: string
        x-entity-path: directoryPath
      id:
        description: The unique numeric ID for identifying the attachment asset.
        format: int64
        type: integer
        x-entity-path: attachmentAssetIdentifier/uniqueID
      languageIds:
        description: >-
          The integer(s) for identifying the languages of the attachment asset.
          For a list of the integers that map to the supported default
          languages, refer to the Knowledge Center.
        items:
          format: int32
          type: integer
        type: array
        x-entity-path: language
      mimeType:
        description: The MIME type of the attachment asset.
        type: string
        x-entity-path: mimeType
      path:
        description: >-
          The relative path of the attachment asset which includes the directory
          path and the file name of the attachment asset. For example,
          /image/a.gif
        type: string
        x-entity-path: attachmentAssetPath
      rootDirectory:
        description: The root directory of the attachment asset.
        readOnly: true
        type: string
        x-entity-path: rootDirectory
      storeId:
        description: >-
          The unique numeric ID for identifying the store to which the
          attachment asset belongs. Can only be set when the attachment asset is
          created.
        format: int32
        type: integer
        x-entity-path: storeIdentifier/uniqueID
    type: object
    x-entity-class: com.ibm.commerce.foundation.common.datatypes.AttachmentAssetType
  AttachmentAssetCollection:
    description: A collection of attachment assets.
    properties:
      count:
        description: The total number of item records that match the query parameters.
        format: int64
        type: integer
      items:
        items:
          $ref: '#/definitions/AttachmentAsset'
        type: array
    type: object
  AttachmentCollection:
    description: A collection of attachments.
    properties:
      count:
        description: The total number of item records that match the query parameters.
        format: int64
        type: integer
      items:
        items:
          $ref: '#/definitions/Attachment'
        type: array
    type: object
  AttachmentDescription:
    description: An attachment description.
    properties:
      languageId:
        description: >-
          The integer for identifying the language of the attachment
          description. For a list of the integers that map to the supported
          default languages, refer to the Knowledge Center.
        format: int32
        type: integer
        x-entity-path: language
      longDescription:
        description: A long description of the attachment.
        type: string
      name:
        description: The language dependent name of the attachment.
        type: string
      shortDescription:
        description: A short description of the attachment.
        type: string
    type: object
    x-entity-class: com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType
  AttachmentDescriptionCollection:
    description: A collection of attachment descriptions.
    properties:
      count:
        description: The total number of item records that match the query parameters.
        format: int64
        type: integer
      items:
        items:
          $ref: '#/definitions/AttachmentDescription'
        type: array
    type: object
  AttachmentReference:
    description: A reference to an attachment.
    properties:
      attachmentAssets:
        description: The attachment assets.
        items:
          $ref: '#/definitions/AttachmentAsset'
        readOnly: true
        type: array
        x-entity-path: attachmentAsset
      attachmentDescriptions:
        description: The attachment descriptions.
        items:
          $ref: '#/definitions/AttachmentDescription'
        readOnly: true
        type: array
        x-entity-path: attachmentDescription
      attachmentId:
        description: The unique numeric ID for identifying the attachment.
        format: int64
        type: integer
        x-entity-path: attachmentIdentifier/uniqueID
      attachmentReferenceDescriptions:
        items:
          $ref: '#/definitions/AttachmentDescription'
        type: array
        x-entity-path: attachmentReferenceDescription
      attachmentUsage:
        $ref: '#/definitions/AttachmentUsage'
      displaySequence:
        description: The display sequence.
        type: string
        x-entity-path: displaySequence
      id:
        description: The unique numeric ID for identifying the attachment reference.
        format: int64
        readOnly: true
        type: integer
        x-entity-path: attachmentReferenceIdentifier/uniqueID
      identifier:
        description: The identifier or name for identifying the attachment reference.
        readOnly: true
        type: string
        x-entity-path: attachmentIdentifier/externalIdentifier/identifier
      organizationId:
        description: The numeric ID of the organization that owns the attachment.
        readOnly: true
        type: string
        x-entity-path: attachmentIdentifier/externalIdentifier/ownerID
      storeId:
        description: The unique numeric ID for identifying the store.
        format: int32
        readOnly: true
        type: integer
        x-entity-path: attachmentIdentifier/externalIdentifier/storeIdentifier/uniqueID
    type: object
    x-entity-class: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType
  AttachmentReferenceCollection:
    description: A collection of attachment references.
    properties:
      count:
        description: The total number of item records that match the query parameters.
        format: int64
        type: integer
      items:
        items:
          $ref: '#/definitions/AttachmentReference'
        type: array
    type: object
  AttachmentUsage:
    description: >-
      The attachment usage. The attachment description is a read-only property,
      and cannot be added, updated or deleted when changing an attachment usage.
    properties:
      description:
        $ref: '#/definitions/AttachmentDescription'
      displaySequence:
        description: The display sequence.
        readOnly: true
        type: string
        x-entity-path: displaySequence
      imagePath:
        description: The path of the image.
        readOnly: true
        type: string
        x-entity-path: image
      usageName:
        description: The attachment usage name.
        type: string
        x-entity-path: usageName
    type: object
    x-entity-class: com.ibm.commerce.foundation.common.datatypes.AttachmentUsageType
x-components: {}

