List
MediaObjectListRequest is the input to the media object getMediaObjectList operation. The following table describes the attributes in the request that control the list that is returned:
Field |
Type |
Description |
---|---|---|
includeURLs |
boolean |
Valid values are:
When true, includes the URL for downloading the media object, which can be used in conjunction with a download request at a later time. This only applies to the media object file type. |
includeData |
boolean |
Valid values are:
When true, if the file is an image, it includes the base64 encoded data for a thumbnail sized image. |
moTypes |
String |
Use a constant defined in MediaObjectListRequestValid, which includes these constants:
|
extensions |
String |
File extensions to include in the response, which enables you to filter out undesired extensions. |
thumbnailSize |
<String> int |
Size of the thumbnail image returned as base64 data. |
The code in Example - Saving Thumbnail Images for Image Media Object Attachments is an example of saving the set of thumbnail images for image media object attachments. It includes specified extensions for the first file type attachments. The includeData value is set to include the thumbnail data. If the file is not a PDF (a non-image type), the thumbnail data is saved to a local file.