This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
en:devel:corebosws:docenhance_examples [2020/11/04 00:16] joebordes [Create, Update and Retrieve Images] |
en:devel:corebosws:docenhance_examples [2020/11/04 00:37] (current) joebordes [Create, Update and Retrieve Images] |
||
---|---|---|---|
Line 350: | Line 350: | ||
</code> | </code> | ||
- | A normal Retrieve call on a record with images will return the information of the file; the name, the location on disk (URL), and some other metadata in a virtual field with the same name of the field followed by "imageinfo", but we have also added a new method in order to retrieve file information of a record. | + | A normal Retrieve call on a record with images will return the information of the file; the name, the location on disk (URL), and some other metadata in a virtual field with the same name of the field followed by "imageinfo", but we have also added a method in order to retrieve file information of a record. |
+ | getRecordImages allows a web service client to retrieve the information of the image attachments associated with a record, which can then be used with the build/HelperScripts/getImageData.php script to obtain the image data itself. | ||
^Method:|**getRecordImages**| | ^Method:|**getRecordImages**| | ||
Line 367: | Line 368: | ||
- | getProductImages | + | ==== Product Multi-Image field==== |
- | addProductImages | + | The product module contains a special, non-standard image field which may contain many images. coreBOS does not recommend the use of this field. Individual images should be used instead. |
+ | |||
+ | When calling Retrieve on a product the first image found in the multi-image field will be returned. It is NOT guaranteed to always get the same image. | ||
+ | |||
+ | You can use the **addProductImages** method to insert images in this field. | ||
+ | |||
+ | ^Method:|**addProductImages**| | ||
+ | ^Purpose:|Inserts a set of images into the Product multi-image field| | ||
+ | ^Profile:|addProductImages(id:string, files:Map):Map| | ||
+ | ^Send as:|POST| | ||
+ | ^Parameters:| => id: web service ID of the product record to upload the images to \\ => files: an array of images to upload, each array entry must contain two fields: name and content (base64 encoded)| | ||
+ | ^Response:|an array with information of the executed operations| | ||