Get a topic - Fluid Topics - Latest

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

This web service returns the description and metadata of a topic.

Method Endpoint
GET 
/api/khub/maps/{mapId}/topics/{contentId}
Path parameter Type Description
{mapId} String The map's unique identifier.
{contentId} String The topic's unique identifier.

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 lines show an example of a JSON response body:

{
  "title": "Typographical Conventions",
  "id": "vnaolvX5tYzcPHGbSZd01Q",
  "contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/vnaolvX5tYzcPHGbSZd01Q/content",
  "metadata": [
    {
      "key": "Category",
      "label": "Category",
      "values": [
        "Reference Guide"
      ]
    },
    {
      "key": "Product",
      "label": "Product",
      "values": [
        "AFS"
      ]
    },
    {
      "key": "AFS_Version",
      "label": "AFS_Version",
      "values": [
        "7.8"
      ]
    },
    {
      "key": "ft:locale",
      "label": "ft:locale",
      "values": [
        "en-US"
      ]
    },
    {
      "key": "ft:lastEdition",
      "label": "ft:lastEdition",
      "values": [
        "2022-12-17"
      ]
    },
    {
      "key": "ft:lastPublication",
      "label": "ft:lastPublication",
      "values": [
        "2022-05-26T16:32:38.342620"
      ]
    }
  ]
}
Field Type Description
title String The topic's title.
id String The topic's unique identifier.
contentApiEndpoint String The path to follow to retrieve a topic's content.
metadata Array An array containing the topic's metadata.
key String The metadata's key.
values Array The value(s) defined for the metadata key. If the metadata's values follow a hierarchical structure, the hierarchical values field is present instead of the values field.
label String The label defined for the metadata.