List map attachments - Fluid Topics - Latest

Fluid Topics API Reference Guide

Reference Guides

This web service lists the resources attached to a map and provides information about each resource.

Method Endpoint
GET /api/khub/maps/{mapId}/attachments
Path parameter Type Description
{mapId} String Expects the id of the targeted map.

Response body

The following lines show an example of a JSON response body with three attachments:

        "id": "i0PPXvOmYE4jy~39ptx~lZ",
        "name": "Qoala Team's Mascot",
        "file": "QoalaTeamsMascot.jpg",
        "mimeType": "image/jpeg",
        "externalLink": false,
        "viewerUrl": "/viewer/book-attachment/jRbmsakXkovi6x5bu5ynpg/i0PPXvOmYE4jy~39ptx~lZ",
        "size": 160844
        "id": "j1QQYwPnZF5kz~40quy~mA",
        "name": "My Document Archive",
        "file": "",
        "mimeType": "application/zip",
        "externalLink": false,
        "viewerUrl": "/viewer/book-attachment/jRbmsakXkovi6x5bu5ynpg/j1QQYwPnZF5kz~40quy~mA",
        "size": 87458
        "id": "k2RRZxQoAG6la~51rvz~nB",
        "name": "AI Templates",
        "file": "Templates_(AI).pdf",
        "mimeType": "application/pdf",
        "externalLink": false,
        "viewerUrl": "/viewer/book-attachment/jRbmsakXkovi6x5bu5ynpg/k2RRZxQoAG6la~51rvz~nB",
        "size": 146196
Field Type Description
id String The attachment's khubId.
name String The attachment's name as it appears in the portal.
file String The attachment's filename.
mimeType String The attachment's MIME type.
externalLink Boolean Is true if the value of the file field is a URL.
viewerUrl String The URL fragment that opens the map attachment in the portal. Not available if the value of externalLink is true.
size Number The attachment size in bytes.