The imageitemfile form data and fields are described below.
imageitemfile was introduced in API version V1
imageitemfile has not been marked for deprecation
Image files are transferred using multipipart/form-data which is widely supported by HTTP clients and browsers to submit files. The endpoint allows upload of a single 'src' file which will be associated with either the default, large or medium format file according to the value of the imageItemFormat
| Name | Type | Description | Constraints |
|---|---|---|---|
| imageItemUrn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The URN of the image item that the provided file will be associated with. | Required on create. |
| imageItemSize | String literal | The image item format (size). Note that imageitem concepts support three file size formats to allow support for responsive images in web contexts or other app contexts where different image sizes may be required. | Required on create. Allowed values:
|
| src | multipart/form-data encoded file data provided to be processed by the endpoint | Image file content multipart form encoded. The file includes a name which the API handler will attempt to preserve according to valid file naming conventions. | Required on create. |