List a map's topics - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service returns a map's topics.

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

Response body

The following lines show an example of a JSON response body:

[
    {
        "title": "Before You Begin",
        "id": "~oeowUiu7yr7WDoIJT9kvQ",
        "contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/~oeowUiu7yr7WDoIJT9kvQ/content",
        "readerUrl": "#/r/Before-You-Begin",
        "breadcrumb": [
            "Before You Begin"
        ],
        "metadata": []
    },
    {
        "title": "Documentation Standards",
        "id": "rvkZEauYketsAe03qj7s2g",
        "contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/rvkZEauYketsAe03qj7s2g/content",
        "readerUrl": "#/r/Before-You-Begin/Documentation-Standards",
        "breadcrumb": [
            "Before You Begin",
            "Documentation Standards"
        ],
        "metadata": []
    },
    {
        "title": "Structure",
        "id": "6s1guREO3h62OTD5mEgJ5A",
        "contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/6s1guREO3h62OTD5mEgJ5A/content",
        "readerUrl": "#/r/Before-You-Begin/Documentation-Standards/Structure",
        "breadcrumb": [
            "Before You Begin",
            "Documentation Standards",
            "Structure"
        ],
        "metadata": []
    },
    {
        "title": "Typographical Conventions",
        "id": "vnaolvX5tYzcPHGbSZd01Q",
        "contentApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ/topics/vnaolvX5tYzcPHGbSZd01Q/content",
        "readerUrl": "#/r/Before-You-Begin/Documentation-Standards/Typographical-Conventions",
        "breadcrumb": [
            "Before You Begin",
            "Documentation Standards",
            "Typographical Conventions"
        ],
        "metadata": []
    }
]
Field Type Required? Description
title String Yes The topic's title.
id String Yes The topic's unique identifier.
contentApiEndpoint String Yes The path to follow to retrieve a topic's content.
readerUrl String Yes The URL fragment describing a Fluid Topics reader entry point to the corresponding topic. The map's pretty URL is used when available.
breadcrumb Array Yes A list of the titles of the topic's parents describing the location of the topic in the map's table of contents.
metadata Array Yes An array containing the topic's metadata.
    key String Yes The metadata's key.
    values Array Yes The value(s) defined for the metadata key. If any of the metadata's values are organized in hierarchical order, the hierarchical values field is present instead of the values field.
    label String Yes The label defined for the metadata.