List assets - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns a portal's assets.

Method Endpoint
GET /api/admin/portal/assets

This web service is available to PORTAL_ADMIN and ADMIN users.

Response body

{
    "totalSize": 1336339,
    "assets": [
        {
            "alias": "me",
            "mimeType": "image/png",
            "displayName": "me.png",
            "originFilename": "me.png",
            "publicUrl": "https://sandbox.fluidtopics.net/dorian2/portal-asset/me",
            "imageAttributes": {
                "imageAltText": "",
                "width": 480,
                "height": 480
            },
            "lastUpdate": "2024-06-17T08:37:36.230Z",
            "visibility": "PORTAL",
            "size": 481052
        },
        {
            "alias": "my-other-image",
            "mimeType": "image/jpeg",
            "displayName": "my-other-image",
            "originFilename": "DSF2847.jpg",
            "publicUrl": "https://sandbox.fluidtopics.net/dorian2/portal-asset/my-other-image",
            "imageAttributes": {
                "imageAltText": "My Great Image",
                "width": 1920,
                "height": 1765
            },
            "lastUpdate": "2024-07-31T09:11:53.991Z",
            "visibility": "PUBLIC",
            "size": 682427
        },
        {
            "alias": "my-other-font2",
            "mimeType": "font/ttf",
            "displayName": "my-other-font2",
            "originFilename": "Roboto-ThinItalic.ttf",
            "publicUrl": "https://sandbox.fluidtopics.net/dorian2/portal-asset/my-other-font2",
            "lastUpdate": "2024-07-31T09:18:35.450Z",
            "lastAccess": "2024-07-31T11:50:57.618Z",
            "visibility": "PORTAL",
            "size": 172860
        }
    ]
}
Field Type Description
totalSize Number The total size of the assets on a portal in bytes.
assets Array An array containing all assets.
    alias String The identifier of the asset as set for the upload. Users can use the alias to download an image or font using the Get an asset web service.
The alias of assets uploaded through the Asset library menu is the name set by the user.
    mimeType String The asset's MIME type.
    displayName String The display name of a file.
    originFilename String The filename of the asset.
    publicUrl String The URL of the asset.
    imageAttributes Array An array containing an image asset's attributes.
        imageAltText String The alt text for an image asset.
        width Number An image asset width in pixels.
        height Number An image asset height in pixels.
    lastUpdate String The time of last update, set in the ISO 8601 format.
    lastAccess String The time of last access, set in the ISO 8601 format.
    visibility String Can be PUBLIC or PORTAL.

When set to PUBLIC, all users can access an asset through its URL, even when the portal requires authentication.

When set to PORTAL, unauthenticated users cannot access an asset through its URL when the portal requires authentication.
    size String The size of the asset in bytes.