HTML package output - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

The following example shows the response for the Clustered search web service for an HTML package:

{
    "facets": [],
    "results": [
        {
            "entries": [
                {
                    "type": "HTML_PACKAGE",
                    "missingTerms": [],
                    "htmlPackage": {
                        "packageId": "pEzZhOyEADlHsWde6F3T0Q",
                        "viewerUrl": "https://docs.fluidtopics.com/h/pEzZhOyEADlHsWde6F3T0Q/example-mini-site/contact.html",
                        "title": "example-mini-site",
                        "htmlTitle": "<span class=\"kwicmatch\">example</span><span class=\"kwicstring\">-mini-site</span>",
                        "htmlExcerpt": "",
                        "metadata": [
                            {
                                "key": "ft:editorialType",
                                "label": "ft:editorialType",
                                "values": [
                                    "html_package"
                                ]
                            },
                            {
                                "key": "ft:originId",
                                "label": "ft:originId",
                                "values": [
                                    "example-mini-site"
                                ]
                            },
                            {
                                "key": "ft:title",
                                "label": "ft:title",
                                "values": [
                                    "example-mini-site"
                                ]
                            },
                            {
                                "key": "ft:baseId",
                                "label": "ft:baseId",
                                "values": [
                                    "example-mini-site"
                                ]
                            },
                            {
                                "key": "ft:htmlPackageEntryPoint",
                                "label": "ft:htmlPackageEntryPoint",
                                "values": [
                                    "example-mini-site/contact.html"
                                ]
                            },
                            {
                                "key": "ft:publicationId",
                                "label": "ft:publicationId",
                                "values": [
                                    "pEzZhOyEADlHsWde6F3T0Q"
                                ]
                            },
                            {
                                "key": "ft:sourceId",
                                "label": "ft:sourceId",
                                "values": [
                                    "package"
                                ]
                            },
                            {
                                "key": "ft:sourceName",
                                "label": "ft:sourceName",
                                "values": [
                                    "package"
                                ]
                            },
                            {
                                "key": "ft:sourceType",
                                "label": "ft:sourceType",
                                "values": [
                                    "HtmlPackage"
                                ]
                            },
                            {
                                "key": "ft:khubVersion",
                                "label": "ft:khubVersion",
                                "values": [
                                    "5.0.219"
                                ]
                            },
                            {
                                "key": "ft:locale",
                                "label": "ft:locale",
                                "values": [
                                    "en-GB"
                                ]
                            },
                            {
                                "key": "ft:publishStatus",
                                "label": "ft:publishStatus",
                                "values": [
                                    "visible"
                                ]
                            },
                            {
                                "key": "ft:clusterId",
                                "label": "ft:clusterId",
                                "values": [
                                    "example-mini-site"
                                ]
                            },
                            {
                                "key": "ft:attachmentsSize",
                                "label": "ft:attachmentsSize",
                                "values": [
                                    "0"
                                ]
                            },
                            {
                                "key": "ft:publication_title",
                                "label": "ft:publication_title",
                                "values": [
                                    "example-mini-site"
                                ]
                            },
                            {
                                "key": "ft:openMode",
                                "label": "ft:openMode",
                                "values": [
                                    "fluidtopics"
                                ]
                            },
                            {
                                "key": "ft:lastPublication",
                                "label": "ft:lastPublication",
                                "values": [
                                    "2026-03-25T13:21:30.978669"
                                ]
                            },
                            {
                                "key": "ft:lastTechChange",
                                "label": "ft:lastTechChange",
                                "values": [
                                    "2026-03-25"
                                ]
                            },
                            {
                                "key": "ft:lastTechChangeTimestamp",
                                "label": "ft:lastTechChangeTimestamp",
                                "values": [
                                    "1774444890979"
                                ]
                            },
                            {
                                "key": "ft:searchableFromInt",
                                "label": "ft:searchableFromInt",
                                "values": [
                                    "0"
                                ]
                            },
                            {
                                "key": "ft:alertTimestamp",
                                "label": "ft:alertTimestamp",
                                "values": [
                                    "1774444890"
                                ]
                            },
                            {
                                "key": "ft:lastEdition",
                                "label": "ft:lastEdition",
                                "values": [
                                    "2026-03-25"
                                ]
                            },
                            {
                                "key": "ft:isPublication",
                                "label": "ft:isPublication",
                                "values": [
                                    "true"
                                ]
                            },
                            {
                                "key": "ft:isBook",
                                "label": "ft:isBook",
                                "values": [
                                    "false"
                                ]
                            },
                            {
                                "key": "ft:isArticle",
                                "label": "ft:isArticle",
                                "values": [
                                    "false"
                                ]
                            },
                            {
                                "key": "ft:isUnstructured",
                                "label": "ft:isUnstructured",
                                "values": [
                                    "false"
                                ]
                            },
                            {
                                "key": "ft:isHtmlPackage",
                                "label": "ft:isHtmlPackage",
                                "values": [
                                    "true"
                                ]
                            },
                            {
                                "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:publishUploadId",
                                "label": "ft:publishUploadId",
                                "values": [
                                    "94b810f8-d67b-46d4-8865-8156619f9fae"
                                ]
                            },
                            {
                                "key": "ft:contentSize",
                                "label": "ft:contentSize",
                                "values": [
                                    "25662"
                                ]
                            },
                            {
                                "key": "ft:wordCount",
                                "label": "ft:wordCount",
                                "values": [
                                    "623"
                                ]
                            }
                        ],
                        "source": {
                            "id": "package",
                            "name": "package",
                            "type": "HtmlPackage",
                            "description": ""
                        },
                        "lastEditionDate": "2026-03-25",
                        "lastPublicationDate": "2026-03-25T13:21:30.978669",
                        "openMode": "FLUIDTOPICS"
                    }
                }
            ]
        }
    ],
    "announcements": [],
    "paging": {
        "currentPage": 1,
        "isLastPage": true,
        "totalResultsCount": 6,
        "totalClustersCount": 6
    }
}
Field Type Description
htmlPackage Object Contains information in relation with the HTML package.
packageId String The ID of the HTML package.
viewerUrl String The URL to the HTML package.
title String The HTML package title.
htmlTitle String The HTML package title written in HTML with kwicstring and kwicmatch CSS classes.
htmlExcerpt String The content excerpt as displayed in the Search results page, written in HTML with kwicstring and kwicmatch CSS classes.

This field remains empty for HTML packages as they do not have abstracts in the Search results page.
metadata Array Contains information in relation with the HTML package metadata.
key String The metadata facet's ID.
label String The metadata's name as displayed in Fluid Topics.
values String The HTML package's metadata values for a given metadata element.
source Object Contains information in relation with the source used to publish the HTML package in Fluid Topics.
id String The ID of the source.
name String The name of the source.
type String The type of the source.
description String The description of the source.
lastEditionDate String The date (YYYY-MM-DD) on which the HTML package was last modified.
openMode String Defines where the publication is opened. It has two possible values:
  • fluidtopics if the publication is to be opened by Fluid Topics
  • external if the publication is to be opened externally
originUrl String The origin URL of the publication.

The originUrl element is present only when the openMode object has the value external.