List Topics within a Map - Fluid Topics - 3.4 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
FT_Version
3.4
Category
Reference Guides
language
English
audience
public

This web service returns all topics of a map and some details about the publication context.

Method

Endpoint

GET

/api/khub/maps/$MAP_ID/topics

Where:

  • $MAP_ID is the map identifier.

Output Example

[
{
"title": "Before You Begin",
"id": "~oeowUiu7yr7WDoIJT9kvQ",
"contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/~oeowUiu7yr7WDoIJT9kvQ/content",
"readerUrl": "#/reader/fbbhN_AWAcYrc0DjH5L1hQ/Ef_6Zt5bOttC8SVH5HhvMA",
"breadcrumb": [
"Before You Begin"
],
"metadata": []
},
{
"title": "Documentation Standards",
"id": "rvkZEauYketsAe03qj7s2g",
"contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/rvkZEauYketsAe03qj7s2g/content",
"readerUrl": "#/reader/fbbhN_AWAcYrc0DjH5L1hQ/aMnTkKR2etVySZuEmxx_yw",
"breadcrumb": [
"Before You Begin",
"Documentation Standards"
],
"metadata": []
},
{
"title": "Structure",
"id": "6s1guREO3h62OTD5mEgJ5A",
"contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/6s1guREO3h62OTD5mEgJ5A/content",
"readerUrl": "#/reader/fbbhN_AWAcYrc0DjH5L1hQ/drqMqlUbBfAUju9e4WAl1g",
"breadcrumb": [
"Before You Begin",
"Documentation Standards",
"Structure"
],
"metadata": []
},
{
"title": "Typographical Conventions",
"id": "vnaolvX5tYzcPHGbSZd01Q",
"contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/vnaolvX5tYzcPHGbSZd01Q/content",
"readerUrl": "#/reader/fbbhN_AWAcYrc0DjH5L1hQ/YRRjlH60pzTOHq4WvW7I3g",
"breadcrumb": [
"Before You Begin",
"Documentation Standards",
"Typographical Conventions"
],
"metadata": []
}
]

In this example, the list describes four topics. For each of them the following elements are provided:

  • "id": a unique content identifier.
  • "title": the title of the topic, as displayed in the table of contents.
  • "metadata": all of its metadata.
  • "breadcrumb": a list of all parent topic titles (this describes the location of a topic in the table of contents).
  • "readerUrl": the URL fragment describing a Fluid Topics reader entry point to the corresponding topic.
  • "contentApiEndpoint": the path to follow to retrieve a topic content.