Retrieve assets previews info

/dam/assets/previews/retrieve Retrieve assets previews information.
Table 1. Details

Resource path

/api/core/v1/dam/assets/previews/retrieve

HTTP method

POST

Request content type

application/json

Response content type

  • application/xml; charset=UTF-8;

  • application/json

  • application/json+compact
Body parameters

Specified by PreviewInfoRequest

Return Type

OmnType with filled AssetsType. More info AssetType

Responses
Table 2. Http response codes
Code Message Datatype

200

OmnType with assets preview info in AssetType

OmnType

500

Error in ResponseType

ResponseType
Samples
Please use transform endpoint to get the JSON/compact-JSON samples from the XML one.
Get previews info 
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/previews/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "tids":[
      "11319367-DE26-4FB8-9148-3C341766C1BA"
   ],
  "formats": [
    "original",
    "previewOriginal",
    "previewCoarse",
    "previewThumbnail",
    "previewCustom",
    "previewOriginalPixel",
    "previewOriginalVector",
    "previewOriginalMultimedia"
  ]
}'

Request body:

by ids:
{
  "ids": [
    74628354
  ],
  "formats": [
    "original",
    "previewOriginal",
    "previewCoarse",
    "previewThumbnail",
    "previewCustom",
    "previewOriginalPixel",
    "previewOriginalVector",
    "previewOriginalMultimedia"
  ]
}
by tids:
{
  "tids": [
    "11319367-DE26-4FB8-9148-3C341766C1BA"
  ],
  "formats": [
    "original",
    "previewOriginal",
    "previewCoarse",
    "previewThumbnail",
    "previewCustom",
    "previewOriginalPixel",
    "previewOriginalVector",
    "previewOriginalMultimedia"
  ]
}
by paths:
{
  "paths": [
    "/MAM/rootDirectory/childDirectory1/pic.jpeg"
  ],
  "formats": [
    "original",
    "previewOriginal",
    "previewCoarse",
    "previewThumbnail",
    "previewCustom",
    "previewOriginalPixel",
    "previewOriginalVector",
    "previewOriginalMultimedia"
  ]
}
Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
    <meta>
        <itm key="messageType">request</itm>
        <itm key="messageTime">2022-09-19T09:46:46.471Z</itm>
        <itm key="sourceEnv">web</itm>
    </meta>
    <assets>
        <asset tid="11319367-DE26-4FB8-9148-3C341766C1BA">
            <name>artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500_print_variation_print_variation.jpg</name>
            <meta>
                <itm key="identity">87961</itm>
                <itm key="pathStringStr">/demo/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500_print_variation_print_variation.jpg</itm>
            </meta>
            <previews>
                <preview tid="E5B04787-87BD-4D18-AAA6-6CD26498EB0A" type="ORIGINAL_PIXEL">
                    <meta>
                        <itm key="extension">jpeg</itm>
                        <itm key="height">230</itm>
                        <itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
                        <itm key="pageNumber">-1</itm>
                        <itm key="size">0</itm>
                        <itm key="status">ORIGINAL</itm>
                        <itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&amp;format=previewOriginalPixel</itm>
                        <itm key="width">219</itm>
                    </meta>
                </preview>
                <preview tid="0B0A042E-6F51-44C2-8CE7-5F13E4719FCF" type="THUMBNAIL">
                    <meta>
                        <itm key="extension">jpeg</itm>
                        <itm key="height">40</itm>
                        <itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
                        <itm key="pageNumber">-1</itm>
                        <itm key="size">0</itm>
                        <itm key="status">ORIGINAL</itm>
                        <itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&amp;format=previewThumbnail</itm>
                        <itm key="width">38</itm>
                    </meta>
                </preview>
                <preview tid="11F00126-6D35-4355-99C3-2763A9743C00" type="COARSE">
                    <meta>
                        <itm key="extension">jpeg</itm>
                        <itm key="height">480</itm>
                        <itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
                        <itm key="pageNumber">-1</itm>
                        <itm key="size">0</itm>
                        <itm key="status">ORIGINAL</itm>
                        <itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&amp;format=previewCoarse</itm>
                        <itm key="width">457</itm>
                    </meta>
                </preview>
            </previews>
        </asset>
    </assets>
</pim>

Welcome to the AI Chat!

Write a prompt to get started...