Get a Map Metadata Information - Fluid Topics - 3.4

Integrate Fluid Topics API

Product
Fluid Topics
FT_Version
3.4
Category
Technical Notes

To retrieve all information related to a given map, use the Get a Map web service :

/api/khub/maps/$MAP_ID

/$MAP_ID is given when calling the /maps route.

The output returns a list of all metadata elements and values associated to the map.

As an example, the web service for listing maps /api/khub/maps returns the following JSON output corresponding to five maps:
[
  {
    "title": "Time Machine User Guide",
    "id": "LyJjWU3GD5rsUR76jUvd6Q",
    "mapApiEndpoint": "/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q",
    "metadata": [...]
  },
  {
    "title": "Time Machine Configuration Guide",
    "id": "__CDPSBAll3XheZ7g~XUuA",
    "mapApiEndpoint": "/api/khub/maps/__CDPSBAll3XheZ7g~XUuA",
    "metadata": [...]
  },
  {
    "title": "Time Machine Price List",
    "id": "~kTcgKAS9BL~wqwY1qA4~w",
    "mapApiEndpoint": "/api/khub/maps/~kTcgKAS9BL~wqwY1qA4~w",
    "metadata": [...]
  },
  {
    "title": "Time Machine v2.0 - Technical Datasheet",
    "id": "t0bR6QheECEcjS_0dmBBOQ",
    "mapApiEndpoint": "/api/khub/maps/t0bR6QheECEcjS_0dmBBOQ",
    "metadata": [...]
  },
  {
    "title": "Global Time Zone Cheatsheet",
    "id": "57zNEAWwJkv9hNNK5YxY7w",
    "mapApiEndpoint": "/api/khub/maps/57zNEAWwJkv9hNNK5YxY7w",
    "metadata": [...]
  }
]
To retrieve the "Time Machine User Guide" map exhaustive information, it is possible to point directly to the map using its ID:
/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q
This web service returns more information compared to the map listing. For example, the Get a Map Metadata Information web service returns endpoints to get the map access rights or the list of the map topics.
{
    "title": "Time Machine User Guide",
    "lang": "en-US",
    "id": "LyJjWU3GD5rsUR76jUvd6Q",
    "readerUrl": "/reader/LyJjWU3GD5rsUR76jUvd6Q/root",
    "rightsApiEndpoint": "/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q/rights",
    "topicsApiEndpoint": "/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q/topics",
    "attachmentsApiEndpoint": "/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q/attachments",
    "metadata": [
        {
            "key": "dita:mapPath",
            "label": "dita:mapPath",
            "values": [
                "_user_guide.ditamap"
            ]
        },
        ...
    ]
}
The following screenshot shows how the map information is displayed in Fluid Topics:
  • Some pieces of information are displayed next to the document when it is opened and being consulted.


    Metadata items can be displayed beside the document when it is opened

  • Other pieces of information are displayed as tags, below the publicationtitle in the list of search results.


    Metadata items can be displayed in the Search Results page