Reference - Attachment REST API 1.0.0
Document View
This API specification is available for download as an Open API 3.0 YAML file:
References
The following page lists available REST APIs for ICM 11 and their version dependencies:
API Specification
Introduction
{loc}/attachments/{AttachmentResourceKey}GET: Returns the content of an attachment
Description
This operation returns the content of an attachment with a given descriptor and locale ID.
Normally, this endpoint is not called directly. Rather, it is used in the Product and Promotion details to provide links to attachments.
Java Method
public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.attachment.AttachmentResource.getAttachment(java.lang.String)
Request Body
--
Request Parameters
| Location | Name | Format | Default | Example | Description |
|---|---|---|---|---|---|
| in path | loc | string | en_US | The locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US. | |
| in path | AttachmentResourceKey | string | testDomain%253A%252Fmanual.pdf | Required | The content descriptor or URI of the attachment, double encoded. | |
| in query | type | string | promotion | The optional type of the attachment |
Response
default - Unknown default response
Request and Response Object Schemata
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.