Get a Map's Metadata - Fluid Topics - 3.6 - Technical Notes

Integrate Fluid Topics APIs

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English
audience
public

The Get a Map web service retrieves the metadata of a structured document:

/api/khub/maps/$MAP_ID

Where:

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

The output returns a list of all metadata keys and values associated with the map.

For example, calling /api/khub/maps returns the following JSON output containing data about 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 more information about the "Time Machine User Guide" map, it is possible to point directly to the map using its ID:

/api/khub/maps/LyJjWU3GD5rsUR76jUvd6Q

The web service returns endpoints to get the map's access rights or a list of the map's topics as follows:

{
"title": "Time Machine User Guide",
"lang": "en-US",
"id": "LyJjWU3GD5rsUR76jUvd6Q",
"readerUrl": "/r/Time-Machine-User-Guide",
"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"
]
},
...
]
}