This web service returns information about a document's attachment. Use the List attachments web service to get an attachmentId.
| Method | Endpoint |
|---|---|
GET |
|
| Path parameter | Type | Description |
|---|---|---|
{khubId} |
String | Expects the id of the targeted document. |
{attachmentId} |
String | Expects the id of the targeted attachment. |
It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.
This web service requires authentication on portals with mandatory authentication.
Response body
The following example shows a JSON response body for this web service:
{
"id": "OQ8WzdX53euxlRXaarxeoQ-iScauuz5RO1Bd~KxLHwFPw",
"portalUrl": "/viewer/book-attachment/iScauuz5RO1Bd~KxLHwFPw/OQ8WzdX53euxlRXaarxeoQ-iScauuz5RO1Bd~KxLHwFPw",
"contentUrl": "https://docs.fluidtopics.com/api/khub/maps/iScauuz5RO1Bd~KxLHwFPw/attachments/OQ8WzdX53euxlRXaarxeoQ-iScauuz5RO1Bd~KxLHwFPw/content?v=1781690452125",
"fingerprint": "1781690452125",
"filename": "design-export-examples.zip",
"displayName": "design-export-examples.zip",
"mimeType": "application/zip",
"size": 2651009,
"viewableInCurrentBrowser": false,
"holder": {
"type": "MAP",
"id": "iScauuz5RO1Bd~KxLHwFPw",
"portalUrl": "https://docs.fluidtopics.com/r/Fluid-Topics-Designer-Guide",
"lang": "en-US",
"title": "Fluid Topics Designer Guide",
"metadata": [
{
"key": "ft:originId",
"label": "ft:originId",
"values": [
"fluid-topics-designer-guide"
]
},
{
"key": "ft:title",
"label": "ft:title",
"values": [
"Fluid Topics Designer Guide"
]
},
{
"key": "ft:baseId",
"label": "ft:baseId",
"values": [
"fluid-topics-designer-guide"
]
},
{
"key": "ft:locale",
"label": "ft:locale",
"values": [
"en-US"
]
},
{
"key": "ft:publicationId",
"label": "ft:publicationId",
"values": [
"iScauuz5RO1Bd~KxLHwFPw"
]
},
{
"key": "ft:sourceId",
"label": "ft:sourceId",
"values": [
"md_doc"
]
},
{
"key": "ft:sourceName",
"label": "Source Name",
"values": [
"Markdown Product Knowledge"
]
},
{
"key": "ft:sourceType",
"label": "ft:sourceType",
"values": [
"Markdown"
]
},
{
"key": "ft:khubVersion",
"label": "ft:khubVersion",
"values": [
"5.1.21"
]
},
{
"key": "ft:publishStatus",
"label": "ft:publishStatus",
"values": [
"visible"
]
},
{
"key": "ft:clusterId",
"label": "ft:clusterId",
"values": [
"fluid-topics-designer-guide"
]
},
{
"key": "ft:attachmentsSize",
"label": "ft:attachmentsSize",
"values": [
"2667594"
]
},
{
"key": "ft:publication_title",
"label": "ft:publication_title",
"values": [
"Fluid Topics Designer Guide"
]
},
{
"key": "ft:openMode",
"label": "ft:openMode",
"values": [
"fluidtopics"
]
},
{
"key": "ft:lastPublication",
"label": "ft:lastPublication",
"values": [
"2026-06-17T10:00:51.689827"
]
},
{
"key": "ft:lastTechChange",
"label": "ft:lastTechChange",
"values": [
"2026-06-17"
]
},
{
"key": "ft:lastTechChangeTimestamp",
"label": "ft:lastTechChangeTimestamp",
"values": [
"1781690452125"
]
},
{
"key": "ft:searchableFromInt",
"label": "ft:searchableFromInt",
"values": [
"0"
]
},
{
"key": "ft:alertTimestamp",
"label": "ft:alertTimestamp",
"values": [
"1781690452"
]
},
{
"key": "ft:lastEdition",
"label": "ft:lastEdition",
"values": [
"2026-06-17"
]
},
{
"key": "ft:editorialType",
"label": "Editorial type",
"values": [
"book"
]
},
{
"key": "ft:isPublication",
"label": "ft:isPublication",
"values": [
"true"
]
},
{
"key": "ft:isBook",
"label": "ft:isBook",
"values": [
"true"
]
},
{
"key": "ft:isArticle",
"label": "ft:isArticle",
"values": [
"false"
]
},
{
"key": "ft:isUnstructured",
"label": "ft:isUnstructured",
"values": [
"false"
]
},
{
"key": "ft:isHtmlPackage",
"label": "ft:isHtmlPackage",
"values": [
"false"
]
},
{
"key": "ft:structure",
"label": "ft:structure",
"values": [
"structured"
]
},
{
"key": "ft:isAttachment",
"label": "ft:isAttachment",
"values": [
"false"
]
},
{
"key": "ft:isSynchronousAttachment",
"label": "ft:isSynchronousAttachment",
"values": [
"false"
]
},
{
"key": "ft:document_type",
"label": "ft:document_type",
"values": [
"map"
]
},
{
"key": "ft:publishUploadId",
"label": "ft:publishUploadId",
"values": [
"1fcde236-deac-442a-8f2f-c799c0218d40"
]
},
{
"key": "ft:prettyUrl",
"label": "ft:prettyUrl",
"values": [
"Fluid-Topics-Designer-Guide"
]
},
{
"key": "ft:contentSize",
"label": "ft:contentSize",
"values": [
"2927223"
]
},
{
"key": "ft:wordCount",
"label": "ft:wordCount",
"values": [
"27492"
]
},
{
"key": "ft:outputSize",
"label": "ft:outputSize",
"values": [
"5861"
]
},
{
"key": "author",
"label": "Author",
"values": [
"Clément Guillaume",
"Dorian Baret"
]
},
{
"key": "tags",
"label": "tags",
"values": [
"fluid-topics-reference-guide"
]
},
{
"key": "Product",
"label": "Product",
"values": [
"Fluid Topics"
]
},
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guides"
]
},
{
"key": "audience",
"label": "Audience",
"values": [
"public"
]
},
{
"key": "media_dir",
"label": "media_dir",
"values": [
"images"
]
},
{
"key": "FT_Version",
"label": "Version",
"values": [
"Latest"
]
},
{
"key": "user_role",
"label": "User role",
"values": [
"PORTAL_ADMIN"
]
},
{
"key": "PBS",
"label": "Subject matter",
"values": [
"Design"
]
},
{
"key": "Version_FT",
"label": "Version",
"values": [
"Latest"
]
},
{
"key": "sourceId_custom",
"label": "sourceId_custom",
"values": [
"md_doc"
]
}
]
}
}
| Field | Type | Description |
|---|---|---|
id |
String | The attachment's unique ID. |
portalUrl |
String | The URL through which the attachment is available to end-users in the Fluid Topics interface. |
contentUrl |
String | The URL through which the attachment can be downloaded. |
fingerprint |
String | A version token enabling the safe caching of the attachment. |
filename |
String | The attachment's filename. |
displayName |
String | The optional value used to identify the attachment (uses the filename by default). |
mimeType |
String | The attachment's MIME type. |
size |
Number | The attachment size in bytes. |
viewableInCurrentBrowser |
Boolean | Is true for attachments which users can see in the Viewer page directly, such as images, or PDFs. Is false for ZIP files, for example. |
holder |
String | An object representing the document to which the attachment belongs to. |
type |
String | Can be MAP for a structured document, or DOCUMENT for an unstructured document. |
id |
String | The parent document's khubId. |
portalUrl |
String | The parent document's URL. |
lang |
String | The parent document's locale. |
title |
String | The parent document's title. |
metadata |
String | The parent document's metadata. |