List Map Attachments - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service lists the documents attached to a map. Information is provided for each document.

Method

Endpoint

GET

/api/khub/maps/$MAP_ID/attachments

Where:

  • $MAP_ID is the "id" parameter of the map.

Output Example

[
{
"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"
},
{
"id": "j1QQYwPnZF5kz~40quy~mA",
"name": "My Document Archive",
"file": "TN_WS_use_cases.zip",
"mimeType": "application/zip",
"externalLink": false,
"viewerUrl": "/viewer/book-attachment/jRbmsakXkovi6x5bu5ynpg/j1QQYwPnZF5kz~40quy~mA"
},
{
"id": "k2RRZxQoAG6la~51rvz~nB",
"name": "AI Templates",
"file": "Templates_(AI).pdf",
"mimeType": "application/pdf",
"externalLink": false,
"viewerUrl": "/viewer/book-attachment/jRbmsakXkovi6x5bu5ynpg/k2RRZxQoAG6la~51rvz~nB"
}
]

Where:

  • "id" is the khubId of the attachment.
  • "name" is the display name of the attachment.
  • "file" is the filename of the attachment.
  • "mimeType" is the mime type of the attachment.
  • "externalLink" is true if the file value is a URL. If not, it is false.
  • "viewerUrl" is the URL fragment to use to open the map attachment in a Fluid Topics UI. This information is not given if externalLink is true.

In this example, the map has three map attachments.