Get a Map - Fluid Topics - 3.2 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.2
Category
Reference Guides
Language
English
Target Audience
public

This web service returns information about a given map.

Method

Endpoint

GET

/api/khub/maps/$MAP_ID

Where:

Output Example

{
"title": "AFS Integration Guide",
"lang": "en-US",
"id": "fbbhN_AWAcYrc0DjH5L1hQ",
"readerUrl": "#/reader/fbbhN_AWAcYrc0DjH5L1hQ/root",
"rightsApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/rights",
"topicsApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics",
"metadata": [
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guide"
]
},
{
"key": "Product",
"label": "Product",
"values": [
"AFS"
]
},
{
"key": "AFS_Version",
"label": "AFS_Version",
"values": [
"7.8"
]
}
]
}

Where:

  • "title" is the title of the map.
  • "lang" is the language of the map.
  • "id" is the id of the map.
  • "readerUrl" is the URL fragment to use as Fluid Topics reader entry point for the associated map.
  • "rightsApiEndpoint" is the path to follow to get access rights for a map.
  • "topicsApiEndpoint" is the path to follow to list all topics of a map.
  • "metadata" is all the key (facet) and value (facet value) metadata of the map.