Map output - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

The following lines show an example for a query with the misspelled keyword dynamc. The response body returned 29 results among which there is a map.

{
  "spellcheck": {
    "suggestedQuery": "Dynamic",
    "htmlSuggestedQuery": "<span class=\"kwicmatch\">Dynamic</span>"
  },
  "facets": [
    {
      "key": "Category",
      "label": "Category",
      "hierarchical": false,
      "multiSelectionable": true,
      "rootNodes": [
        {
          "value": "Reference Guide",
          "label": "Reference Guide",
          "selected": false,
          "totalResultsCount": 9,
          "childNodes": [],
          "descendantSelected": false
        },
        ...
      ]
    }
  ],
  "results": [
    {
      "metadataVariableAxis": "FT_Version",
      "entries": [
        {
          "type": "MAP",
          "map": {
            "mapId": "UOKVI2OY1Xz2UP3W0yx7ig",
            "mapUrl": "https://my_site.fluidtopics.net/api/khub/maps/UOKVI2OY1Xz2UP3W0yx7ig",
            "readerUrl": "https://my_site.fluidtopics.net/r/my-content",
            "title": "Dynamic Suggestions",
            "htmlTitle": "<span class=\"kwicmatch\">Dynamic</span><span class=\"kwicstring\"> Suggestions</span>",
            "htmlExcerpt": "",
            "metadata": [
              {
                "key": "ft:lastUpdate",
                "label": "ft:lastUpdate",
                "values": [
                  "2020-01-16"
                ]
              },
              ...
            ],
            "editorialType": "BOOK",
            "source": {
              "id": "ait",
              "name": "Default Author-it",
              "type": "Authorit",
              "description": "Default Author-it source"
            },
            "lastEditionDate": "2020-01-16",
            "openMode": "FLUIDTOPICS"
          }
        }
      ]
    }
  ],
  ...
  "paging": {
    "currentPage": 1,
    "totalResultsCount": 20,
    "totalClustersCount": 20,
    "isLastPage": true
  }
}
Field Type Description
map Object Contains all information in relation with the map.
    mapId String The ID parameter of the map.
    mapUrl String The URL fragment to get the map metadata.
    readerUrl String The URL fragment describing a Fluid Topics reader entry point to the corresponding map. The pretty URL is used when available.
    title String The map title.
    htmlTitle String The map title written in HTML with kwicstring and kwicmatch CSS classes.
    htmlExcerpt String The Article excerpt as displayed in the Search Results page, written in HTML with kwicstring and kwicmatch CSS classes.

This field remains empty for Books as they do not have abstracts in the Search Results page.
    metadata Array Contains all information in relation with the map metadata.
        key String The metadata facet's ID.
        label String The metadata's name as displayed in Fluid Topics.
        values String The map's metadata values for a given metadata element.
    editorialType String The publication type. It has two possible values:
  • BOOK
  • ARTICLE
    source Object Contains all information in relation with the processing pipeline used to publish the map in Fluid Topics.
        id String The ID of the processing pipeline.
        name String The name of the processing pipeline.
        type String The type of the processing pipeline.
        description String The description of the processing pipeline.
    lastEditionDate String The date (YYYY-MM-DD) on which the map was last modified.
    openMode String Defines where the publication is opened. It has two possible values:
  • fluidtopics if the publication is to be opened by Fluid Topics
  • external if the publication is to be opened externally
    originUrl String The origin URL of the publication.

The originUrl element is present only when the openMode object has the value external.